产品文档规范

XXX产品要求文档(模板说明)说明：此文档是产品要求文档的模板说明，创建产品要求文档时必须按照模板说明执行。说明的一部分，在文档中标记为“红色文字和示例”。路径：设置文档管理的路径，更系统地管理文档管理，并使文档使用人员能够轻松找到所需的文档。1、文档必须将存储路径设置为：系统-模块-子模块-文档示例：财务平台-凭据管理-凭据审核-凭据审核产品要求文档如果路径中没有相应的模块或子模块，则必须在该路径下创建文档之前创建空间。2、要求文档标题，使用系统功能模块名称填写示例：凭据审核产品要求文档3、合成文档每次将此修改显示为黄色阴影，联机时删除黄色阴影。开发和测试人员根据黄色阴影显示范围判断这次应该在线的项目。最好以表格格式创建文档，以便轻松固定格式。一、修订记录二、用户要求三、产品范围四、名词说明五、主要流程图六、功能列表七、非功能要求根据文档的核心标题生成目录，以便于导航链接一、修订记录版本号时间修改模块修改内容修改者修订记录(revision history):记录有关每个修订文档的信息，以保留变更记录。1、根据修订时间反向填充，修订时间为修改日期。2，版本号从V1.0开始，每次以0.1为增量递增到十进制数。3.修订版本范本最适合建立与此修订版本相关的最细微子范本(例如无法判断)，也应填写在模组层级。例如：版本号时间修改模块修改内容修改者V1.12018.2.1证书管理-审计证书凭据审核中添加了凭据调整功能，允许您在审核之前手动调整无效凭据州V1.02018.1.31证书管理-审计证书凭据管理需要手动审核财务平台上生成的凭据的新凭据审核模块州二、用户要求1.需求说明版本号腾出时间确认时间需求说明提出人使用者需求：需求简要列出使用者提出的原始需求，需求是产品的来源。1、需求说明建议对应于修订记录的版本号，每个修订的说明记录了原始需求说明，这是用户的业务需求。2、建议时间和确认时间要求可以提前很久提出，但没有按照要求列表中的记录执行。例如：版本号腾出时间确认时间需求说明提出人V1.12018.2.12018.2.1审核凭据时，发现某些凭据生成错误，现在不能脱机更正，只能调整到后续行，并且必须在审核凭据之前发现问题，提供在线直接调整凭据的能力刘V1.02018.1.312018.1.31现在，您需要一个能够手动审核证书、工作量大、效率低下且容易出错的金融平台，以便在线审核证书刘2.原始记录版本号原始记录原始记录：需求从建议到实现，经过其他人的时段，仍保留原始记录。轻松查看需求和功能一致性。1、提出该要求时的附件、聊天记录、链接、图片、文本等原始记录可以上传到文档中。2，根据修订版上传。例如：版本号原始记录V1.1V1.0三、产品范围1.功能点版本号版本功能序号功能功能点：用户从产品的角度提出了需要转换为产品(功能)要求的自己的用户要求。1、按版本号填写，根据用户要求，应在版本、系统功能、详细的小功能点列出。例如：版本号版本功能序号功能V1.11调整凭据V1.02传票稽核文件追踪V1.01凭证审核2.审阅历史记录版本号版本复查次数复查时间评委审查意见审核记录：记录每个版本的审核，并留下使用情况。1、按版本号填写，在表格中填写与本版本相对应的审阅内容，并注明审阅的意见和产品的回复，如有一个版本多次的情况审查，每次审查都要记录。例如：版本号版本复查次数复查时间检阅评比者和意见V1.1此版本是第一次审阅2018.2.1发展：徐力认为文件满足发展需要。测试：章节认为文档符合测试要求。用户：Yu认为文档满足用户的需要。其他：周没有意见。V1.0此版本是第二次审阅2018.1.31发展：徐力认为文件满足发展需要。测试：章节认为文档符合测试要求。用户：Yu认为文档满足用户的需要。其他：周没有意见。V1.0此版本是第一次审阅2018.1.30开发：徐利流程图不够详细，需要补充，产品同意补充；如果认为审计确认文件的细节需要重复删除，产品不同意删除。测试：没有章节意见。用户：Yu认为应该在审计列表中添加导出功能。产品同意补充。其他：周没有意见。四、名词说明n .名词义域例如，如果n .说明：产品手册通常有业务或技术术语，非行业的人也可能难以理解。这些术语需要说明，因此更熟悉业务，更容易理解文档。1、文件作者应该列出哪些名词，应该列出一般行业专有名词。2、有时，多个产品文档中可能有特定的名词，名词需要统一的解释，最好以最先写好的文档的名词解释为基础，以免在每个地方有不同的解释。例如：n .名词义域例如，如果原始证书原证明，也称为文件，是经济工作发生或完成时取得或填写的，记录或证明经济工作发生或完成的文字证明。这不仅可以用于记录经济工作的发生或完成情况，还可以用于明确经济责任，是执行会计工作的原始资料和重要依据，是会计资料中最具法律效力的文件。增值税发票、火车票等会计老实说，会计只是经济工作发生后你要收取的账户的名字管理费-差旅费五、主要流程图1、主要流程图包括业务流程图和状态流程图。创作插图时，对简短的文本说明进行补充。文档阅读人员可以通过图片直观地理解业务，以便更好地理解功能逻辑。2、业务流程图应记录业务关系、工作顺序、信息流。通常，满足这三种功能要求的业务流程图根据业务的实际处理阶段和过程阐明业务流程的内容，此处记录业务的主要流程，如果主要流程下存在分支和详细流程，则后续详细信息功能将单独补充子流程。根据业务流程是否需要多角色段，可以分为流程图、通路、阶段性通路等。3、状态流程图主要是根据业务运营或事件等进行的状态变化，一般下降到具体的文件，其他状态表示另一种业务意义。状态图的作用是明确实现业务所需的状态序列，以及引发状态转移的事件和状态转移相关的动作。补充了通常需要状态判断的作业类的状态流程图。例如：主流程图1、凭证接口根据规则为收到的单据创建凭证。创建后转发到审计目标凭据列表；2、财务登录系统，进入凭证审核列表。如果证明错误，则可以使用证明调整功能；如果验证没有错误，则可以选择单据进行审核。3、审核完成后，凭据根据系统计划任务传送到kingdee系统，如果传输成功，则流程结束；转移失败不会返回凭据、重新调整和复查、检查并转发，也不会返回，而是保留并转发。4、总帐接口部分在总帐接口产品要求文档中进行了说明。状态流程图状态变更请参阅总帐介面部分总帐介面产品需求文件中所述的图例六、功能列表列出每个版本对应的详细功能点、每个功能对应的流程、原型和逻辑。1.XX功能1.对应于上述“第3部分，产品范围”中的功能点，需要对每个详细功能进行说明。范例：1。证书审核功能1.1凭据审核子流程图1，在上面的“5，第一流程图”中，相应的业务流程已准备就绪。此处，位于主业务流程中但没有进一步说明或反映在主流程中的功能准备子流程图相对更加详细。如果主进程是已说明的更详细或更简单的业务，则此处不能列出流程图。例如：1.2凭据审核原型逻辑原型页面逻辑1、原型交互逻辑2、业务逻辑1、对于包含页面的功能，必须列出功能的原型和逻辑；对于原型，必须逐页列出每个页面及其逻辑。绘制页面必须符合UI规范，绘制的控件必须全部是UI代表发送的控件库，如果不在控件库中，则必须首先将UI人员补充控件添加到标准控件库中。UI规范不再在此处单独说明。有关详细信息，请参阅UI规范文档。普通：原型中需要参考的规格如下。1)所有页面的顶部都显示面包屑页面路径，告诉您当前页面存在。凭据管理凭据审核列表2)熟悉和使用web平台上的各种标准控件3)交互式帮助行为(也可以在表格右侧单独说明)4)可能发生错误的按钮(例如按钮的不同颜色)尽可能清楚地区分5)易于使用的原则、程序可以实现，并防止用户直接工作(导出、导入等)。6)命名：页面命名尽可能接近功能，通常是名词(例如凭证列表)或动词名词(凭证审核)。动作通常是根据动词(例如delete)命名的。状态：工作类别中的文件尽可能保持一致的状态(例如，新增、核准搁置、稽核、拒绝稽核)7)不要滚动页面超过翻页。但是，向导和分步操作通常更好地翻页，每个页面都是工作流，在进入下一步骤之前完成上一步骤8)对于子页，需要明确返回上一页的按钮。2、如果业务逻辑等不包含页面，则可能没有原型，但必须明确说明业务逻辑。3，通常，页面逻辑描述包括交互逻辑、业务逻辑1)交互描述行为(如果原型中未说明，则应补充原型右侧的表单)、2)注重工作提示。您需要提供预信息提示、交互过程中的任务相关提示、结果信息提示等词典信息提示表单提交类例如：修改密码时，单击密码框准备输入，然后在密码框旁边显示密码要求(长度、组合等)慎重的班级工作例如，要扣除金币，必须事先询问金币的数量和目前金币是否足够。区分规则例如：如果一个功能的规则与用户习惯的规则稍有不同或更复杂，则需要提示。或提供帮助链接互动式进行中的工作秘诀工作确认提示范例：确认删除操作错误提示如果评论字数为零或超过了限制字数，则在未填写搜索框时提交结果信息提示查询类结果如果没有所有信息列表、查询结果和该信息的结果，则必须提供“无结果”状态提示。保存类结果个人信息设置等。提交保存后必须提供提示。成功绿色，失败红色，普通灰色。附加类结果一个表格附加到其他数据，例如评论。提交成功后，必须立即转到作业的显示结果部分。各种弹匣。确认框、句柄、通知框、提示框等4)容错性原则，通常需要考虑页面，以防止用户操作不当。但是，无法控制的要求必须考虑正向和反向过程，例如，可以取消新创建的文档5)通常，列表需要考虑排序、聚合和筛选6)需要考虑默认值、是否可操作、所需输入长度等的所有页面字段7)业务逻辑主要包括：功能逻辑：详细说明此功能的逻辑。交互逻辑：讨论页面之间的交互跳转。视觉逻辑：颜色，图标要求。业务逻辑：请告诉我此功能对应什么业务。技术逻辑：某些逻辑可以用技术语言更清楚地描述，并且对技术可能有特殊要求。7)字段编码(可以研究和开发定义)、字段名称(必须与页面字段匹配)、类型、长度、必需、可输入性、值来源、输入方法、语义、默认值和业务逻辑等数据字典。通常，新页需要数据字典。如果是与数据字典相关联的其他功能的页，并且需要描述哪些页以及在原型中显示相关联的页，则可能不希望列出数据字典。例如，许多查找列表都有文档编号，单击文档编号即可查看原始文档，查看原始文档的页面在很多地方使用，原型补充了原始文档详细信息页面，逻辑说明需要说明查询文档链接的页面。例如：1.2凭据审核原型逻辑路径，菜单：财务平台-凭据管理-凭据审核1、描述头上的按钮1重新部署单击此按钮可清空凭据调整查询列中的输入条件。2调整一次只能选择一个文档，单击此按钮将进入凭据调整功能页面。如果未选择多行单据或选定了多行单据，则在您按下按钮时，系统会弹出一个弹出式窗口。选择要用于调整凭证的单据行！3审查至少选择一行文档并单击按钮后，弹出消息框：“系统将审核凭据，在审核完成之前，请勿运行操作系统！”单击“确定”(ok)后，页面将锁定并显示审阅中小型圆。请等待评估完成。弹出提示框：“评估完成！”解除页面锁定，并将文档凭据状态更新为审核。2、凭据调整查询列说明：单击“添加”按钮以显示隐藏的查询条件。单击查询时，默认情况下每页显示100个。1酱料值列表系统代码定义的证书源默认情况下全部显示不一定会输2文件编号文本手动输入不一定会输3类型值列表系统代码定义中的证书类型默认情况下全部显示不一定会输4科目多重选取方块帐户定义中启用的帐户默认情况下全部显示不一定会输单击“更多”按钮以显示5部门多重选取方块部门定义中启用的部门默认情况下全部显示不一定会输单击“更多”按钮以显示3，文件明细行摘要：在产生预先核准证明的系统间介面上接收的文件资讯1酱料30个字符不能输在证明界面中接收的单据来源字段2文件编号30个字符不能输在证明界面中接收的单据编号字段单击文档编号将转到02文档编号详细信息页面3文件类型30个字符不