软件项目文档管理与版本控制的初步报告

1、软件项目文档管理与版本控制的初步 报告、现阶段的问题：版本与文档管理中常 见或可能存在的现象：Item 1.项目的逻辑结构不严谨Item 2.多人修改同一个文件Item 3.用户权限混乱或无权限控制Item 4.上传文档的命名随意Item 5.从服务器上获取最近版本时的疏忽二、文档与版本管理衡量 标准：效率与质量（软件的一致性、冗余程度等）三、解决方向：1、项目文档、文件夹结构化分类管理2、文档命名规范化3、操作权限控制4、注意服务器唯一有效版本本地 备份辅助四、初步解决办法创建文档储存库基于工具的资料库或是一个共享目录里建立的简单的“文件羽文 件”结构。1、管理范围：开发库、项目文档、产品库

2、、构建库1）开发库包括：A、源代码B、执行程序2）文档管理：A、项目文档包括一一可行性研究 报告（愿景）项目开发计划（立项）需求 （说明书）评审软件设计说明书开发进度月报测试相关开发文档参考资料文档模板用 户（操作）手册项目开发总结报告B、相关设备C、参考资料（开发人员与客户会谈的材料参考文献项目结束归档时电子邮件3）产品库2、建立规范的目录体系项目二源码项冃三源码项目一源码项目文档管理(docs)可行性研究报告（愿景）项目开发计划（立项）项目需求（说明书）文档模板用户（操作）手册项目项目开发总结报告相关开发文档参考资料3、版本与文档命名规则1 ）版本V1.0至版本V2.0之间可少设过渡版本变

3、更量积累之一定量或阶段之后再 进行版本变更。对于计划性文档、技术文档和用户文档其版本按修改的先后 顺序确定新生 成的文档第一次发行是第一版修改后第二次 发行是第二版以此类推。2）建立规范的文档与版本命名规则文档控制级别为中、低的文档是不需要进行版本 控制的这些文档大都是临时性的、一次性的、中 间性的文档比如：需求 调研报告会议纪 要项目报告等。文档 控制级别为高的文档要进行版本控制。如：用 户需求说明书概要设计 说明书用户手册等无论修改有多少次都要求留版本 记录尤其是项目产品。 控制级别高的文档命名：项目编号文档名与版本号_日期_作者女口SPMS_需求说明书V1.0_YYMMDD_ 李明 控制

4、级别为中、低的文档命名：项目编号_文档名_日期_作者如SPMS_第六周问题报告_YY MMDD_李明3） 最终完成的软件版本用二位符号表示：“s.xy义如下含 “ y ”为第二次版本号表示 纠正错误时的版本升级用一位数字表示：“-9 1对上一次产品或项目的缺陷做修正第二次版本号增加； “ x ”为第一次版本号表示增加功能 时的版本升级用一位数字表示：“ 1-9 ” 与上一产品或项目相比功能进行了小量的增加或修正 时第一次版本号增加第二次 版本号为零第二版本号为零时可以省略不写； “s ”为主版本号用一位数字表示：“1-9” 对产品作重大调整或与已发行的上一产品相比在功能与性能上有 较大改善时主

5、版本号增加次版本号 为零产品或项目 概念全新第一次完成版本号 为1.0。4、人员职责与维护、更新文档管理的人员可以由一个或多个 团队成员兼职担任有经验最好职责包括： 建立、管理和执行文档标准并监控它们的状态；确认并解决文档库中存在的问题；确定对哪些文件进行存档或对哪些旧文件（如每周的状 态情况报告在三个月以后可能 就会作废）进行定期、阶段性的清理；创建资料库的访问规则、权限；定期对资料库进行检查并对文档管理流程进行评估应当确保文档管理流程工作正 常而且符合公司、项目组和利益相关方的需求；5、关于项目开发与测试等其他人员，同样需要注意文档提交、更新、 维护等的规 范建议如下：1）开发和测试人员在

6、提交相关文档后自己 应有备份。2） 软件开发和测试人员可根据工作需要在自己手中保存一些个人文档。这些一般应是主文本的副本并注意和提交的主文本保持一致在作必要的修改时也应及时通知文档管理人员3）在新文档取代旧文档 时管理人员应及时清理旧文档。在文档内容有改 动时管 理人员应随时修订主文本使其及 时反映更新了的内容。4）项目开发结束时文档管理人员应及时收集开发和测试人员的个人文档。发现个 人文档与主文本有差别 时应立即着手解决。这常常是未及时修订主文本造成的。5）在软件开发过程中可能发现需要修改已完成的文档特别是 规模较大的项目 主文本的修改必须特别谨慎。修改以前要充分估 计可能带来的影响并且要按

7、照：提议、评 议、审核、批准和实施等的步骤加以严格控制。其他建议：1 ）版本控制管理可包括工具 软件的使用和人为规范的遵循一一有控制意 识、对工 具的熟练使用认为的良好习惯和规范的制度的保证。2 ）版本控制管理员一一设置一人或数人兼 顾此角色没必要是全 职保证安全性 问题控制认为任意操作。3）向版本控制过渡时一个循序渐进的、持久的过程一一需要逐步转变制订一系 列的循序渐进的措施使版本控制的意 识逐步得到认可使人员逐渐养成良好习惯。4）分为开发库、文档库、产品库、构建库这四个库分别是独立的单库版本不 相互影响。开发库下项目一的相对路径为：/dev/prol 在prol下为该项目的具体源 码结构树；文档库下项目一的相对路径为：/doc/pro1 在prol下为该项目的文档树结构（包括且不限于 项目立项、项目结项、项目计划、项目监控、风险管理、配置管理） 相应的文档 放入到相应的文件夹中；构建库下项目一的相对路径为:/db/pro1在prol下为该项目不同时期的构建版本（格式：项目缩写_阶段_