Home
>
公司软件项目管理文档
>
软件文档管理规范
软件文档管理规范

time:2020-07-29 11:07:02

author:重庆佰鼎科技有限公司

【Font size: big medium smail

本文由重庆佰鼎科技有限公司提供,重点介绍了软件文档管理规范相关内容。重庆佰鼎科技有限公司专业提供公司软件项目管理文档,java web文档管理系统,wordpress 文档管理等多项产品服务。本公司长期从事该行业多项服务支持,经过多年的发展,现已成为行业服务的佼佼者。

软件文档管理规范产品经理主要有两项职责:①评估产品机会

② 定义要开发的产品;定义开发的产品则需要通过产品需求文档(PRD)来描述产品的特征和功能。

一. PRD(开发需求文档)的作用在学习如何撰写PRD之前,我们先要明白写PRD的目的是什么:软件文档管理规范

①概念化”阶段进入到“图纸化”我们之前在市场需求文档(MRD)中阐述到的功能,都是表达的一个意向,不考虑实现方法和细节。而PRD则是将概念图纸化,需要阐述详细的细节和实现模型。产品人员可以通过撰写PRD,梳理清楚方案实现过程中的各种问题和影响。

②向项目成员传达需求的意义和明细PRD的主要面向对象是项目经理、开发、设计和测试。如何向这些不同的角色表达清楚需求明细,就需要一份规范的PRD文档来描述。项目经理通过文档可以迅速了解任务的规模和相关接口,而开发设计人员通过文档可以了解页面元素和用例规则,测试人员可以提前根据文档撰写测试用例。PRD文档在形式上是项目启动的必要元素之一。

③ 管理归档需求大都数的新需求都需要迭代几个版本后才能走向成熟稳定的阶段,如果没有PRD文档,在大型项目中,需求的迭代变更将变的无据可循。PRD的文档修订编号和命名也是项目规范化管理的主要方法之一。

二.PRD的表现形式一般企业内部的PRD文档选择wiki系统或word文档。wiki在协同和保密方面会有优势,而且能够记录修改文档的每一次变更。而word在阅读修改方面比较有优势,一般使用Word加SVN的方式来管理更新文档。这个可根据每个企业的管理规范来选择那种方法更合适。

三.PRD的主要构成一份基础的PRD文档主要由三部分组成

①引言引言部分主要包括:需求背景、需求目的、需求概要、涉及范围、全局规则和名词说明,交互原型地址等。引言部分的写作目的是让阅读者快速理解需求背景和概要。如果是公司内部文档,引言部分可以从简写作。

②业务建模建模的目的是为了帮助阅读对象更好的理解需要开发的需求,常用的模型种类包括:用例图、实体图、状态图、流程图等。常用的建模语言如UML。UML具体的建模方法请戳这里。

③ 业务模块业务模块包含具体页面的元素、用例规则,以及相关的原型,流程图。业务模块的描述是整个文档最核心的部分,下面博主用案例来描述一下业务模块的编写方法。

四. 案例介绍:旅行箱–目的地攻略(应用商店搜索“旅行箱”)需求的目标是在APP中展示相关国家/城市的旅游资讯内容,如下图所示:

那么我们在第一部分的引言中可以写下简单的需求描述:

1. 目的地攻略以城市/国家为单位,展示八个栏目下的文章列表。

2. 初期运营指标为编辑所有涉及城市的归属国家攻略内容,相关城市暂不编辑;APP前台默认显示国家内容卡片,城市内容卡片无数据时隐藏。

3. 运营系统提供内容生成对应的触屏网页,App读取和下载对应网页内容;

为了帮开发者迅速了解需求结构,我们需要建一个简单的流程图帮助开发理解功能:

相对复杂的运营系统,我们可以补充相关用例图和实体关系图:

引言和建模部分是为了帮助开发和测试人员快速理解需求,具体的页面和用例规则还需要通过第三部分的业务模块来描述,这里我们节选案例中的文章列表页来描述:软件文档管理规范

文章列表页共包含一个页面,四个用例那我们的描述结构就为:

1. 文章卡片页面元素

2. 收藏文章用例

3. 分享文章用例

4. 查看文章列表

5. 查看文章(太简单可不描述)

文章卡片的页面元素描述: (收藏)用例的描述为业务模块的描述一般是原型图+数据元素+用例描述,这样可以在原型图的基础上加上对应元素属性的描述,并通过动作描写的方式表达用例规则和各种流程。这样的写作方式不仅可以向不同对象传达产品经理的意图,而且可以帮助产品经理自己梳理需求的逻辑和各种异常流程。

阅读本篇文章,请在应用商店搜索“旅行箱”下载安装,对照APP中的目的地攻略等页面进行理解。如果觉得文章还不错,请支持一下给应用一个评分。

原文地址 http://www.54xiaomeng.com/?p=978

Reprint please indicate:http://www.cnsoftweb.com/wdgl-3376.html