开发功能文档规范

《开发功能文档规范》由会员上传分享，免费在线阅读，更多相关内容在行业资料-天天文库。

1、1系统环境1.1开发平台介绍IDE及版本介绍1.2系统环境介绍操作系统、版本、配置1.3运行环境介绍web容器、配置1.4数据库介绍名称、版本、工具介绍、配置1.5插件介绍名称、版本、环境要求、来源、使用介绍若有使用原版介绍作为文档附件1.6版本控制版本控制方式、项目名称、服务器地址、使用说明2关键技术说明系统采用的技术关键、技术升级方向、存在的技术风险、对技术方案的总体评价等等。3总体设计3.1体系结构说明系统采用的体系架构（尽量用图示来辅助描述）。3.2主要功能说明本系统实现的主要功能。3.3模块接口各模块间接口所用到的数据接口（为其他的

2、人提供的接口和需要使用的别人的接口）3.3.1提供的接口描述3.3.2使用接口描述3.4处理流程　　说明本系统的主要处理流程（尽量用图示来辅助描述）。4数据结构设计4.1数据词典设计写出包名及各个类的类名，及数据库的命名规则。如果是面向对象写类间关系，若非面向对象写数据库命设计等。给出本系统内所使用的每个数据结构、数据项的名称及它们之间的层次关系。4.2数据库设计给出数据库名称、数据库表的设计、各表之间的关系、索引的设计等。5模块设计说明各模块的设计考虑。每个模块的具体描述包括以下内容：5.1模块描述说明该模块的主要功能、特点、逻辑流程。可采

3、用“输入——处理——输出”的形式描述（尽量用图示来辅助描述）。5.2主要算法说明该模块选用的算法，包括计算公式、计算步骤等。5.3主要方法或函数的设计包括实现功能、名称、返回值、参数说明、与其它方法或函数的调用关系等。5.4主要界面的设计描述与该模块相关的主要界面的设计及之间的跳转关系,各模块间传递的参数6业务流程设计包含完整的流程图7开发计划说明