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

1、软件公司AFC技术文档编制管理规范1概述1.1目的统一投标文件的表现和外观，规范文档管理，简化文档 格式化和管理的工作量。技术文档的编制管理主要是为了将开发过程中各个阶 段的文档进行统一规范的管理，包括系统开发设计类文档、 测试类文档、用户使用类文档以及交流类文档等，并进一步 的做到完善、更新和添加。管理规范主要包括：1. 制定文档的命名和编码规则；2. 制定文档的格式规范；（包括所有不同种类的文档、 表格、图表等）3. 目录管理；（包括目录的建立，索引文档，目录变更 等）4. 版本以及状态管理；5. 文档权限控制;（根据项目的分工对文档进行分类管 理）6. 文档汇总；（定期查看文档状态，做阶

2、段性汇总）7. 文档备份。表3.文档类型编码表序号专用名词描述1SLEAFC专用终端设备2AG自动检票机3DG末端AG4EnG进站AG5ExG出站AG6RG双向AG7TVM自动售票机8BOM半自动售票机9E/S编码分拣机10EB紧急按钮11EQM自动查询机12PCA便携式检票机13ECU主控单元14PC个人计算机15OCC控制中心16LCD薄膜晶体管液晶显示器17UPS不间断电源18WS工作站19SAM安全模块20TC票务中心21SC车站计算机系统22LC中心计算机系统23MC维修中心24ss软件系统25NS网络系统序号专用名词描述26PSS电源系统27CGS顶棚导向标识表4.文档类型编码表N

3、O编码表示说明1CN中文简体中文文档2EN英文英文文档3JP日文日文文档表5.文档语言编码表3.1.2接收、发送的文档命名规则所有在VSS控制的文档都使用“文档编号”命名（见图2）；所有与外部交流的文档都使用“文件名称”命名（见图 2）。例如：与OMRON、其他合作伙伴等交换的文档，需要在 “_CN”后追加内部版本号以及保存、交换的日期号。交换文档由文档管理员负责统一发送和接收。4文档模板所有文档的编写必须套用指定的模板，不允许个人对文 档模板进行修改，有任何问题可与文档管理员交流，并由文 档管理员统一进行修改。模板选择步骤如下：打开目录（正在完善中）下的“文档模板库"（excel表

4、）， 从中选择你需要的文档模板的名称，点击后，将链接到该模 板中，然后从“文档编号申请系统”（建设中）中自行申请 文档编号，申请完成后，将模板按申请的文件名命名并另存 到本地，即可使用。5文档管理流程5.1内部文档的管理流程编写一个新的文档，需要遵循以下步骤；1. 新建一个文档前首先在“文档编号申请系统”中自 行申请一个文件编号；2. 然后编写人员到“文档模板库”中选择相应的文档 模板（详见“4文档模板”）；3. 编写人完成一次编写后，可将文档Checkin到VSS 的“个人文档库”中备份，需要修改时再从VSS中Checkout 到本地进行修改，修改完成后再Checkin到VSS中，如此反 复

5、进行（可保存原始文档和修改记录），直到完成最终文档。（本条只作为建议）4. 编写人员将最终提交的文件按时放在VSS的“个人 文档库”中的个人目录下，并以邮件或口头通知的方式通知 文档管理员接收。需要版本升级的文档，编写人员将修改后 的文档再次提交文档管理员，由文档管理员将修改后的版本 更新到VSS,同时更新文档索引（见2. 2文档索引），保证文 档版本的最新状态。5. 如果需要查看VSS中保存的文档，可与文档管理员 联系，由文档管理员对其开放该文档的只读权限，在文档参 考完毕后收回权限。5. 2与外部文档交互管理1. 我方与外部（如OMRON或其他分包商等）交互的文 档，文档管理员要在文档交互

6、登记表中登记，详细记录 发出文档或接收文档的名称、编号、交互时间、接收人、发 出人等内容；2. OMRON、其他分包商等外部提供的项目文档，必须严 格遵循的文档命名规范，详细说明见“3.1.2交换文档命名 规则”；（由文档管理员与对方文档命名负责人协调）3. 接收到的外部文档，由文档管理员对其格式进行标 准化，然后Checkin到VSS中存档。6文档管理、版本控制6. 1 VSS的安装1）版本管理采用VirtualSourceSafe6. 0,每人必须安 装该软件客户端软件。该软件目录在 bf i-f ilesvrsof11 ibDevelopVisualC+6. 0 目录下, 运行Setup

7、之后，选择安装product，仅安装 VirtualSourceSafe6. 0 即可。2）路径为：Afc_svrAFCVSS$,登陆名称与域登陆 名相同，初始密码为空。如郭建红登陆名为：Guo_jianhongo3）VSS上共有两个库，一个是文档管理库，由文档管 理员统一进行管理，控制所有编制完成的项目文档，并设定 相应的访问权限；另一个是个人文档备份库，为每个人设一 个文件夹，由个人维护管理，但相互之间无法访问。4）VSS的管理结构主要分为三个部分，分别是Docs、Manage> Releaseo其中，技术文档放在Docs目录下的 Technical中按项目的时间段分成了 24 （可

8、调）个子目录, 一个“PersonalFile”目录。其中的24个子目录由文档管 理员管理，并设有相应的访问权限，目前只有文档管理员及 总工办有访问权限；“个人文档库”则为每个人设置了一个 文件夹，并由个人维护管理。7文档权限控制所有文档的最终版本必须严格保密，防止泄露。因此要 对所有文档进行权限控制。目前，“Technical”目录的访问权限只对总工办和文档 管理员开放；“个人文档库”目录下，每个人只有访问自己 文件夹目录的权限。8文档备份所有文档采用双保险备份。一是通过硬件（光盘刻录）来实现备份，由网管定期完 成。主要说明如下：在VSS中，给网管设置“只读”权限，由网管定期（每 月最后一个

9、工作日下午16点）将"Technical"目录下的所 有文件进行备份，刻录在光盘上进行保存。如果有特殊情况, 比如某段时间输出的文档很多，为了保险起见由文档管理员 临时通知网管进行随时备份。备份后的光盘由文档管理员统 一编号保管。（具体事宜由文档管理员与网管沟通）二是通过文档管理员进行电子备份，说明如下：文档管理员定期（每月第2、4个星期的下午17点）将 “Technical”目录下的所有文件备份在用户名为AFC2的文 档备份机器上，并设置访问权限。1.2使用范围AFC技术部编制的所有文档强制遵循本规范。1.3适用人员文档管理和使用人员。2目录管理2.1文档目录的创建整个项

10、目过程的文档将通过服务器(AFC.SVR),采用VSS 进行管理。文档管理目录按项目进展的时间段进行划分。各 类文档按照不同阶段的需要进行分类：B宣 $/B-&北京地铁五号线项目S-fitf Docs牛-通 Businessb 食 persqnalFilej一宣 dai_xiaot ao一际 guo_jianhong-fid jia_jian一鲤 lian_gang一画 sui_lili-fig wang_zhaohua一阻 wang_zhihua一画 xu_jie一宣 zhang_li1遂犯 zhao_wenB-fiaj Technical00. Material-fig 01. B

11、idding-fig 02.Negotiation一画 03. Design The Contact一倒 04. Advanced developmen一旬 05. Volume Productionfig 06. Software Requiremen-fig 07.Preliminary Design-fig 08.Detailed Design-fid 09. Coding-fig 10. Test一画 11. Preparations For Co-IlKi 12. Working Design-Ji 13. Site Operation-fig 14.Stock-fig 15. In

12、stallation-fii 16. Adjust and Test-fifi 17. Commissioning-M 18. Check and Accept一滋| 19. After Service-fig 20.Training甲宣 21. Meeting-fig 22. Manual-M 23. Equipment Supplier H 24. Project Management知.五号线项目文档管理目录结构根据CMM标准将各阶段所需要编制的文档至少包括以下种类:文档类型阶段划分输出文档模板备注项目管理立项管理立项预算申请立项调查报告立项可行性分析报告立项建议书立项评审报告结项管理结

13、项申请书结项评审报告项目规划项目估计报告项目计划项目SQA计划项目SCM计划项目计划变更控制报 告项目执行组织机构图项目风险计划项目监控项目监控数据表 项目偏差控制报告项目控制进度表项目进展报告项目评审报告用户需求需求评审报告需求跟踪报告需求变更控制报告配置管理配置管理计划配置库管理报告文档类型阶段划分输出文档模板备注配置项变更控制报告月度进度报告培训管理机构培训计划项目培训计划机构培训通知项目培训通知机构培训评估报告项目培训评估报告产品维护客户服务计划客户服务报告产品维护计划产品维护报告会议记录会议记录单日志管理日报周报月报项目研发需求开发用户需求说明书产品需求规格说明书系统设计体系结构设计

14、功能闺阁书详细设计用户界面设计数据库设计模块设计与相关接口的设计 所有软件设计阶段文 档：软件流程图软件源代码文档类型阶段划分输出文档模板备注软件清单代码检查单 技术复查活动检查单版本检查单测试记录检查单BUG处理流程检查单 安装手册检查单 评审活动检查单实现与测试实现与测试计划编程文档代码审查报告测试用例测试报告缺陷管理报告测试验收记录系统测试系统测试计划系统测试用例系统测试报告缺陷管理报告验收测试«Beta测试协议Beta测试报告客户验收客户验收计划验收测试用例客户验收报告技术评审整个项目的技术评审计划技术评审通知技术评审报告文档类型阶段划分输出文档模板备注常用的技术评审检查表输

15、出文档安装类文档所有安装、配置图纸 所有系统、设备的安装说 明书用户手册所有用户操作手册、维修手册培训类文档所有培训手册和资料表1文档模板列表2.2文档索引按照各阶段所需要输出的文档内容，建立文档状态跟踪 列表（项目包括文档名称、编号、版本号、最后变更日期、 状态等），保证随时能够查阅最新文档。3文档命名规范3. 1文档命名规则3.1.1 一般文档命名规则文档统一使用全英文命名方式。文件名由六部分组成, 各部分由分隔线连接。文件命名请遵循下面规则：文档犒号（VSS控制）文件名称（对外交流保存）固定项目名称缩写（北京地铁五号线）三组。第一组代表文档种类编码； 第.组为同一种类文档顺序号： 第三组

16、代表文档类型编码。三组：（建议不超过32个字符）, 第一组软/硬产品的名称； 第二组为功能性能缩写；第二组为文件性质。两位，语言编码年、月、日：序列号版本号文档编号规则注:所有类型的文档编号，只能使用“1199”位的编 号，OMRON使用“200399”位的编号，即所有文档OMRON 都从200开始编号。NO编码表示说明1Z资料Material2K投标Bidding3N商务谈判Negotiation4J设计联络DesignTheContact5Q样机试制Advanceddevelopment6P批量生产VolumeProduction7S软件需求SoftwareRequirement8G概要设计PreliminaryDesign9D详细设计DetailedDesignNO编码表示说明1Z资料Material10C编码Coding11T测试Test12U施工准备PreparationsForConstruction13V施工设计WorkingDesign14W现场施工SiteOperation15B采购Stock161安装Installation17A调测AdjustandTest180试运行Commissioning19X验收Ch