技术文档编制管理规范.docx
《技术文档编制管理规范.docx》由会员分享，可在线阅读，更多相关《技术文档编制管理规范.docx（17页珍藏版）》请在冰豆网上搜索。
技术文档编制管理规范
文档分类：
文档管理
应用范围：
技术相关文档
文档编号：
BT5AFC-L.001.P001-DocumentManage-CN
技术文档管理规范
Version1.0
二○○五年五月
修订记录
NO
版本
时间
修订说明
修改人
1
1.01
2005年3月25日
修改
龚健
此处不要加任何分隔符号，以下开始为正文内容。
AFC技术文档编制管理规范
1概述
1.1目的
统一投标文件的表现和外观，规范文档管理，简化文档格式化和管理的工作量。
技术文档的编制管理主要是为了将开发过程中各个阶段的文档进行统一规范的管理，包括系统开发设计类文档、测试类文档、用户使用类文档以及交流类文档等，并进一步的做到完善、更新和添加。
管理规范主要包括：
1.制定文档的命名和编码规则；
2.制定文档的格式规范；（包括所有不同种类的文档、表格、图表等）
3.目录管理；（包括目录的建立，索引文档，目录变更等）
4.版本以及状态管理；
5.文档权限控制；（根据项目的分工对文档进行分类管理）
6.文档汇总；（定期查看文档状态，做阶段性汇总）
7.文档备份。
1.2使用范围
AFC技术部编制的所有文档强制遵循本规范。
1.3适用人员
文档管理和使用人员。
2目录管理
2.1文档目录的创建
整个项目过程的文档将通过服务器（AFC_SVR），采用VSS进行管理。
文档管理目录按项目进展的时间段进行划分。
各类文档按照不同阶段的需要进行分类：
图1.五号线项目文档管理目录结构
根据CMM标准将各阶段所需要编制的文档至少包括以下种类：
文档类型
阶段划分
输出文档模板
备注
项目管理
立项管理
《立项预算申请》
《立项调查报告》
《立项可行性分析报告》
《立项建议书》
《立项评审报告》
结项管理
《结项申请书》
《结项评审报告》
项目规划
《项目估计报告》
《项目计划》
《项目SQA计划》
《项目SCM计划》
《项目计划变更控制报告》
《项目执行组织机构图》
《项目风险计划》
项目监控
《项目监控数据表》
《项目偏差控制报告》
《项目控制进度表》
《项目进展报告》
《项目评审报告》
用户需求
《需求评审报告》
《需求跟踪报告》
《需求变更控制报告》
配置管理
《配置管理计划》
《配置库管理报告》
《配置项变更控制报告》
《月度进度报告》
培训管理
《机构培训计划》
《项目培训计划》
《机构培训通知》
《项目培训通知》
《机构培训评估报告
《项目培训评估报告》
产品维护
《客户服务计划》
《客户服务报告》
《产品维护计划》
《产品维护报告》
会议记录
《会议记录单》
日志管理
《日报》
《周报》
《月报》
项目研发
需求开发
《用户需求说明书》
《产品需求规格说明书》
系统设计
《体系结构设计》
《功能闺阁书详细设计》
《用户界面设计》
《数据库设计》
《模块设计》
《与相关接口的设计》
所有《软件设计阶段文档》：
软件流程图
软件源代码
软件清单
代码检查单
技术复查活动检查单
版本检查单
测试记录检查单
BUG处理流程检查单
安装手册检查单
评审活动检查单
实现与测试
《实现与测试计划》
《编程文档》
《代码审查报告》
《测试用例》
《测试报告》
《缺陷管理报告》
《测试验收记录》
系统测试
《系统测试计划》
《系统测试用例》
《系统测试报告》
《缺陷管理报告》
验收测试
《Beta测试协议》
《Beta测试报告》
客户验收
《客户验收计划》
《验收测试用例》
《客户验收报告》
技术评审
整个项目的《技术评审计划》
《技术评审通知》
《技术评审报告》
常用的《技术评审检查表》
输出文档
安装类文档
所有安装、配置图纸
所有系统、设备的安装说明书
用户手册
所有用户操作手册、
维修手册
培训类文档
所有培训手册和资料
表1.文档模板列表
2.2文档索引
按照各阶段所需要输出的文档内容，建立文档状态跟踪列表（项目包括文档名称、编号、版本号、最后变更日期、状态等），保证随时能够查阅最新文档。
3文档命名规范
3.1文档命名规则
3.1.1一般文档命名规则
文档统一使用全英文命名方式。
文件名由六部分组成，各部分由分隔线连接。
文件命名请遵循下面规则：
图2.文档编号规则
注:
所有类型的文档编号，方正只能使用“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
17
A
调测
AdjustandTest
18
O
试运行
Commissioning
19
X
验收
CheckandAccept
20
Y
售后服务
AfterService
21
H
培训
Training
22
M
会议纪要
Meeting
23
F
手册
Manual
24
E
分包管理
EquipmentSupplier
25
L
项目管理
ProjectManagement
26
RI
RO
发送、接收文件管理
表2.文档种类编号表
NO
编码
表示
说明
1
P
主文档
ParentDocument
2
C
子文档
ChildDocument
3
A
附件文档
AccessoryDocument
4
S
关联文档
AssociatedDocument
5
R
关键参考文档
ReferenceDocument
6
扫描文档
表3.文档类型编码表
序号
专用名词
描述
1
SLE
AFC专用终端设备
2
AG
自动检票机
3
DG
末端AG
4
EnG
进站AG
5
ExG
出站AG
6
RG
双向AG
7
TVM
自动售票机
8
BOM
半自动售票机
9
E/S
编码分拣机
10
EB
紧急按钮
11
EQM
自动查询机
12
PCA
便携式检票机
13
ECU
主控单元
14
PC
个人计算机
15
OCC
控制中心
16
LCD
薄膜晶体管液晶显示器
17
UPS
不间断电源
18
WS
工作站
19
SAM
安全模块
20
TC
票务中心
21
SC
车站计算机系统
22
LC
中心计算机系统
23
MC
维修中心
24
SS
软件系统
25
NS
网络系统
26
PSS
电源系统
27
CGS
顶棚导向标识
表4.文档类型编码表
NO
编码
表示
说明
1
CN
中文
简体中文文档
2
EN
英文
英文文档
3
JP
日文
日文文档
表5.文档语言编码表
3.1.2接收、发送的文档命名规则
所有在VSS控制的文档都使用“文档编号”命名（见图2）；所有与外部交流的文档都使用“文件名称”命名（见图2）。
例如：
与OMRON、其他合作伙伴等交换的文档，需要在“_CN”后追加内部版本号以及保存、交换的日期号。
交换文档由文档管理员负责统一发送和接收。
4文档模板
所有文档的编写必须套用指定的模板，不允许个人对文档模板进行修改，有任何问题可与文档管理员交流，并由文档管理员统一进行修改。
模板选择步骤如下：
打开目录（正在完善中）下的“文档模板库”（excel表），从中选择你需要的文档模板的名称，点击后，将链接到该模板中，然后从“文档编号申请系统”（建设中）中自行申请文档编号，申请完成后，将模板按申请的文件名命名并另存到本地，即可使用。
5文档管理流程
5.1内部文档的管理流程
编写一个新的文档，需要遵循以下步骤；
1.新建一个文档前首先在“文档编号申请系统”中自行申请一个文件编号；
2.然后编写人员到“文档模板库”中选择相应的文档模板（详见“4文档模板”）；
3.编写人完成一次编写后，可将文档CheckIn到VSS的“个人文档库”中备份，需要修改时再从VSS中CheckOut到本地进行修改，修改完成后再CheckIn到VSS中，如此反复进行（可保存原始文档和修改记录），直到完成最终文档。
（本条只作为建议）
4.编写人员将最终提交的文件按时放在VSS的“个人文档库”中的个人目录下，并以邮件或口头通知的方式通知文档管理员接收。
需要版本升级的文档，编写人员将修改后的文档再次提交文档管理员，由文档管理员将修改后的版本更新到VSS，同时更新文档索引（见2.2文档索引），保证文档版本的最新状态。
5.如果需要查看VSS中保存的文档，可与文档管理员联系，由文档管理员对其开放该文档的只读权限，在文档参考完毕后收回权限。
5.2与外部文档交互管理
1.我方与外部（如OMRON或其他分包商等）交互的文档，文档管理员要在《文档交互登记表》中登记，详细记录发出文档或接收文档的名称、编号、交互时间、接收人、发出人等内容；
2.OMRON、其他分包商等外部提供的项目文档，必须严格遵循方正的文档命名规范，详细说明见“3.1.2交换文档命名规则”；（由文档管理员与对方文档命名负责人协调）
3.接收到的外部文档，由文档管理员对其格式进行标准化，然后CheckIn到VSS中存档。
6文档管理、版本控制
6.1VSS的安装
1）版本管理采用VirtualSourceSafe6.0，每人必须安装该软件客户端软件。
该软件目录在\\bfi-filesvr\softlib\Develop\VisualC++6.0\目录下，运行Setup之后，选择安装product,仅安装VirtualSourceSafe6.0即可。
2）路径为：
\\Afc_svr\AFCVSS$\，登陆名称与域登陆名相同，初始密码为空。
如郭建红登陆名为：
Guo_jianhong。
3）VSS上共有两个库，一个是文档管理库，由文档管理员统一进行管理，控制所有编制完成的项目文档，并设定相应的访问权限；另一个是个人文档备份库，为每个人设一个文件夹，由个人维护管理，但相互之间无法访问。
4）VSS的管理结构主要分为三个部分，分别是Docs、Manage、Release。
其中，技术文档放在Docs目录下的Technical中按项目的时间段分成了24（可调）个子目录，一个“PersonalFile”目录。
其中的24个子目录由文档管理员管理，并设有相应的访问权限，目前只有文档管理员及总工办有访问权限；“个人文档库”则为每个人设置了一个文件夹，并由个人维护管理。
具体结构见“图1”。
7文档权限控制
所有文档的最终版本必须严格保密，防止泄露。
因此要对所有文档进行权限控制。
目前，“Technical”目录的访问权限只对总工办和文档管理员开放；“个人文档库”目录下，每个人只有访问自己文件夹目录的权限。
8文档备份
所有文档采用双保险备份。
一是通过硬件（光盘刻录）来实现备份，由网管定期完成。
主要说明如下：
在VSS中，给网管设置“只读”权限，由网管定期（每月最后一个工作日下午16点）将“Technical”目录下的所有文件进行备份，刻录在光盘上进行保存。
如果有特殊情况，比如某段时间输出的文档很多，为了保险起见由文档管理员临时通知网管进行随时备份。
备份后的光盘由文档管理员统一编号保管。
（具体事宜由文档管理员与网管沟通）
二是通过文档管理员进行电子备份，说明如下：
文档管理员定期（每月第2、4个星期的下午17点）将“Technical”目录下的所有文件备份在用户名为AFC2的文档备份机器上，并设置访问权限。
升级会员 