产品文档规范

《产品文档规范》由会员上传分享，免费在线阅读，更多相关内容在应用文档-天天文库。

1、XXX产品需求文档（模板说明）说明：本文档为产品需求文档的模板说明，编写产品需求文档时，需要按照模板说明的要求来进行。 说明的部分，文档中用‘红色文字及示例’表述。 路径：设置好文档管理的路径，文档管理更有条理，也便于文档使用人员轻易找到需要的文档。1、文档需要按照如下方式设置保存路径： 系统-模块-子模块-文档    如：财务平台-凭证管理-凭证审核-凭证审核产品需求文档如果路径中没有对应的模块或子模块，需要先创建空间，然后再在对应路径下编写文档。2、需求文档标题，按照系统功能模块名称填写   如：凭

2、证审核产品需求文档3、文档编写每次需要将本次修改的内容用黄色底纹标记，待上线后去掉黄色底纹。开发及测试人员以黄色底纹标记的范围为准判断本次需要上线的内容。建议文档都按照表格形式编写，这样格式容易固定。·一、版本修订记录·二、用户需求·三、产品范围·四、名词解释·五、主流程图·六、功能清单·七、非功能需求根据文档的核心标题，生成目录，便于链接浏览一、版本修订记录版本号时间修订模块修订内容修订人     版本修订记录：记录每次修订文档的相关信息，留存变更历史记录。1、按修订时间倒序填写，修订时间为修改的日期

3、。2、版本号从V1.0开始，每次增加0.1个版本，按十进制递增。3、修订模板最好能填写本次修订涉及的最细的子模板，如无法判断，也要填写到模块层级。如：版本号时间修订模块修订内容修订人V1.12018.2.1凭证管理-凭证审核凭证审核增加凭证调整功能，对于审核前有误的凭证可以人工调整周V1.02018.1.31凭证管理-凭证审核凭证管理新建凭证审核模块，对财务平台生成的凭证需要人工审核周二、用户需求    1.需求描述版本号提出时间确认时间需求描述提出人     用户需求：简括列示需求用户提出的原始需求，

4、需求是产品的来源。1、需求描述建议与修订记录的版本号对应，每个版本修订的内容记录下原始需求描述，即用户的业务需求。2、提出时间和确认时间可能需求很早就提了，但是一直没做，按需求列表上的记录。如：版本号提出时间确认时间需求描述提出人V1.12018.2.12018.2.1凭证审核时发现有的凭证生成的不正确，现在线下无法修改，只能事后线下调整，需要提供在凭证审核前发现问题可以直接在线调整凭证俞V1.02018.1.312018.1.31现在都是人手工线下审核凭证，工作量大，效率低，还易出错，需要财务平台提供

5、凭证审核功能，可以线上审核凭证俞     2. 原始记录版本号原始记录  原始记录：需求从提出到实现，经历不同人不同时段，原始记录留底，便于核对需求与功能一致性。1、可将对应需求提出时的附件、聊天记录、链接、图片、文字等原始记录上传在文档中。2、按照修订版本对应上传。如：版本号原始记录V1.1V1.0三、产品范围1.功能点版本号版本功能序号功能    功能点：用户提出了自己的用户需求，产品人员需要从产品的角度转化为产品(功能)需求。1、按照版本号填写，将本版本对应用户需求，按系统功能列示，需要列示到细化

6、的小功能点上。如：版本号版本功能序号功能V1.11凭证调整V1.02凭证审核单据跟踪V1.01凭证审核   2.评审记录版本号版本评审次数评审时间评审人员评审意见     评审记录：记录每一版对应的评审情况，留底用。1、按照版本号填写，将本版本对应的评审情况列示在表格上，需要列示评审的意见和产品的答复，如一个版本有多次评审，每次评审都要记录。 如：版本号版本评审次数评审时间评审人员及意见V1.1该版本第一次评审2018.2.1开发：徐李认为文档满足开发需求。测试：张认为文档满足测试需求。用户：俞认为文档

7、满足用户需求。其他：周无意见。V1.0该版本第二次评审2018.1.31开发：徐李认为文档满足开发需求。测试：张认为文档满足测试需求。用户：俞认为文档满足用户需求。其他：周无意见。V1.0该版本第一次评审2018.1.30开发：徐李认为流程图不够详细，需要补充，产品同意补充；认为审核查单单据详情多余，需要去掉，产品不同意去掉。测试：张无意见。用户：俞认为审核列表需要增加导出功能。产品同意补充。其他：周无意见。 四、名词解释名词释义举例   名词解释：产品文档中经常会有一些业务或技术专业名词，非行业人员可

8、能比较难以理解，需要对这些名词进行解释，便于更好熟悉业务，理解文档。1、文档编写人员需要判断哪些名词需要列示，一般行业专有名词需要列示。2、有时多个产品文档都会有某个名词，名词需要统一释义，建议都以最早编写的文档的名词释义为准，避免不同地方不同解释。 如：名词释义举例原始凭证原始凭证又称单据，是在经济业务发生或完成时取得或填制的，用以记录或证明经济业务的发生或完成情况的文字凭据。它不仅能用来记录经济业务发生或完成情况，还可以明确经济责任，是