软件公司AFC技术文档编制管理规范.docx

PAGE PAGE 1 软件公司 AFC技术文档编制管理规范 概述 目的 统一投标文件的表现和外观，规范文档管理，简化文档格式化和管理的工作量。 技术文档的编制管理主要是为了将开发过程中各个阶段的文档进行统一规范的管理，包括系统开发设计类文档、测试类文档、用户使用类文档以及交流类文档等，并进一步的做到完善、更新和添加。 管理规范主要包括： 制定文档的命名和编码规则； 制定文档的格式规范；（包括所有不同种类的文档、表格、图表等） 目录管理；（包括目录的建立，索引文档，目录变更等） 版本以及状态管理； 文档权限控制；（根据项目的分工对文档进行分类管理） 文档汇总；（定期查看文档状态，做阶段性汇总） 文档备份。 使用范围 AFC技术部编制的所有文档强制遵循本规范。 适用人员 文档管理和使用人员。 目录管理 文档目录的创建 整个项目过程的文档将通过服务器（AFC_SVR），采用VSS进行管理。文档管理目录按项目进展的时间段进行划分。各类文档按照不同阶段的需要进行分类： 五号线项目文档管理目录结构 根据CMM标准将各阶段所需要编制的文档至少包括以下种类： 文档类型 阶段划分 输出文档模板 备注 项目管理 立项管理 《立项预算申请》 《立项调查报告》 《立项可行性分析报告》 《立项建议书》 《立项评审报告》 结项管理 《结项申请书》 《结项评审报告》 项目规划 《项目估计报告》 《项目计划》 《项目SQA计划》 《项目SCM计划》 《项目计划变更控制报告》 《项目执行组织机构图》 《项目风险计划》 项目监控 《项目监控数据表》 《项目偏差控制报告》 《项目控制进度表》 《项目进展报告》 《项目评审报告》 用户需求 《需求评审报告》 《需求跟踪报告》 《需求变更控制报告》 配置管理 《配置管理计划》 《配置库管理报告》 《配置项变更控制报告》 《月度进度报告》 培训管理 《机构培训计划》 《项目培训计划》 《机构培训通知》 《项目培训通知》 《机构培训评估报告 《项目培训评估报告》 产品维护 《客户服务计划》 《客户服务报告》 《产品维护计划》 《产品维护报告》 会议记录 《会议记录单》 日志管理 《日报》 《周报》 《月报》 项目研发 需求开发 《用户需求说明书》 《产品需求规格说明书》 系统设计 《体系结构设计》 《功能闺阁书详细设计》 《用户界面设计》 《数据库设计》 《模块设计》 《与相关接口的设计》 所有《软件设计阶段文档》： 软件流程图 软件源代码 软件清单 代码检查单 技术复查活动检查单 版本检查单 测试记录检查单 BUG处理流程检查单 安装手册检查单 评审活动检查单 实现与测试 《实现与测试计划》 《编程文档》 《代码审查报告》 《测试用例》 《测试报告》 《缺陷管理报告》 《测试验收记录》 系统测试 《系统测试计划》 《系统测试用例》 《系统测试报告》 《缺陷管理报告》 验收测试 《Beta测试协议》 《Beta测试报告》 客户验收 《客户验收计划》 《验收测试用例》 《客户验收报告》 技术评审 整个项目的《技术评审计划》 《技术评审通知》 《技术评审报告》 常用的《技术评审检查表》 输出文档 安装类文档 所有安装、配置图纸 所有系统、设备的安装说明书 用户手册 所有用户操作手册、 维修手册 培训类文档 所有培训手册和资料 文档模板列表 文档索引 按照各阶段所需要输出的文档内容，建立文档状态跟踪列表（项目包括文档名称、编号、版本号、最后变更日期、状态等），保证随时能够查阅最新文档。 文档命名规范 文档命名规则 一般文档命名规则 文档统一使用全英文命名方式。文件名由六部分组成，各部分由分隔线连接。 文件命名请遵循下面规则： 文档编号规则 注:所有类型的文档编号，只能使用“1～199”位的编号，OMRON使用“200～399”位的编号，即所有文档OMRON都从200开始编号。 NO 编码 表示 说明 1 Z 资料 Material 2 K 投标 Bidding 3 N 商务谈判 Negotiation 4 J 设计联络 DesignTheContact 5 Q 样机试制 Advanceddevelopment 6 P 批量生产 VolumeProduction 7 S 软件需求 SoftwareRequirement 8 G 概要设计 PreliminaryDesign 9 D 详细设计 DetailedDesign 10 C 编码 Coding 11 T 测试 Test 12 U 施工准备 PreparationsForConstruction 13 V 施工设计 WorkingDesign 14 W 现场施工 SiteOperation 15 B 采购 Stock 16 I 安装 Installation