产品文档

产品文档

1. 明确受众、目的和形式

好的产品文档应该有非常强的针对性。

第一步，明确文章的目标受众是谁。

他们的思考维度，才能知道用什么样的语言、逻辑和形式。

第二步，需要清楚每个文档的目的，而不是把写文档本身当做目的。

去设想一个文档的读者在读之前的状态和读完之后的状态，你希望他能获得什么信息，做出什么决定，以及有些什么后续的动作。

弄清楚受众和目的之后，你就可以判断用什么形式来呈现文档，是静态的产品原型，动态的Demo，一张流程图，幻灯片还是一篇PDF或一封邮件，大概是什么长度等等。

幻灯片也分阅读型和演讲型的，阅读型要把逻辑写下来，演讲型则写提纲或放图，通常要准备两份，因为很多时候是既要做演讲，也有时候是发邮件的。

2. 知其所以然，然后知其然

项目背景中要交代为什么要做这个功能。认真写项目背景。

3. 打造良好的阅读体验-金字塔原理、逻辑及格式

金字塔原理：

1. 一个论点出发（通常是文档的目的）。
2. 找到支持它的3到5个方面，每个方面再向下拆分，形成一个逻辑上的金字塔。
3. 每一层的拆分都要尽可能保证观点是相互独立，同时又完全覆盖的。

写文档就是一个不断拆分，再向上合并的过程。

4. 先写厚，再写薄

写文档通常不是一蹴而就的，写的过程也是整理思路，查漏补缺的过程。

所以一开始的时候可以尽量多写一点，然后不断重读，不断裁剪、重构、修改和调整。

另外是写的过程中可能没注意遣词造句，会写得比较啰嗦，或存在二义性。

在堆和理之间，可以尝试引入一个“冷静期”，在写完文档后不着急定稿和评审，面是搁置在那里，放一晚上，睡一觉或者忙一点别的事情之后，等思路开始从深陷其中抽离出来了，再把文档翻出来重读和修改。

另一个更简单的办法是把写出的文档给熟悉的自己人先读读看，获取一些从读者角度来反馈。

总结

正如同我们做产品的套路一样，我们从用户、场景出发，通过挖掘文档读者的需求和背景来撰写文档。强调了文档逻辑结构的完整和条理，最后又一次建议你不要急于求成，写好的东西放下来冷静发酵一下，进行一个二次加工。