禽兽，放过那些程序猿，写文档的事让我们来

[jesse6679]

在码农圈，有个笑话是这样说

我们程序猿最烦两件事，
第一件事，写代码的时候还要写文档，太他妈麻烦！
第二件呢，是接手别人的程序，他娘的居然没有文档！

为什么要写文档

一个流程正规的软件项目，伴随着项目生命周期的行进，项目团队需要撰写大量的配套文档，例如：可行性研究报告，需求文档、测试报告、产品说明书、周报月报，乃至流程图、汇报演示PPT等等。即便是相对高效的创业团队，也有数据库结构、API接口等不少技术文档要写。

在软件工程中，文档的重要性不言而喻。
文档是项目成果的体现。项目的完成度，里程碑节点等等一般都通过文档汇报给老板和客户。俗话说会哭的孩子有奶吃，同样道理，懂汇报的员工更容易受老板的赏识（工资更高）。
文档能促进沟通。项目成员之间，团队与客户之间，常常通过邮件往来进行交流与协作，一份紧扣主题、言简意赅的文档往往能起到很好的沟通效果，避免因沟通不到位产生误会。
文档是人员更迭时最重要的交接物。老员工离职，新员工接手，文档是最重要的知识传承。很多遗留老系统之所以没法继续维护，往往就是因为没文档。

可是，理想很丰满，现实却很骨感。
国内大量软件项目的实践经验是，文档根本没人愿意写！！！

为啥讨厌写文档

说起写文档，恐怕每个码农都是一肚子苦水。平常我连代码注释都懒得写，你让我写文档？

按理说，很多文档应该是由项目经理来写的。但是项目经理是中层干部，主要任务是沟通协调，动动嘴皮子，很多和客户沟通的大事都忙不完，写文档这种小事，还是派给下面程序员随便糊一稿交差了事算啦。最后皮球踢到码农这里，而码农的语文和写作水平，呵呵，你懂的……语句能通迅就不错了，谈什么紧扣主题、条理清晰、排版美观～

归结下来，讨厌写文档的原因无非是下面几个：
1. 不理解。觉得写文档是形式主义，做表面文章、无用功。程序员虽然屌丝，但内心还是有一点小清高的，写代码多么牛B，写文档这么low的事情，一点成就感都木有啊。
2. 没空写。不管项目经理还是码农，都是劳碌命，正经活计都干不完，还得加班，哪有空写文档。
3. 没好处。密密麻麻码上好几页纸，老板会赞扬么，会发奖金么，能升职吗。
4. 不会写。码农本来就不善言辞，面对女神，说句话都磕吧，你还让他提笔写作？写程序的时候思维是跳跃的，而说话和写作的思维是线性的，你让程序员写一篇条理清晰的文章，臣妾做不到啊！
纵观国内的软件企业，包括很多大中型软件企业，他们的项目技术文档几乎都是没法看的。废话连篇，抓不住重点；语句不通顺，错别字连篇；排版不工整、格式不正确。

这就是“痛点”，也是我们的机会。既然大家都不愿意干，那就干脆花点小钱，请专业的人来干好了。

Technical Writer

反观国外的IT企业和互联网公司，一般都会设置专门的Technical Writer岗位，专职写各类技术文档，甚至将文档写作任务外包出去。比如说，微软著名的msdn，实际上是外包给专业技术写作团队来进行撰写的，微软自身只负责提要求，给资料和验收成果，最终结果是双赢的，微软甩掉了一个大包袱，外包写作团队赚到了钱。写作团队因为常年负责技术文档的写作，有了经验的积累，所以服务更加优质。

我的创业想法就是建设一个众包（外包）社区，专门从事IT领域技术文档的写作。大致形式可以参考一下“猪八戒网”，当然业务流程、管理模式等等一定是我们自己创新的。

我们的玩法

区别于普通威客网站的“大而全”，我们只做文档写作，而且聚焦在IT互联网领域。

目前，IT领域的技术文档，我们大致上可以分为三类：
1. 项目管理类。例如需求文档、测试报告、产品说明书、周报月报等。这类文档对写手的要求较高，需要同时精通项目管理理论和客户业务领域的知识。
2. 技术资料类。例如数据库结构、API接口文档等。这类文档主要内容还是靠程序员自己写，我们只能协助进行整理、排版、美化。
3. 汇报演示类。例如项目成果演示。需要条理清晰、排版整洁、美观大方，同时需要在较短时间内完成。
还有就是老项目的历史遗留文档，我们可以协助进行资料分类、整理、更新等。
总之，有很多事情可以做。

主要流程如下：

申请成为文档写手－－－－》审核通过

发布文档写作需求－－－－》双向选择－－－－》撰写文档－－－－》付费－－－－》相互评价

另外，在游戏规则设定方面，我希望避免恶性竞争，相互压价，给写手留下足够的利润空间，以保证服务的优质，我们走精品路线（服务质量一直是威客网站的死穴）。

在流程和游戏规则制定方面，我已经有所考虑，但总感觉不够完善，欢迎大家自由讨论。
实施计划是先做一个最小可用模型（MVP），把小规模的业务先运转起来，验证了创业想法之后，再在实践中不断迭代开发。

求合作，求连接

招募以下人员：
1. 文档写手1名。有丰富的软件项目技术文档写作经验，熟练使用office系统软件，能绘制流程图和原型图，有pmp或项目管理师证书者优先。兼职，地点不限。刚刚起步阶段仅需1人，以后随着业务的增长会逐渐放开加入门槛。
2. 技术合伙人1名。
（1）全栈工程师，精通Ruby、Node.js、Python语言中的任意一种，精通web应用开发。作为三名创始人之一，你得独立搞定所以开发上的技术难题，不多说，任重道远啊。
（2）坐标江浙沪地区，优先考虑南京的（我在南京，考虑以后沟通方便）。可以兼职。
3. 种子用户。感受到了文档写作的痛点，希望获得优质的文档服务，并且愿意为之付款的用户。人数不限。

关于我

80后屌丝一枚，人在南京，熟悉Ruby on Rails。
现在主要担任项目经理的职务，项目管理和流程把控是我的强项。
目前在兼职状态下创业。
欢迎和我连接，电子邮件： [email protected]

[wbsdty331]

这个应该移动到工作节点吧

[Strikeactor]

代想变量名多少钱

[hellov22ex]

有没有命名词典出售？

[vietor]

文档是机密商业信息

[ychongsaytc]

命名强迫癌是否有根治的可能？

[xwing]

同在南京的支持一下，顺便关注一下命名强迫癌问题 ~~~

[jesse6679]

哈哈，原来大家都有命名强迫癌的问题啊，你们不说我还以为只有我自己有这种小众需求呢。
让我想想，也许基于爬虫、大数据和搜索可以做出一个解决方案来。
不过我们最后另辟帖子讨论这个问题，楼已经歪了，再讨论下去，楼就要倒了。

[waiichou]

前面看起来不错，然后看到「office系统软件」我就准备撤了。

[jesse6679]

不要断章取义啦，熟练使用office是多技术文档写作人员的一个最低基本要求。
一个好的的技术文档写作人员需要具备开发经验、项目管理管理经验，还要尽可能了解客户的业务知识，绝逼不是找两个临时工就能搞定的。
这不是刚刚起步嘛，希望从无到有拉起一直队伍来。
一下子把要求提的太高，担心曲高和寡，没人陪我玩呀。

[ssaul]

这个想法非常好，我希望可以和楼主聊聊你主意的具体细节。

[luzjoy]

难点在于沟通，怎么让写文档的人明白 这个项目的需求 或者一些核心的东西，还有一个大问题是 企业是否放心让别人来写

[sobigfish]

写好注释的话不是API的部分就已经出来了么，其他的还多么？