CSCI详细设计说明书模板

目录1.引言 (2)1.1.模板说明 (2)1.2.编写目的 (2)1.3.背景 (2)1.4.参考资料 (2)1.5.术语定义及说明 (2)2.设计概述 (3)2.1.运行环境概述 (3)2.2.条件与限制 (3)2.3.详细设计方法和工具 (3)3.系统详细设计 (3)3.1.系统结构设计及子系统划分 (3)3.2.系统功能模块详细设计 (3)3.3.接口详细设计 (4)3.3.1.外部接口设计 (4)3.3.2.内部接口设计 (4)3.4.用户界面设计 (4)4.数据库系统设计 (4)4.1.设计依据 (4)4.2.数据库逻辑结构 (5)4.3.物理结构设计 (5)4.4.数据库安全 (5)4.5.数据字典 (5)5.系统配置 (5)5.1.配置原则 (5)5.2.硬件配置 (5)5.3.软件配置 (6)6.测试与文档建议 (6)6.1.测试重点 (6)6.2.文档建议 (6)7.关键技术 (6)7.1.关键技术的提出 (6)7.2.关键技术的一般说明 (6)7.3.关键技术的实现方案 (6)1. 引言1.1. 模板说明[该模板主要目的是引导组员如何进行概要设计：一般概要设计应该包括什么方面的内容，并对这些内容起到的作用进行详细说明。

组员在进行实际的应用中，可以根据情况进行裁减，不应被该模板束缚，建议至少保留第1、2、3、6章节内容。

在该文档编写完成后记得删除1.1内容。

]1.2. 编写目的[说明编写详细设计方案的主要目的。

详细设计的主要任务是对概要设计方案做完善和细化。

说明书编制的目的是说明一个软件系统各个层次中的每个程序（每个模块或子程序）和数据库系统的设计考虑，为程序员编码提供依据。

如果一个软件系统比较简单，层次很少，本文件可以不单独编写，和概要设计说明书中不重复部分合并编写。

方案重点是模块的执行流程和数据库系统详细设计的描述。

]1.3. 背景[应包含以下几个方面的内容：待开发软件系统名称；该系统基本概念，如该系统的类型、从属地位等；开发项目组名称；项目代号（项目规划所采用的代号）；说明遵从的IT标准和原则，符合公司的IT ABBs。

XXX项目详细设计说明书（V1.0）修改记录目录1 引言 (1)1.1编写目的 (1)1.2背景 (1)1.3定义 (1)1.4参考资料 (1)2 业务总体描述 (1)2.1软件功能描述 (1)3 模块一设计 (1)3.1时序图 (1)3.2功能描述 (2)3.3功能实现规则 (2)3.4算法 (2)3.5数据结构 (2)3.6用户界面 (2)4 模块二设计 (2)4.1时序图 (2)4.2功能描述 (3)4.3功能实现规则 (3)4.4算法 (3)4.5数据结构 (3)4.6用户界面 (3)5 非功能性设计 (3)1引言1.1编写目的说明编写这份详细设计说明书的目的，指出预期的读者。

1.2背景说明：a)需开发的软件系统的名称；b)列出此项目的任务提出者、开发者、用户以及将运行该软件的计算环境。

1.3定义列出本文件中用到的专门术语的定义和外文首字母组词的原词组。

1.4参考资料列出有关的参考资料，如：a)本项目经核准的计划任务书或合同、上级机关的批文；b)属于本项目的其他已发表的文件；c)本文件中各处引用的文件、资料、包括所要用到的软件开发标准。

d)列出这些文件资料的标题、文件编号、发表日期和出版单位，说明能够得到这些文件资料的来源。

2业务总体描述2.1软件功能描述描述被开发软件的功能，如有同等作用的文件（如已编写的《软件功能规格说明书》）则可直接在此引述该文件名及归档的部门即可。

3模块一设计3.1时序图简述各模块的功能。

列明不同角色之间的使用，需要说明权限分配；比如不同用户可以使用特定的菜单功能；应体现各个模块之间的关联关系，时序图，有业务关系的功能模块可3.2功能描述包括：a)说明本模块的输入/输出参数（命名标识）和调用方式b)说明与本模块相直接关联的数据结构（数据库、表文件）。

3.3功能实现规则说明对各模块的业务。

3.4算法详细说明本程序所选用的算法，具体的计算机公式和计算步骤。

3.5数据结构反映数据元素之间的逻辑关系的数据结构3.6用户界面界面设计，可使用visio中的Windows User Interface制作，但应预先由分析人员与编程人员共同确定统一风格。

文档作者：文档呈送：文档抄送：XX项目详细设计说明书<VX.Y>编写：审核：批准：参与评审：变更记录版本号变化状态修改点说明变更人存放位置审批人审批日期*变化状态：C――创建，A——增加，M——修改，D——删除修改点说明：对变化状态进行简单解释，如增加了某项功能，修改了某个模块等信息。

不允许出现“根据评审意见修改等字样”注：当文档未评审通过前版本号标识规则为V0.X ,第一次评审通过后，版本号直接升级为V1.0，之后变更按照V1.X升级。

目录1前提和约束 (4)编写目的 (4)预期读者和阅读建议 (4)定义、缩写词、略语 (4)参考资料 (5)2前提和约束 (6)前提条件 (6)限制和约束 (6)3综合描述 (6)3.1系统目标 (6)3.2系统需求 (6)3.3系统概述 (7)3.4程序结构说明 (7)3.5源程序及编译链接组装说明 (7)4系统详细设计 (7)4.1XXX子系统名称 (8)4.1.1XXX包名称 (9)4.2XXX子系统名称2 (10)5用户界面详细设计（可裁剪） (10)5.1界面结构 (11)5.1.1界面结构或菜单结构 (11)5.1.2用户界面图（如无此需要，可省略） (11)5.2界面处理流程及界面约束描述（如无此需要，可省略）错误!未定义书签。

5.2.1界面或模块名1................................................. 错误!未定义书签。

5.2.2处理流程............................................................ 错误!未定义书签。

5.2.3界面约束与事件约束........................................ 错误!未定义书签。

5.2.4触发方式 (12)5.2.5界面或模块名2................................................. 错误!未定义书签。

**有限公司{公司名＋项目名}详细设计说明书当前版本：发布日期：摘要简要描述该文档的内容。

修改历史目录1概述 (4)2结构图 (4)3数据结构 (4)4功能模块详细描述 (4)5需求以及设计跟踪表 (4)1概述本章描述详细设计将实现的内容，以及受影响的子系统。

假如用了软件图形工具，本章必须包含完整的软件图形模块目录的路径名。

2结构图软件系统功能模块的图形描述，它可以让读者对功能模块有一个全面的了解。

同时，它也提供了一个有用的索引及一个有意义的调试和维护指南。

数据必须显示在结构图中，同时，流程线应指明模块访问存储区的目的（读、写或修改）。

必须解释所有的用符号表示的内容（包括模块、参数和数据存储区等）。

3数据结构•如果某一数据类型由其它的数据类型组成，要保持信息上的一致性。

•如果使用一特殊结构，请指明使用原因或优于其它结构的方面。

•在选择一个有效的结构时，要考虑以下几个方面：-- 在目标上执行的操作类型-- 访问目标的类型和频度-- 结构的有效性4功能模块详细描述首先请简要介绍模块的目的。

可以用以下格式描述功能模块的详细设计：•模块名称•主要功能描述•模块的输入参数的名称、数据类型、顺序位置、格式等•模块的输出参数的名称、数据类型、顺序位置、格式，以及错误标记等•过程和功能调用•数据引用（全局，本地，结构）•模块的处理流程（采用流程图、判定表辅以必要的说明来表示逻辑流程）•模块的界面设计（可以采用图片和表格的形式，具体内容包括：界面格式；界面要素的位置、类型和特殊约定；操作及步骤等必要的说明）•接口（用图的形式说明本程序所隶属的上一层模块及隶属本模块的下一层模块，说明参数赋值和调用方式，说明与本程序直接关联的数据结构）•限制条件（说明本模块运行所受到的限制条件）•伪代码5需求以及设计跟踪表。