产品经理|高效产品文档撰写指南

Baklib
+ 关注
2022-09-29 17:42
225次阅读
对于企业而言,如何推销自己的产品,是一个很重要的问题,而建立一个公司的产品小册子是必不可少的,这对品牌的宣传很有帮助,尤其是那些大公司,更是如此。因为它能更全面地展示产品,能写出一个合理而高效的产品文件,让顾客对产品有更多的认识,顾客也能理解公司的工作方式。
提供高质量,快速,预判性好的产品。

产品文件是怎样帮助您有效率地完成这些工作的?

1.一开始就进行合理的思想

在开发团队花更多的钱来设计工具架构,执行代码开发,完善界面设计,测试工具质量之前,编写文档会让你对每个细节都有更多的想法。这样可以提升你的决定品质,减少不希望发生的事情。

2.有效的交流

你经常要与各种利益有关者进行交流(支持、工程、设计、金融、管理等)。产品文件能让你在交流过程中事半功倍,避免在口头交流中出现模棱两可的情况,而且整个团队成员都能更好的了解你的意图,更有针对性地作出回应。

3.权力和义务的划分

明确项目目标评估的标准,并向社会公布奖励和惩罚,各利益攸关方都知道在最后关头更改要求意味着什么,工程师也会仔细考虑。
产品经理|高效产品文档撰写指南
 
产品文件应当清楚地传达出要制作“什么”的产品和“为什么”。有很多种方法可以用来解释一个产品,重要的是,要把这五个方面都说清楚:
  • 问题。请说明常见问题,并说明为何要处理此问题。说明应尽量详细,并提供有关的资料。
  • 可测量的目标清楚地表明了对实现和结果的承诺,并清楚地表明了什么是超越了该计划范围之外的。每个目标都要能清楚地测量“是否达成”。
  • 需求情境能让听众了解目前的问题,并能接受你的建议。包含假设,用例,数据指标等,但不限于此。
  • 解决方案细节您的建议应包含足够详细的细节,便于小组成员容易理解和实施。
  • 时间轴,列出你的小组一致同意的Dead line和其它关键时刻。这一节的开头也许不太清楚,但应该在文件审查前完成。
上述五个要点对产品文件的内容覆盖至关重要。
只要项目顺利推进,工程师和产品经理之间的交流就会大大降低,这就是一个好的产品文档。

1.产品的逻辑性和条理性

产品文档必须要有条理,要有条理,要有一个完整的体系,要有一个完整的体系,然后才能有一个完整的体系。

2.避免在产品功能方面出现遗漏

比如说,会不会影响到其它的模块?异常流的说明,边界条件等。

3.文件易于阅读

能用图来形容的肯定会觉得太麻烦了,用流程图、例图、时序图等来描述你的产品,如果是非常详细的互动,给开发人员提供一个高逼真的模型。
产品经理|高效产品文档撰写指南
 

1.尽可能短

在文档撰写方面,没有什么更重要的建议。简明的意思是清楚的思想和交流,同时也表示你的文件更容易读懂-这是非常关键的。

2.采用普通的语言和简洁的形式

用短而非华丽的句子,用清单和突出的重点来让你的文章更加清晰,让你的文章看起来轻松愉快,不要一成不变。

3.将时间留给开发小组

只有经过审核和同意的文件才算是完整的文件。如果您想要在以后的某个迭代式 Sprint中开发这个项目,那么您应该在2-3个星期之前就开始编写该产品的文件。

4.以工程师的思维方式

当一个项目开始发展的时候,经常会遇到很多意想不到的问题,但事实上,这是可以避免的。如果您仔细地思考了项目的全部需要,那么您就可以预先了解到这些问题(比如,您的手机上有没有互联网聊天?)。

5.保证每个人都能跟上你的步伐

在我安排产品审核的时候,大多数人都对我要说的话有了一个大概的概念,因为我在研讨会上和每天的闲聊中都谈到了这件事。既然大家都明白了“要做什么”和“为什么要做”这个问题,那么在文件评审中,我们只需要把重点放在执行的细节上。

6.处理图表

流程图、线框图等可以用简单易懂的方法来提供大量的信息,但是在绘制图表的过程中会花费大量的时间。

7.花费0.5-3天的时间来考虑和撰写文件

具体的时间取决于项目的规模。你在编写文件上花的时间越多,你得到的好处也就越少。尤其要注意的是,没有人可以阅读5到6页以上的文件。

8.明确目标和明确远景

你不仅要给一个功能下定义,还要说明“我们为什么要这么做”和“我们要达到什么目的”,要在文件里说明该计划对更高层次的计划有何影响,还有后续的发展。

9.确定读者已经看过文件

如果你的文件很难看,很长,或者从不与别人共享,那么你最好不要把它写出来。一定要保证你的文件已经被相应的人看过,我在前面提到的,在审核的时候要有足够的时间来读这些文件,这是一个很好的参考。

10.获得真实的回馈

你的文件是要追踪众所周知的东西吗?还是缺少详细的文件?在随后的执行过程中,有没有出现过多的边界情形?还是说,你花了很多时间来做规划和审核文件?你必须在任何时候都与你的团队进行交流。
上面的十个小贴士可以帮助你编写有效的、实际的产品文件,如果你有基本的写作技巧。
产品经理|高效产品文档撰写指南
 
市面上有很多文档编写工具,但是 Baklib是一个很受欢迎的工具。
Baklib是一个在线的文字编辑与主机,它可以为企业用户提供 FAQ帮助文档,也可以编写知识库,产品文档,帮助中心,发行说明。
为热爱写作的读者,可以写日志、写日志、写自己的日志,功能非常棒!独立的域名、多个模板,可将创意内容按照模板引导成不同的美观界面,让内容共享更加便捷,更利于建立个性化的品牌口碑。
  • 容易编辑,有条理
  • 丰富的主题模板,清晰的显示界面,多终端的适应性
  • 全文本检索
  • 可以绑定独立的域名,打造一个专门的公司站点,支持 SEO。
  • 不需要下载,可以在后台编辑和存储,可以直接实时显示,维护费用低廉
  • 还可以用作团队知识库,在线产品说明书等。
现在的企业,文档的编写非常的重要,而不是过去那种没用,浪费时间的东西。希望上面的内容能对你有所帮助。

[免责声明]

原文标题: 产品经理|高效产品文档撰写指南

本文由作者原创发布于36氪企服点评;未经许可,禁止转载。

资深作者Baklib
Baklib
0
成都律数信息技术有限公司
实力厂商
实力厂商
优质服务
优质服务
及时响应
及时响应
立即询价
相关文章
最新文章
查看更多
关注 36氪企服点评 公众号
打开微信扫一扫
为您推送企服点评最新内容
消息通知
咨询入驻
商务合作