产品文档的程度与细节,很大程度上依赖于工作内容。Praxis提供一份领域清单,应该根据项目或项目群的需要构建这些领域合适的文件,而不是事先规定的独立的文件。
这可能导致一种简单的方式,每个产品一个文件;或一种更宽泛的方式,对于产品描述、配置项与质量记录,有独立的文件。
出于方便的考虑,以上提到的领域列为三个部分。当扩展为独立的文件时,这些领域经常需要在独立文件中重复。
描述性信息
- 识别器
-
一个独特的识别器可能由以下几个组成部分构成,例如项目或项目群的代码、产品代码、版本号等等。
- 标题
-
产品由标题而被认知。
- 描述
-
产品描述可能包括它的目的,以及它如何与整体产出融为一体。
- 构成
-
对于简单产品,在该 部分描述构成要素与产品本质就足够了。更复杂的产品,需要参考技术规格要求。
- 负责人
-
如果产品是交付物,那么负责人就是利益相关方,即产品要移交给他/她。否则就由管理团队的一名成员担任,负责在把产品纳入产出整体之前对产品进行验收产品。
- 相互参考
开发信息
- 开发者
-
负责产品开发的人员、团队、部门或承包商。
- 计划日期
-
计划中产品开发完成的时间。
- 实际日期
-
产品实际开发完成的时间。
- 质量标准
-
这些是质量控制中要检测的质量标准。它可以作为外部质量标准的参考、产品的独特标准、或是两者的组合。
- 质量容许偏差
-
对于每个质量标准,应该罗列清楚产品验收的衡量范围。
- 质量控制方法
-
在这个部分定义应该运用的控制方法。可以从定性的用户评审到机械性能试验与统计分析。
- 质量控制职责
-
负责实施质量控制方法的个人或团队。
- 测试日期
-
对大部分测试或评审活动的计划与预测日期,完全取决于定期更新的交付进度。为了避免工作的重复,计划与预测日期可能简单地涵盖在合适的交付计划的相互参考中。这样的相互参考也许由例如“产品必须在完成开发后的一周内进行测试”这样的信息加以补充。
- 测试结果
-
质量控制结果可以只是简单的通过/未通过,或者广泛的测试数据。无论哪种结果,测试结果都应该进行记录。如果产品质量可以接受,就将其与其他产品整合或把产品移交给负责人。如果质量不可接受,产品可能需要返工或抛弃。有些情况下,也许可能或者需要接受没有达到标准的产品,但这个决定需要由发起人来做出。
- 相互参考
-
通常是与交付计划相互参考,交付计划显示计划与实际的日期。
配置信息
- 当前版本
- 状态
-
配置管理计划中定义了当前状态的分类,例如开发中、评审中、批准、已移交等。
- 上次变更的日期
-
最新版本的产品测试或移交的时间。
- 先前版本
-
记录最新版本的日期,不能替代先前的日期。每个“当前版本”识别器与“上次变更的日期”需要保留在文件中,以显示产品开发的时间线。
- 位置
-
配置项所处的或保存的位置。这适用于“软产品”,例如电子档案或在装配之前可以到处移动的物理形态的构件。这与那些整体产出之中的产品无关,例如建筑物的地基或船的龙骨。
- 当前持有人
-
产品的当前版本可能在初始开发人或测试团队手中。当产品具有物理形态与不可复制性的时候,这就是很有用的信息。
-
当产品是电子文件(例如文档或计算机代码)、下载或邮件附件就产生一个副本的时候,清楚知道谁具有对产品实施工作的唯一职权,是至关重要的。这是确保没有多人对一个产品同时进行变更的关键。
- 相互关系
-
该部分解释了产品如何与其他产品协同工作。这是评审变更申请的关键部分,因为它识别出产品的一个变更可能将如何影响其他产品。
典型文件
每个文件包含的典型内容概括在下表中。
很多不同种类的文件可以从产品信息菜单中加以汇总。以下描述的这些文件,是基于它们在各种项目、项目群与项目组合管理的指南和方法中出现。但并无意做成一个确定的或规定性的清单。
- 产品描述
-
对于项目、项目群或项目组合目标的特定构成要素而言,该文件是最小的规格要求。它使人们理解产品的详细属性、目的、功能、外观与验收标准。它应该包含充分的信息,以识别:需要什么活动开发、测试与批准产品;开发产品所需的资源;产品成本;到哪里可以找到进一步的信息。
- 产品登记单
-
该登记单概括了来自产品描述的信息,以提供关于产品的检索,以及快速了解产品状态。有时候该登记单指产品核查名单。
- 质量登记单
-
质量登记单概况了所有产品的质量控制活动,并为潜在非常多元化的项目组合的质量控制文档,提供核心参考。
- 配置项
-
该文件提供配置管理中的配置项记录。它涵盖例如过往历史、当前状态、版本及与其他配置项之间的联系。
- 状态记述
-
状态概况了已定义的成套配置项当前状态的信息,例如,“所有产品要在下个月完成”,或“所有产品都由XYZ承包有限公司开发”。状态报告的范围应该在罗列以下表格中的信息之前,就描述清楚。
方面 | 产品登记单 | 产品描述 | 质量登记单 | 配置项 | 状态记述 |
---|---|---|---|---|---|
识别器 | X | X | X | X | X |
标题 | X | X | X |
|
|
描述 |
| X |
| X |
|
构成 |
| X |
|
|
|
负责人 |
|
|
| X | X |
相互参考描述 | X | X | X | X | X |
开发人 |
|
|
| X | X |
计划日期 | X |
| X |
| X |
实际日期 | X |
| X |
| X |
质量标准 |
| X |
|
|
|
质量容许偏差 |
| X |
|
|
|
质量控制方法 |
| X | X |
|
|
质量职责 |
| X | X |
|
|
测试结果 |
|
|
| X | X |
开发相互参考 | X | X | X | X | X |
当前版本 | X |
|
| X | X |
状态 |
|
|
| X | X |
上次变更的日期 |
|
|
| X | X |
先前版本 |
|
|
| X |
|
位置 |
|
|
| X |
|
当前持有人 |
|
|
| X |
|
相互关系 |
|
|
| X |
|