软件开发文档指南:软件需求分析报告文档模板软件概要设计报告文档模板软件详细设计报告文档模板软件数据库设计报告文档模
3.1.2 需求分析报告的编制者
需求分析报告应由交通局和开发者双方共同完成。其中:交通局负责根据实际需要提出希望软件实现的功能;软件开发者根据交通局提出的性能需求,结合软件开发编写需求分析。 3.1.3 需求报告评审
在软件需求分析工作完成后,软件开发者应向交通局提交《软件需求分析报告》。交通局组织有关人员对需求进行评审,以决定软件需求是否完善和恰当。评审完成后,就可以进入软件的设计阶段。 3.1.4 需求报告格式
《软件需求分析报告》需按一定的格式进行编写,具体的《软件需求分析报告》文档编写模板请见附录A。
3.2 软件的概要设计
3.2.1 概要设计
在交通局和开发者双方认可的《需求分析报告》基础上,开发者进行下——步的工作。 首先,开发者需要对软件系统进行概要设计,即系统设计。概要设计需要对软件系统的设计 进行考虑,包括系统的基本处理流程、系统的组织结构、模块划分、功能分配、接口设计、 运行设计、数据结构设计和出错处理设计等,为软件的详细设计提供基础。 3.2.2 编写概要设计的要求
a.一致性
概要设计的要求应该与需求分析报告所描述的需求一致。同时,概要设计的各项要求之间也应该一致。
b.合理性
概要设计所提出的设计方法和标准应该是合理的、恰当的。 c.可追踪性
对概要设计所提出的各项要求应该可以得到它的清晰的源流,即在需求分析报告客户有明确的需求描述。
d.可行性
根据概要设计进行详细设计、操作和维护应该是可行的。 3.2.3 概要设计报告的编写者
概要设计报告由开发者根据需求分析报告的要求进行编写。 3.2.4 概要设计和需求分析、详细设计之间的关系和区别
需求分析不涉及具体的技术实现,而概要设计注重于从宏观上和框架上来描述采用何种技术手段、方法来实现这些需求。详细设计相对概要设计更注重于微观上和框架内的设计, 是编码的依据。概要设计是指导详细设计的依据。 3.2.5 概要设计的评审
在软件概要设计工作完成后,软件开发者应向交通提交《软件系统概要设计报告》。在交通局对《概要设计报告》评审通过后,即可进入详细设计阶段。 3.2.6 概要设计格式
《软件系统概要设计报告》需按一定的格式进行编写,具体的《软件系统概要设计报 告》文档编写模板请见附录B。