软件开发项目管理规范.pdf

### 软件开发项目管理规范之项目存档管理 #### 一、引言 随着软件项目的增多，项目管理中的文档管理和版本控制变得尤为重要。合理的文档管理不仅能提高工作效率，还能确保项目的可追溯性和团队协作的一致性。本文将详细介绍一种项目文档管理方法，并结合实例进行说明。 #### 二、项目文档管理的重要性 在软件开发过程中，项目文档包含了项目的各个方面，如源代码、需求文档、设计文档、测试文档等。良好的文档管理有助于： - **提高工作效率**：快速定位到所需文档，减少重复劳动。 - **保障项目质量**：确保文档的完整性和准确性，支持质量控制。 - **促进团队协作**：使团队成员能够共享信息，协同工作。 - **维护项目历史**：保留项目演变的历史记录，便于后期回顾和审计。 #### 三、项目文档管理实践 为了实现高效的文档管理，本节将详细介绍一种实用的项目文档组织方法。 1. **选择存储位置** - **避免操作系统盘**: 由于项目文档频繁更新可能产生大量硬盘碎片，建议不要将项目文档与操作系统同盘，以免影响系统性能。 - **统一存储盘符**: 多人合作时，建议统一将项目文档存放在指定盘符，例如 D 盘，以保持开发环境的一致性。 2. **创建公司级目录结构** - **建立公司名称目录**: 在项目存储盘创建一个以公司名称命名的顶级目录，用于存放所有项目文档及相关资料。 - **项目文档与公司文档分离**: 在公司名称目录下创建 `Project` 和 `Document` 文件夹，分别用于存放项目文档和公司级别的文档资料。 - **设置辅助目录**: 可以进一步创建 `Library` 和 `Resource` 文件夹，分别用于存放公共库文件和公共资源文件。 3. **项目级别的目录结构** - **具体项目目录**: 每个具体项目在其所属的 `Project` 文件夹下创建一个子目录，例如 `CRM` 代表客户关系管理系统项目。 - **细化项目文档分类**: 在具体项目目录下创建 `Backup`、`Document`、`Source`、`Help`、`Database`、`Release` 和 `Version` 等子目录，以实现对项目文档的有效分类和管理。 4. **版本控制管理系统的应用** - **推荐使用版本控制系统**: 为了更好地管理和维护项目文档，建议引入版本控制系统，如 VSS 或 CVS。 - **保持目录一致性**: 版本控制系统中的目录结构应与个人或团队的实际目录结构保持一致，便于日常维护和使用。 #### 四、具体项目存档管理示例 假设我们使用的是 D 盘作为项目文档的存储位置，并且公司名称为 TorrenSoft，则目录结构示例如下： - **D:\TorrenSoft**: 以公司名称作为所有项目的总目录。 - **Document**: 存放项目开发、程序开发、数据库设计、文档设计等开发规范，以及公司制度等。 - **Library**: 存放所有项目的公共库，如 PBLib、JavaLib 等。 - **Resource**: 公司的公共资源文件，也包括所有项目公用的资源文件，如位图、光标、声音等。 - **Project**: 所有项目的主目录，以下存放各个具体的项目。 - **CRM**: 客户关系管理系统项目。 - **RoadGIS**: 公路 GIS 管理系统项目。 - **FlexOA**: OA 系统项目。 - **Document**: 存放此项目的一些文档，如需求分析报告、系统流程图、总体设计等。 - **Backup**: 存放项目的文件备份，如旧的版本。 - **Source**: 存放此项目的源代码。 - **Version**: 存放此项目的各种不同版本的文件。 - **Help**: 存放此项目的帮助文档和操作手册等。 - **Test**: 存放此项目的测试文档和测试文件。 - **Database**: 存放此项目的数据库、表结构、SQL 语句等。 - **Release**: 存放此项目的发布版本。 #### 五、总结 通过上述项目文档管理方法的应用，不仅可以提高项目文档的管理水平，还能有效提升团队协作效率。此外，引入版本控制系统可以更好地支持文档版本管理和团队协作，从而确保项目的顺利进行。希望这些经验和建议能帮助大家在实际工作中更好地管理和利用项目文档。