程序开发文档怎么写( 二 )


总体设计 1)需求概述 2)软件结构:如给出软件系统的结构图 。3 。
程序描述 逐个给出模块的以下说明: 1)功能 。2)性能 。
3)输入项目 。4)输出项目 。
5)算法:模块所选用的算法 。6)程序逻辑:详细描述模块实现的算法 。
可采用:a.标准流程图 b.PDL语言 c.N-S图 d.PAD e.判定表与描述算法的图表 。7)接口 。
8)存储分配 。9)限制条件 。
10)测试要点:给出测试模块的主要测试要求 。
2. 软件开发文档应该如何写 模块开发卷宗(GB8567——88)
1标题
软件系统名称和标识符
模块名称和标识符(如果本卷宗包含多于一个的模块 , 则用这组模块的功能标识代替模块名)
程序编制员签名
卷宗的修改文本序号
修改完成日期
卷宗序号(说明本卷宗在整个卷宗中的序号)
编排日期(说明整个卷宗最近的一次编排日期)
2模块开发情况表
3功能说明
扼要说明本模块(或本组模块)的功能 , 主要是输入、要求的处理、输出 。可以从系统设计说明书中摘录 。同时列出在软件需求说明书中对这些功能的说明的章、条、款 。
4设计说明
说明本模块(或本组模块)的设计考虑 , 包括:
a. 在系统设计说明书中有关对本模块(或本组模块)设计考虑的叙述 , 包括本模块在软件系统中所处的层次 , 它同其他模块的接口;
b. 在程序设计说明书中有关对本模块(或本组模块)的设计考虑 , 包括本模块的算法、处理流程、牵涉到的数据文卷设计限制、驱动方式和出错信息等;
c. 在编制目前已通过全部测试的源代码时实际使用的设计考虑 。
5原代码清单
要给出所产生的本模块(或本组模块)的第一份无语法错的源代码清单以及已通过全部测试的当前有效的源代码清单 。
6测试说明
说明直接要经过本模块(或本组模块)的每一项测试 , 包括这些测试各自的标识符和编号、进行这些测试的目的、所用的配置和输入、预期的输出及实际的输出 。
7复审的结论
把实际测试的结果 , 同软件需求说明书、系统设计说明书、程序设计说明书中规定的要求进行比较和给出结论 。
3. 软件开发中详细设计文档怎么写 原发布者:阳阳1A
QR-RD-022(Ver1.2)XXX系统详细设计说明书(内部资料请勿外传)XX公司版权所有不得复制文档变更记录1.引言1.1编写目的和范围说明写这份详细设计说明书的目的 。本详细设计说明书编写的目的是说明程序模块的设计考虑 , 包括程序描述、输入/输出、算法和流程逻辑等 , 为软件编程和系统维护提供基础 。本说明书的预期读者为系统设计人员、软件开发人员、软件测试人员和项目评审人员 。1.2术语表定义系统或产品中涉及的重要术语 , 为读者在阅读文档时提供必要的参考信息 。1.3参考资料列出有关资料的名称、作者、文件编号或版本等 。参考资料包括:a.需求说明书、架构设计说明书等;b.本项目的其他已发表的文件;c.引用文件、资料、软件开发标准等 。1.4使用的文字处理和绘图工具文字处理软件:wordoffice绘图工具:Visio2.全局数据结构说明本章说明本程序系统中使用的全局数据常量、变量和数据结构 。2.1常量staticStringSERVER_ADDRESS服务器地址booleanloginFlag登录状态2.2变量BlueUserInfo 用户账户结构体2.3数据结构包括数据结构名称 , 功能说明 , 具体数据结构说明(定义、注释、取值)等 。3.模块设计3.1用例图3.2功能设计说明3.2.1登录模块模块1主要分为以下几个子模块:子模块1、子模块2和子模块N 。3.2.1.1设计图