引言
前言、序言或概要常用作科技论文的开端,提出本文要研究的问题,让读者全文阅读和理解
写目的
帮助开发人员理解项目的业务逻辑
用语说明
运行标准和相关文档
编码标准、文件管理标准、版本控制标准
项目概述
1、背景
2、现状
项目目标
应最终实现的目标
编码规格
前端规格、后台规格、数据库规格、中间件使用规格
系统功能概述
系统功能概述
系统概述
说明系统的整体情况
系统模块化设计
模块结构图、模块汇总表、功能概要
模块的功能点
【功能说明】说明该程序应具有的功能、功能结构图、原型界面。 可以采用IPO图、类图、用例图等。 】
1、输入项目
【给出各输入项的特性,如名称、标识、数据类型和格式、数据值的有效范围、输入方法等。 数量和频率、输入介质、输入数据的来源和安全条件等。 】
2、输出项目
【给出每个输出项的特性,包括名称、徽标、数据类型和格式、数据值的有效范围、输出格式、数量和频率、输出介质、输出图形和符号说明、安全条件等。 】
3、算法
【详细说明本程序选择的算法、具体计算公式和计算步骤。 】
4、逻辑流程
【图表(例如流程图、判定表等)中添加必要的说明表示本程序的逻辑流程。 】
5、接口
【用图形说明本程序所属的上级模块、本程序所属的下级模块、子程序,说明参数赋值和调用方式,说明与本程序直接相关的数据结构。 】
6、存储分配
【根据需要说明本程序的存储分配。 】
7、评论设计
【说明本程序计划安排的评论。 示例:
a .附在模块开头的评论
b .对各分支的评论
c .对各变量功能、范围、默认条件等的注释
d .对所用逻辑的评论等。 】
8、限制条件
【说明本程序执行中受到的限制条件】
9、测试计划
【说明针对本程序的单体测试计划。 包括对测试的技术要求、输入数据、预期结果、时间表、人员职责、设备条件驱动程序及存根等规定】