1、项目文档管理办法(V1.1 版本)2015-04-1421 引言 1 .1编写目的 制订统一的文档管理办法及格式,对项目过程中产生的项目有关资料提供规范,便于在今后项目开展过程中对各项资料的查找和相互交流 ,以利项目开发及进展; 制订项目开发过程中的评审和查阅规范,明确相应的管理人员责任。2 任务概要 2 .1 工作内容项目发展的过程中,随着项目逐步展开,会产生大量的设计方案文件、设计说明书、源代码、会议记录及培训资料等内容,对这些内容进行分类整理归档;同时根据项目需要,对有关文档在项目文档服务器上发布。 2 .2 工作要求项目部目前使用 SVN 管理项目文档,建立相应文档目录,根据要求适时添
2、加文档并与相关人员(各专业组负责人)合作及时将文件归档,注意对项目信息的及时更新,以帮助各组人员获得最新信息。 2 .3工作程序 对于项目常规文档:1.综合组对文档(纸质和电子版)收集及文档分类。 32.各专业组负责人负责对项目每个阶段过程中产生的文档资料进行汇总,由负责人审核后将相关文档上传到 SVN 服务器相关目录(建立统一的项目文档目录,例如命名为“项目存档文档”)下。 3.项目进行每个阶段产生的各项文档资料包括:调研资料、设计方案文件/图、设计说明书、会议培训资料、汇报材料、报告文件、数据文档、文献等文档资料。对于项目存档文档:1. 综合组对项目常规文档目录下的文档进行审核。2. 对阶
3、段性重要的文件进行归档,文档管理员将其处理成 PDF 格式,加入文档编号后上传到 SVN 服务器相关目录下。注:各类存档文件均需提交由质量测试组审核。3 文档管理 3 .1总则 3.1.1 所有重要文档集中管理,维护档案的安全与完整。 3.1.2 所有存档文件根据需要归档。 3.1.3 各项目专业组人员在工作中形成的具有参考价值的文件、材料由个人或该组负责人整理后报文档管理人员存档。 3.1.4 所有人员均有承担按时提交文档的义务和职责。 3.1.5 由专人负责项目文档管理工作。 3 .2范围 3.2.1 项目准备阶段 4a. 与本项目有关的上级主管部门下达的规划和工作计划; b. 有关项目的
4、审批文件、合同书、专家建议; c.国内外相关情况考察报告和专题分析报告; d. 可行性方案及批复文件; e. 项目实施方案、计划,预算书等; 3 .2.2 项目研究实验阶段 a. 各种重要的原始记录; b. 各种实验、调研报告和数据; c.各种研究报告(包括系统的、专题的、分项的和阶段的); d. 设计文件; e. 重要的来往技术文件。 3.2.3 其它有关材料: a. 周报、月报以及阶段性简报; b. 项目例会会议记录和专题会议文件; c.同项目研究有直接关系的重要情报编译材料。 3 .3 内容 3.3.1 设计方案系统、子系统、硬件设备型号、软件代码等的各类设计策略和执行方案等; 3.3.
5、2 会议和培训文件包括会议记录、演示 PPT、阶段报告、培训材料等文档; 3.3.3 软件文档5软件设计书、使用说明、源代码(包括注释)及源代码说明等;3.3.4 数据文档数据标准、数据字典、编码说明等; 3.3.5 参考文献由项目部成员收集到的各种中英文参考文献。 3 .4 文档分类 3.4.1 文档分为纸质文档和电子文档两类。其中电子文档又分为项目常规文档和项目存档文档;3.4.2 存档文档的编号规则项目编号 +版本号 +类型序列号+年代编号; YJ01_05_应急管理系统项目计划_V1_20100719文档编号例如: YJ01-001-00-20100223 为目录编号;项目编号为:YJ
6、;文档版本号: 01 文档序列号为: 001;文档类型编号: 00;年代编号: 20100223; 3.4.3 文档类型编号规则场所子系统设计开发类文档: 00应急接入建设设计开发类文档: 01应急管理系统设计类文档: 026指挥场所建设实施类文档: 03应急接入实施类文档: 04 应急管理系统实施类文档: 05其他文档: 06 购进书籍: 07 其他(根据情况添加)3.4.4 文档的命名规则CNPC_YJ_05_应急管理系统项目计划_V1_20100719命名规则为:CNPC_YJ_类型_文件名_模块_版本号_日期.后缀名 其中“CNPC_YJ”列于所有文件名开始。CNPC_YJ 表示为中国
7、石油天然集团公司应急平台(E2)项目;类型文档类型名称,可使用文档类型编号(根据文档内容此部分可以省略);文件名为该文件的具体内容总称,文件名字数不限。模块用于区分各个项目小组编写的文档,分为ZH、CS、JR、XT,分别代表综合组、总部指挥场所组、应急接入组、应急管理系统组。(根据文档内容此部分可以省略);版本号用于追踪相同文件的修改记录,通常为两位。使用字符“V”表示版本,一位数字表示修改次数。数字从“1”开始以自然数顺序排列,用于记录文档变化。最终确定稿用字符“F”替代数字;日期为记录文件的编写日期,用 6 位日历日期表示,如:20097年 12 月 29 日,在文件名中表示为 09122
8、9。示例:CNPC_YJ_06_项目章程_ZH_V1_091229.docCNPC_YJ_06_通讯录_ZH_V2_091229.xlsCNPC_YJ_06_内部启动会议_ZH_V2_091229.pptCNPC_YJ_00_空调子系统设计_CS_V1_091229.xls其中,CNPC_YJ 为中国石油天然气集团公司应急平台(E2)项目;06 为文档类型编号;ZH/CS 为模块名称;V1/V2 为版本号;091229为日期编号。3 .5 存档规范 3.5.1 基线:事件发生后两周内归档。 3.5.2 完整性:是否成套、缺页和涂改; 3.5.3 准确性:所收集的材料是否同它反映的对象相一致,同
9、一项目的文件材料在内容上是否一致; 3.5.4 文件材料属性的鉴别:是否为同一类; 3.5.5 所有文档一月整理一次,按照不同类型刻盘或者其他存储介质进行保存; 3 .6 目录建设与管理 3.6.1 所建目录要求符合明确方便的原则; 3.6.2 查阅者能够迅速的查阅所要文档,了解文档简单的相关信息;83.6.3 文档用 FTP 文档服务器进行存储和管理; 3 .7 文档的提交、保存及使用 3.7.1 文档提交 (1)文档的提交时间根据具体规定执行,在规定时限内提交; (2)项目文档由文档作者提交,一般为 office 形式(要求使用 office2000 以上版本); 3.7.2 文档归档 (
10、1)归档的原则 a. 检查文件是否完整,如有短缺,应督促补充齐全; b. 文档资料移送交接手续必须完备; c.移交与保管文档无关的资料,要退回经办部门;d对废弃的与项目相关纸质文档,要使用碎纸机销毁。(2)存档格式 a. word 和 excel 文件可分为 office 文档和 pdf 文档两种。 b. 演示文档只保存 ppt 格式或 pdf 格式(视演示的具体格式确定)。 c.源数据和源代码文档由文档作者提供存档格式。 3.7.3 文档保存 (1)文档保存遵循的原则在项目进展各个阶段,按规定格式建立项目文档目录,标注文档的状态。文档保存可用页面和电子文档两种方式保存,所有文档9全部为受控文
11、档; a. 归档的文件材料,根据归档要求及文件内容特征进行归档; b. 按归档要求进行目录编辑及备查表; c.对文档作统一排列; (2)档案资料的整理 a. 收集的 word 和 excel 文档由文档管理人员处理成 pdf 的格式。b. 文档资料按文件项目编号次序整理; c.文档资料每周备份一次,如有文件损坏及时补充齐全; (3)文档密级管理 a. 在文档使用中有部分文档根据要求,需暂时保密,在此期间,由文档管理人员进行保存,不得对外发布。注:除非经文档作者授权同意,否则不得提前进行查看、使用或发布。 b. 此类文档保密到期,由文档作者和文档管理人员决定继续保存或进行发布。 3.7.4 文档
12、使用 (1)归档材料密级的鉴别: A 绝密:仅有文档作者和项目负责人对文档享有查阅及使用权,其他人员查阅需经文档作者和项目负责人同意; B 保密:仅在项目部成员内共享; C 公开:发布到集团或者项目部网站; 10(2)文档根据不同密级使用; a. 进度文档一般为 C 级,通过 FTP 文档服务器可实现完全共享。 b. 源代码为 A 级,缺省六个月绝密期,在源代码绝密期内,其可执行程序为 B 级,即项目内共享。 c.阶段性技术文档为 A 级,缺省三个月或由文档作者提供文档绝密时限(最长时限可至该项工作完成的截至日期); d. 绝密期后,阶段性技术文档密级由 A 级降为 B 级,在项目部范围内共享
13、;或根据项目需要,通过项目作者和项目小组协商实现共享;(3)项目部成员均可通过 SVN 服务器对上传后的文档资料进行查询。 (4)部分重要文档,如:重要技术文档、源代码等,需经过文档作者和项目领导同意并签字授权后方可使用。 (7)文档作者离开项目后,所提交文档的版权完全归属于项目部。 3.7.5 文档的借阅对于纸质存档文件,原件由综合组统一保管,需要借阅和查看的人员需向综合组文档管理人员提出申请,同意借阅后,由文档管理人员负责提供文档复印件并填写文件使用记录,任何人员不得随意复制文档资料,文件借阅使用完毕后应归回综合组文档管理人员。需要复制使用的需得到综合组负责人许可后方可自留使用。3.7.6 文档修改 (1)项目进展过程中,随着对项目进一步的深入,将会产成一些需要修正的文档,对文档的修改需经过综合组负责人的审核,方可进行。