什么样的开发文档可称之为「完美」?

什么样的开发文档可称之为「完美」?

　　首先为大家铺垫一些定义，一般情况下，我们所说的「开发文档」指的是「产品开发文档」，而作为一名创业者，你还应该准备好其他的文档内容。

　　产品需求文档(PRD)

　　产品由“需求”阶段到“开发“阶段的最主要的文档，产品需求文档将对设计部门、研发部门乃至测试部门的工作起到指导、量化的作用，因此文档的质量至关重要。

　　市场需求文档(MRD)

　　产品由“需求”阶段到“开发“阶段的第一份文档，是对产品在市场层面的说明，多描述核心用户、购买者、客户的真实需求，也是公司在战略意图上的实现。市场需求文档不仅要体现出产品的「高度」，还要为产品开发、运营推广指出明确的方向。

　　商业需求文档(BRD)

　　这份文档是产品在开发之前，企业高层作决策评估的重要依据。其内容涉及市场分析及规划，营销策略及投入，盈利预测等，通常是演示文档的形式，短小精炼，没有产品细节，比较像一份商业计划书。

　　了解好全部的定义后，我们来讨论如何制作一份「完美」的产品需求文档(PRD)。

　　什么是「完美」的产品需求文档?

　　从阅读者的角度出发，「完美」代表着文档格式规范、文字严谨、可读性高。

　　这三点看起来很容易就做到，但实际上，这需要对细节有着最强烈的追求。

　　格式规范

　　所有文档均使用统一排版，页眉、字体、字号、颜色，表格规范，图片大小一致

　　善用加粗、斜体及项目符号等格式，使得文档更具有逻辑性，更清晰，重点内容更突出

　　禁用大段文字，更多的使用表格、流程图等，建议大家学习和使用UML的相关知识，用例图、类图、序列图、活动图、状态图等，可以清楚详细的描绘出任何一种事物和各种逻辑关系。

　　文字严谨

　　ž文档名称需要高度概括且精确的命名，使项目同事迅速了解文档的内容

　　ž每一个重要的名词必须附带定义，以便使所有同事都能明白其内容，有时做错比没做还要更麻烦

　　文档中出现的专业术语需要撰写文档的人先理解含义，否则别写在文档中。开发文档最终的目的是指导开发工作，并不一定必须使用最专业的术语，把产品逻辑讲清楚即可

　　可读性高

　　ž重要性和优先级需要着重考虑，整体文档内容如何布局，有些内容优先需排在前列，有些内容不需要写进文档之中，这要求的是撰写人站在阅读人的角度和立场考虑问题

　　ž产品开发文档需做到全面性，这包含两方面。一方面，我们需要将每一条需求的所有可能性展现出来;一方面，文档的阅读者可能包含设计、研发、测试等众多部门，需要考虑到他们不同的关注点

　　ž整体文档富有逻辑，层层深入，环环紧扣，使用数据或案例来辅助你所表达的内容

　　总结一下，制作产品需求文档最核心的理念是：这不是做给谁看的工作，这是将指导团队所有人工作的工作。抱有着这样的想法，就可以理解“需求文档是为了团队服务的”这个观点，就可以做到以上那些细节之处，就可以离「完美」更进一步。

　　APICloud提供免费一对一需求梳理的服务

　　由专业监理制作详细、完善的「开发文档」

        www.apicloud.com