项目文档说明书(Java项目开发文档之一)
注:文档模版的使用顺序为从上到下排列
需求分析文件夹
用户需求说明书:用来征集、整理用户需求。该文档将指导整个项目的开发方向,并以此为项目最终的主要验收标准。
系统设计文件夹:
概要设计报告:参照“用户需求说明书”进行系统概要设计。
用户界面设计报告:参照“用户需求说明书”和“概要设计报告”进行用户界面设计。
数据库设计报告:参照“用户需求说明书”和“概要设计报告”进行数据库设计。
详细设计说明书:综合以上文档资料及系统分析结果,出详细设计说明。
项目规划文件夹:
项目预算表:结合“用户需求说明书”和“详细设计说明书”做详细项目预算,最大可能精确。
项目计划:结合“用户需求说明书”和“详细设计说明书”、“项目预算表”做项目整体计划, 出开发计划和进度控制计划。
编码与测试文件夹:
实现与测试计划:制定编码阶段的所有相关计划,包括:人员与角色、编程计划、代码审查计划、单元测试计划、集成测试计划、缺陷管理与改错计划、开发小组技能培训计划。为整个编码阶段制定完整严密的实施计划。
编程日志文档:开发人员根据“编程计划”编写软件的代码,并随时记录编程技术、问题与对策、心得体会等等,产生《编程文档》(类似于编程日记)。
项目监控子文件夹:
项目进展日报表:项目组每日填写其工作进度、完成情况、出现问题,按时提交。
项目进展周报表: 项目组每周填写其一周工作进度、完成情况、出现问题、资源消耗,按时提交。
项目偏差控制报表:记录项目计划实现过程中与计划出现的偏差,及原因、是否采取措施纠正,和最终结果。
项目计划变更控制报告:记录因各种原因,导致项目计划出现变更,记录其原因和处理等具体信息。
需求管理文件夹:
需求跟踪报告:记录开发的代码和需求文档之间的对应关系,时刻跟踪开发和需求之间出现的偏差,找出、分析具体原因。
需求变更控制报告:当实际需求出现变更情况时,对需求变更进行记录和处理,如果导致项目计划出现变更,还要填写“项目计划变更控制报告”。
技术预研文件夹:
技术预研计划:针对项目中将要用到的技术进行分析、对比、学习和研讨,制定相应计划。
技术预研报告:在每次技术预研会议中对全程进行记录,出此报告。
系统测试文件夹:
系统测试计划:制订项目的整体测试计划,安排测试任务。
测试用例:针对每一单元,制定完整测试用例。
测试报告:对每一单元的测试结果进行详细记录。
用户手册文件夹:
用户手册:对整体软件进行使用和技术上的详细使用说明。
客户验收文件夹:
客户验收计划:制订客户最终验收项目的计划。
客户验收报告:根据客户最终验收结果,出此报告。