详细设计说明书.docx
《详细设计说明书.docx》由会员分享,可在线阅读,更多相关《详细设计说明书.docx(3页珍藏版)》请在冰豆网上搜索。
![详细设计说明书.docx](https://file1.bdocx.com/fileroot1/2023-1/27/01b79586-1625-4c48-b063-e968fe50c61e/01b79586-1625-4c48-b063-e968fe50c61e1.gif)
详细设计说明书
密级:
内部公开
文档编号:
xx_SD_REGU_XXSJSMS
版本号:
V1.0
详细设计说明书
xx有限公司
编制:
xx
生效日期:
审核:
xx
批准:
-----------------------------------------------------------------
xx公司对本文件资料享受著作权及其它专属权利,未经书面许可,不得将该等文件资料(其全部或任何部分)披露予任何第三方,或进行修改后使用。
文件更改摘要:
日期
版本号
修订说明
修订人
审核人
批准人
1引言
1.1编写目的
依照需求规格说明书和概要设计说明书,在本文档中详尽说明软件的详细设计,包括修正或者发行版本号,以便于编程。
如果这个软件详细设计只与整个系统的一部分有关系,那么只叙述文档中说明的部分或子系统。
为系统编码提供依据。
1.2术语定义
列出本文件中用到的专门术语的定义和外文首字母组词的原词组。
2综合描述
2.1程序结构说明
最终的程序分布图及说明(可执行程序、自己开发的动态链接库、自己开发的静态链接库、数据配置文件、资源文件等最终程序包中包含的程序文件,并非源程序结构)、结构图及功能与调用关系简要说明、程序种类说明。
本节为以下详细设计的简要索引,为系统程序的上层结构体系描述。
详细设计时可能得不到精确的最终程序文件名列表,但是应当尽量完整说明其种类和主要文件内容,在程序编码结束前应将本节补齐,如果在开发过程中设计发生变化,本节也应当做相应变更。
2.2源程序及编译链接组装说明
本处为源程序和前一节的最终程序如函数库、可执行程序、资源文件等的对照表,以及从源程序文件转化成这些最终文件的具体过程(编译、链接、组装)描述。
在详细设计时可能得不到精确的源程序文件名,但是应当尽量完整说明其种类和主要文件内容,在程序编码结束前应将本节补齐,如果在开发过程中设计发生变化,本节也应当做相应变更。
如果不同的文件具有不同的编译链接组装方式,则应在此处分别描述清楚。
在此处应明确分出各级编译单元,即哪些文件需要一起编译生成一个或一组编译后的文件。
编译单元文件可以是最终文件也可以是源程序和最终文件之间的中间文件。
因为源程序结构以及编译链接组装方式可能在程序开发后期才能定出,本节可以独立成册,但须与前一节保持一致。
本处应注明参见哪个文件。
3系统详细设计
系统详细设计应当以最终的物理功能实现为主线索,源程序的结构作为辅线索。
如:
在说明公共函数所在的动态链接库时,如果动态链接库只有一个,而对应的源程序有三个,应当先在下面某节描述本动态链接库,说明动态链接库的详细设计,然后在动态链接库的详细设计中说明它的源程序构成,并列出源程序与函数的对照表。
如果某一源程序仅包含公共变量或约定等信息,而且这些内容已经在其它地方说明,则此处也应注明,作为索引。
在本节的下一层描述函数详细设计。
如果遇到概要设计中没有写明的逻辑问题,则应通知概要设计人员及时讨论并变更概要设计。