您的当前位置:首页正文

文档管理

来源:一二三四网
文档是软件项目开发应用的一部分,存在于软件项目的整个生命周期之中,没有正式文档的软件项目开发,就不是规范标准的软件项目。因此,我司针对本项目建立了一套完善的文档管理体系。项目进行到生命周期的哪一步,就向客户提供相应的文档。具体如下:

 项目开发立项报告

1. 概述:开发新系统的意义和新系统实现后的功能、技术指标、安全

和保密性、新系统运行环境等 2. 经费预测和经费来源 3. 项目进度和完成期限 4. 验收标准和方法 5. 移交的文档资料

6. 开始可行性研究的组织队伍、机构与预算 7. 其他需要说明的有关问题  可行性研究报告

1. 系统概述

2. 新系统的目标、要求和约束 3. 可行性研究的基本准则 4. 投资与效益分析

5. 其他可选方案及国内外同类方案的比较 6. 有关建议  项目开发计划报告

1. 概述:主要包括系统开发的主要目标、基本方针、参加人员、工作

阶段和内容等

2. 开发计划:系统开发各个工作阶段或者子项目的划分、任务、分工、

负责人、计划时间(开始及结束时间)、人力资源需求、资金及设备消耗、实际执行情况等

3. 验收标准:每项工作完成后验收的标准,包括时间、资金、质量等 4. 协调方法:项目开发中各个单位、阶段之间的衔接、协调方法、负

责人、权限等

 项目分析报告

1. 概述 2. 系统需求 3. 系统的目标与功能 4. 系统的逻辑模型 5. 系统的运行环境

6. 系统的验收标准与培训计划  项目设计报告

1. 系统概述 2. 系统总体结构 3. 计算机系统配置方案 4. 代码设计 5. 文件/数据库设计 6. 输入输出设计 7. 计算机处理过程设计 8. 接口及通信环境设计 9. 安全保密设计 10. 数据准备 11. 系统测试计划 12. 培训计划  程序设计报告

1. 概述 2. 程序结构图 3. 程序控制图 4. 算法 5. 程序流程图 6. 源程序 7. 程序注释及说明  项目测试报告

1. 概述:说明项目测试的目的 2. 测试环境 3. 测试内容 4. 测试方案 5. 测试结果

6. 结论:项目功能评价、性能技术指标评价、结论  项目使用与维护手册

1. 概述:主要包括系统功能、系统运行环境(软硬件环境)、系统安装

等内容

2. 使用说明:系统操作使用说明较为详细的说明操作的目的、过程、

方式、输入输出的数据等。

3. 问题解释:解释系统使用中可能出现的问题及解决方法  项目评价报告

1. 概述 2. 系统构成

3. 系统达到设计目标的情况

4. 系统的可靠性、安全性、保密性、可维护性等状况 5. 系统的经济效益与社会效益的评价 6. 总结性评价  项目开发总结报告

1. 概述:包括项目的提供者、开发者、用户;项目开发的主要依据;

项目开发的目的;项目开发的可行性分析等

2. 项目的完成情况:包括项目构成与主要功能;项目性能与技术指标;

计划与实际进度对比;费用预算与实际费用的对比等

3. 项目评价:项目的主要特点;采用的技术方法与评价;项目工作效

率与质量;存在的问题与原因;用户的评价与反馈意见 4. 项目开发过程中的经验与教训;对今后工作的建议 文档编制要求:

1. 标准化:从需求分析开始到投产应用所有涉及的每一种文档,都有一个

可以执行的模板,所有完成的文档从里到外都非常工整,具有专业水准,符合ISO9000及CMM质量标准要求。

2. 易用性:便于不同的岗位人员进行阅读、理解、学习和使用。 3. 针对性:文档按不同的类型、面对不同的对象,实行差异化编制,根据

实际需要进行编写。

4. 一致性:文档的行文确切,对于同一现象的描写,不能出现多义性的描

述,同一项目中几个文档描述的内容应当是一致的,相互之间没有矛盾。 5. 完整性:任何一个文档都是完整的、独立的,没有遗漏和丢失的内容。

也就是说每一种文档在设计时可以包含必要的图形、模型、叙述、表、索引、附录和参考文献,列举的这些内容都是完整的。

6. 可追溯性:在软件项目的开发过程中,各个阶段编制的文档不是孤立的,

而是与各个阶段完成的工作有密切的关系,随着项目开发工作的进展,具有一定的继承关系,体现出可追溯的特性。 文档的审核:

文档编制过程如下所示:

检查编写的项目文档是否齐全有无遗漏,是否符合文档的规范要求,内容描写是否正确紧扣主题,列出的图表信息是否准确,以确保文档的质量。审核要花费一定的人力和时间,但效果是显著的。通过对文档进行全面的审核、充分的测试,有效地发现文档中存在的问题,如遗漏的需求、多余的功能设计内容、不切实际的测试计划、不可行的测试方案、不充分的测试案例和不合格的操作手册等,

提前发现问题、改正问题。

因篇幅问题不能全部显示,请点此查看更多更全内容

Top