正文
为了便于说明,我准备了两个示例文档:一篇思路笔记,和一篇完整的产品文档示例——这样可以完整介绍产品文档的撰写流程。
请在继续阅读文章之前,花几分钟读一下这两篇示例文档吧。
(1)阅读示例思路笔记
(阅读时间 2 分钟)
这是一个根据你已知的信息和想要解答的问题所梳理成的列表。
这会是你需要做的第一件事情,大约需要一个小时来完成这个文档。这个文档会成为你和团队中其他人的一个沟通基础。
(2)阅读示例文档
(阅读时间 6 分钟)
只有和团队一起评审了你的假设和创意之后
(无论是在专门召集的会议上,喝咖啡时,或者桌上足球的休息时间)
,你才应该真正开始写产品文档。
如果已经完成了沟通和评审,整个文档应该花费你 1-3 个小时的时间。
啊哈!有了文档之后是不是就感觉踏实多了?写文档看起来是额外的工作成本,但是其实并不是,高效的文档可以帮助你和你的团队节约时间投入,并且在交付上线时会更有信心。
等等!——你已经读完示例文档了么?请务必先读完它再继续阅读下面的文章。
Ben Horowitz
文档撰写指南
我通过示例文档诠释了这篇文章中所讲述的思考,在继续阅读全文之前,请务必确认你已经阅读了示例文档 。
为什么要写产品文档?
为了以更高的质量、更快的速度和更佳的预判来交付正确的产品。
是的,就是这样。那么,产品文档将如何帮助你做到这一切呢?Ben Horowitz 分享了上图中这个看法,我的示例文档也是一个很好的例证。明确一下要点:
从一开始就理性思考:
在团队开始付出更高成本去设计软件架构、实施代码开发、完善界面设计、测试软件质量之前,写文档可以迫使你提前思考每一个细节。这将会提高你决策的质量,降低意外事件发生的概率。
高效沟通:
你常常需要和不同的利益相关方
(支持团队,工程团队,设计团队,财务团队,管理层等等)
沟通你的方案。产品文档可以帮助你事半功倍地完成沟通,避免口头沟通中产生的歧义,团队中的所有人可以更好地理解你的意图,并且更有的放矢地做出答复。