编写文档五轮模式

最近参与了某个政府领域的项目，也算是职业生涯第一个政府行业的吧。

和过往的项目相比，这个项目汇总多了很多文档性的工作，比如写下发通知、演讲的PPT、管理办法等等。

当然了，软件项目本身也包含必要的文档类交付物（概要设计、详细设计等）。

对于我个人来说，这么频繁的、写不同类型的文档还属生涯首次。

 

这几天在看《人人都是产品经理》一书时，作者分享了他的写作五轮模式，看了之后深有同感，

下面来罗列一下这个“写作五轮模式”，并希望它有“文档恐惧症”的同学有所帮助。

----------------------

第一轮：搭建框架

设计章节目录框架，并在每个目录标题下至少写两三句说明这一段的主要内容和核心观点，并保证章节的整体思路通畅。

第二轮：填充文字

尽量不考虑文字细节，先把想说的都说出来，把能想到的都留下来，保证码字的速度。

第三轮：理顺逻辑

按顺序通读文章，重点关注段落、句子间的逻辑的顺畅。这一轮的主要工作是调整段落、句子的位置；增加过渡句；删除废话等。

第四轮：调整风格

关于语言的“味道”一致。增加例子、对话、图表等。例子觉得不好时，先占个位子等有灵感之后在修改。

第五轮：后期制作

完成四轮以后，才是初稿。然后可以给其他人看看，听听意见，或发给前辈评审。进行从框架到细节的各种改造。

----------------------

 

在实际IT项目中，写文档还需要明确具体的目标，也就是写这个文件的主要目的是什么、给谁看的等。

需要在编写之前，从各方面收集多种多样的信息，比如其他人怎么写的，哪些信息必须写等，然后才能开始编写。

总结来说，可以按照下面的思路来指导项目中的文档编写工作。

 

如管理是工具、软件是工具一样，文档同样只是工具（不是目的）。写文档是软件行业中的必备技能。

软件开发的各个阶段也需要配备各种管理文档或文档类交付物，写一手好的文档，可以让你在IT这个行业中更游刃有余。

就算写不好，学会一些方法，也不会再惧怕文档了。