对于企业来说,如何推广自己的产品是一个非常重要的话题,而其中必要的就是创建企业产品宣传册,这对于产品宣传非常重要,尤其是一些大公司,非常重视这种产品展示方式。因为它可以更完整地展现产品,撰写一份合理有效的产品文档,让客户了解产品,客户甚至也可以了解企业的工作风格。一、为什么要写产品文档?为了以更高的质量、更快的速度和更佳的预判来交付正确的产品。产品文档如何帮助你高效地做到这一切呢?1.从一开始就理性思考在团队开始付出更高成本去设计软件架构、实施代码开发、完善界面设计、测试软件质量之前,写文档可以迫使你提前思考每一个细节。这将会提高你决策的质量,降低意外事件发生的概率。2.高效沟通你常常需要和不同的利益相关方(支持团队,工程团队,设计团队,财务团队,管理层等等)沟通你的方案。产品文档可以帮助你事半功倍地完成沟通,避免口头沟通中产生的歧义,团队中的所有人可以更好地理解你的意图,并且更有的放矢地做出答复。3.明确权责明确项目目标的评价标准,公开承诺奖惩激励机制:利益相关方可以知晓如果最后一刻变更需求会意味着什么,工程师们也会在预估工期时再三斟酌。二、产品文档中包含哪些内容?产品文档应该明确沟通要做一个「什么」产品,以及「为什么」要这么做。用来说明清楚一个产品的表达方式很多,但最核心的,一定要说清楚这五件事情:
问题描绘你此次打算解决的问题。更重要的是,解释为什么要去解决这个问题。描述要尽可能地具体,并且提供相关的数据指标。
可衡量的目标明确承诺交付和成果,明确哪些事情超出了此项目的范畴。每一个目标,都应该可以明确衡量「是否达到目标」。
需求背景提供你的观众理解当前问题以及接受你的提议所需的所有背景信息。包括但不限于假设、用例、数据指标等信息。
解决方案详情你的提议应该有充足的细节,易于团队成员消化理解及执行——可以把这部分内容想象成对人脑进行编程和执行。
时间轴列出你的团队共同认可的截止日期和其他重要时间点。这部分内容开始的时候可能会比较模糊,但是在最后一次文档评审之前应当完全敲定。
对于产品文档的内容涵盖来说,以上五点是必不可少的。三、好的产品文档定义:只要能够顺畅推动项目前进,在产品开发和测试过程中能够大幅度减少工程师和产品经理反复沟通的文档,就是优秀的产品文档。1.产品逻辑要清晰且流畅产品文档的内容要前后一致,逻辑通畅,这也是最基本的,要秉承先整体后局部的原则,先要从全局去定义整体的产品逻辑,再去逐步分解细节。2.避免产品功能的疏漏比如会不会对其他模块产生影响?异常流程的描述,边界情况等。3.文档的可读性要强能用图描述的一定嫌麻烦用文字,多用流程图、用例图、时序图等去描述你的产品,在涉及到很细节的交互时,最好将相关功能做出高保真原型图供研发人员参考。四、如何写出高效产品文档1.尽量简短没有比这更重要的文档写作建议了。简洁意味着清晰的思路和沟通,也意味着你的文档更加易于阅读和理解——这一点至关重要。2.使用平白的语言和简单的格式使用简短而不是花哨的语句,使用列表和加粗强调可以使文章更一目了然,以放松有趣的方式写作而不是一板一眼,如果你有得体的幽默感就再好不过了。3.为开发团队预留时间通过评审并且达成一致通过的文档才是完善的文档。如果你希望在未来的某一个迭代Sprint中开发此项目,就应该提前两到三周开始这个产品文档写作流程。4.像工程师一样思考在项目得以进入开发之时,常常会发现大量未预料到的边缘情况——但这种情形其实可以避免。如果你认真考虑过项目进入开发的所有必要条件,你就可以提前发现这些问题(例如,是否在移动设备中可以使用在线聊天功能?)。5.确保每一个人都跟上了你的节奏当我组织产品评审时,会议室里的大部分人都已经大致了解我要讲的内容——因为我已经提前在讨论会和日常聊天中沟通过这个事情了。既然大家都已经清楚了「做什么」和「为什么要做」的问题,文档评审会上我们只要