开发技术文档怎么写( 二 )


列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源 。2 。
任务概述 1)目标 。2)运行环境 。
3)条件与限制 。3 。
数据描述 1)静态数据 。2)动态数据 。
包括输入数据与输出数据 。3)数据库描述 。
给出使用数据库的名称和类型 。4)数据词典 。
5)数据采集 。4 。
功能需求 1)功能划分 。2)功能描述 。
5 。性能需求 1)数据精确度 。
2)时间特性 。如响应时间、更新时间、数据转换与传输时间、运行时间等 。
3)适应性 。如操作方式、运行环境、与其他软件的接口以及开发计划等发生变化时、应具有的适应能力 。
6 。运行需求 1)用户界面 。
如屏幕格式、报表格式、彩单格式、输入输出时间等 2)硬件接口 。3)软件接口 。
4)故障处理 。7 。
其他需求 如可使用性、安全保密、可维护性、可移植性等 。二、概要设计说明书 1 。
引言 1)编写目的:阐明保险需求说明书的目的,指明读者对象 。2)项目背景:包括 a 项目的委托单位、开发单位和主管部门 。
b 该软件系统与其他系统的关系 。3)定义:列出文档中所用到的专业术语的定义和缩写的原意 。
4)参考资料:列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源 。可包括 a 项目经核准的计划任务书、合同或上级机关的批文 。
b 项目开发计划 。c 需求规格说明书 。
d 测试计划(初稿)e 用户操作手册(初稿) 。f 文档所引用的资料、采用的标准和规范 。
2 。任务概述 1)目标 。
2)运行环境 。3)需求概述 。
4)条件与限制 。3 。
总体设计 1)处理流程 。2)总体结构和模块外部设计 。
3)功能分配 。表明各项功能与程序结构的关系 。
4 。接口设计 1)外部接口 。
包括用户接口、软件接口与硬件接口 。2)内部接口 。
模块之间的接口 。5 。
数据结构设计 1)逻辑结构设计 。2)物理结构设计 。
3)数据结构与程序的关系 。6 。
运行设计 1)运行模块的组合 。2)运行控制 。
3)运行时间 。7 。
出错处理设计 1)出错输出信息 。2)出错处理对策 。
如设置任务、性能将级、恢复及再启动等 。8 。
安全保密设计 9 。维护设计 应说明为方便维护工作的设施 。
如维护模块等 。三、详细设计说明书 1 。
引言 1)编写目的:阐明编写概要设计说明书的目的,指明读者对象 。2)项目背景:应包括项目的来源和主管部门等 。
3)定义:列出文档中使用到的专门术语和缩写词的愿意 。4)参考资料:列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源 。
可包括 a 项目经核准的计划任务书、合同或上级机关的批文 。b 项目开发计划 。
c 需求规格说明书 。d 测试计划(初稿)e 用户操作手册(初稿) 。
f 文档所引用的资料、采用的标准和规范 。2 。
总体设计 1)需求概述 2)软件结构:如给出软件系统的结构图 。3 。
程序描述 逐个给出模块的以下说明: 1)功能 。2)性能 。
3)输入项目 。4)输出项目 。
5)算法:模块所选用的算法 。6)程序逻辑:详细描述模块实现的算法 。
可采用:a.标准流程图 b.PDL语言 c.N-S图 d.PAD e.判定表与描述算法的图表 。7)接口 。
8)存储分配 。9)限制条件 。
10)测试要点:给出测试模块的主要测试要求 。
3. 网站开发文档怎么写 网站前期调查阶段