1 系统环境
开发平台介绍
IDE及版本介绍
系统环境介绍
操作系统、版本、配置
运行环境介绍
web容器、配置
数据库介绍
名称、版本、工具介绍、配置
插件介绍
名称、版本、环境要求、来源、使用介绍若有使用原版介绍作为文档附件
版本控制
版本控制方式、项目名称、服务器地址、使用说明 2 关键技术
说明系统采用的技术关键、技术升级方向、存在的技术风险、对技术方案的总体评价等等。
3 总体设计
体系结构
说明系统采用的体系架构（尽量用图示来辅助描述）。
主要功能
说明本系统实现的主要功能。
模块接口
各模块间接口所用到的数据接口（为其他的人提供的接口和需要使用的别人的接口）
3.3.1 提供的接口描述 3.3.2 使用接口描述 处理流程
说明本系统的主要处理流程（尽量用图示来辅助描述）。
4 数据结构设计
数据词典设计
写出包名及各个类的类名，及数据库的命名规则。
如果是面向对象写类间关系，若非面向对象写数据库命设计等。
给出本系统内所使用的每个数据结构、数据项的名称及它们之间的层次关系。
数据库设计
给出数据库名称、数据库表的设计、各表之间的关系、索引的设计等。
5 模块设计
说明各模块的设计考虑。每个模块的具体描述包括以下内容：
模块描述
说明该模块的主要功能、特点、逻辑流程。可采用“输入——处理——输出”的形式描述（尽量用图示来辅助描述）。
主要算法
说明该模块选用的算法，包括计算公式、计算步骤等。
主要方法或函数的设计
包括实现功能、名称、返回值、参数说明、与其它方法或函数的调用关系等。
主要界面的设计
描述与该模块相关的主要界面的设计及之间的跳转关系,各模块间传递的参数
6业务流程设计
包含完整的流程图
7 开发计划说明
