XX项目详细设计说明书-Vx.y2021

机构名称，2010XX项目详细设计说明书文件状态：[]草稿[√]正式发布[]正在修改版本：编写：审核：批准：审批日期：1、状态：对于基线库文档，应为“1、状态：对于基线库文档，应为“正式发布”；2、版本：对于基线库文档，指经过客户确认的版本，从1.0开始整数计数，2.0,3.0。。。；3、编写：文档的主要编写人员；4、审核：审核包括技术审核、规范性审核，根据实际情况，可以填写多人，如项目经理，项目管理中心QA，领导指定人员等；5、批准：各里程碑节点的批准人：需求文档：重大项目-业务总监，非重大-部门经理设计文档：重大项目-业务总监、架构师，非重大-部门经理测试文档：重大项目-业务总监，非重大-项目管理中心经理里程碑其他文档（如工作报告，安装部署、运维手册、使用手册等）：重大项目-业务总监，非重大项目-部门经理重大项目：软件开发项目100万以上，运维项目200万以上，气象服务项目50万以上华云信息技术工程有限公司XX项目详细设计说明书华云信息技术工程有限公司 文件更改历史记录文件编号：HX-SD-项目英文缩写-DDD-版本号更改记录版本号更改要点修改人审批人批准日期1.0正式发布尹玉梅王桂娟2013.4.2模板编号：HX-SD-IV-DDD版本：1.0DDD:DetailedDesignDocument使用本模板时，请删除模板更改记录，填写项目文档的版本信息。XX项目详细设计说明书华云信息技术工程有限公司PAGE6目 录1引言 11.1编写目的 11.2背景 11.3基线 11.4范围 11.5定义 11.6参考资料 22程序系统体系结构 32.1程序划分 32.2程序层次结构关系 33全局数据结构说明 43.1常量 43.2变量 43.3数据结构 44程序设计 54.1程序1（标识符）设计说明 54.1.1数据结构说明 54.1.2算法及流程 54.1.3数据存储说明 54.1.4源程序文件说明 54.1.5函数说明 54.2程序2（标识符）设计说明 61附录：标题一 11.1标题二 11.1.1标题三 12附录：模板使用说明 22.1文档模板相关快捷键使用说明 22.1.1标题栏 22.1.2正文栏 22.1.3可选栏 22.2整体需要注意的地方 33附录：图表编辑要求 43.1图编辑要求 43.2表编辑要求 54附录：如何避免标书打印时出问题 64.1避免图出问题 64.2避免表出问题 6引言【总体说明：1.编写文档时，如果某章节/栏目不适用或不涉及，应注明。并在可能的情况下说明理由。必要时，可增加适当的条目。2.本模板中“【…】”内容均为填写说明；在使用时请将其删除。3.附录为文档模板使用说明，包括标题格式、图表的编辑等都有说明，请编写文档时参照。文档编写完成后，请将附录几个章节删除。】编写目的【说明编写本软件详细设计说明书的目的，指出预期的读者。】背景【说明待开发软件系统的名称。】【列出开发此软件系统任务的提出者、开发者和用户等。】基线【说明编写本软件详细设计说明书的设计基线。】范围【说明本软件详细设计说明书所涉及的内容范围。】定义【列出本软件详细设计说明书中用到的专门术语和缩写词原文。】参考资料【属于本项目的其它已发表的文件。】【本文件中引用的文献、资料、标准等。】程序系统体系结构程序划分【用一系列图表列出本程序系统内的每个程序（包括每个模块和子程序）的名称、标识符、功能及其所包含的源程序文件名。】程序层次结构关系【用一系列图表列出本程序系统内的每个程序（包括每个模块和子程序）之间的层次结构与调用关系。】全局数据结构说明【本章说明本程序系统中使用的全局数据常量、变量和数据结构。】常量【包括数据文件名称及其所在目录，功能说明，具体常量说明等。】变量【包括数据文件名称及其所在目录，功能说明，具体变量说明等。】数据结构【包括数据结构名称，功能说明，具体数据结构说明（定义、注释、取值...）等。】程序设计【本章逐个地给出各个层次中的每个程序（包括每个模块和子程序）的设计考虑。】程序1（标识符）设计说明数据结构说明【给出本程序中的局部数据结构说明，包括数据结构名称，功能说明，具体数据结构说明（定义、注释、取值...）等。】算法及流程【给出本程序的算法及流程，可采用流程图、PAD图或“表+伪指令”的形式（参照相应的国际标准或国家标准）。】数据存储说明【具体说明需要以文件方式保存的数据文件名、数据存储格式、数据项及属性等。】源程序文件说明【给出本程序的各源程序文件的说明，包括源程序文件名称及其所在目录，功能说明，包含的前导文件及函数名称等。】函数说明【具体说明本程序中的各个函数，包括函数名称及其所在文件，功能，格式，参数，全程变量，局部变量，返回值，算法说明，使用约束等。】程序2（标识符）设计说明【用类似4.1的方式，说明第2个程序乃至第n个程序的设计考虑。】附录：标题一标题二标题三标题四标题五标题六附录：模板使用说明文档模板相关快捷键使用说明标题栏1标题一（快捷键ALT+1）1.1标题二（快捷键ALT+2）1.1.1标题三（快捷键ALT+3）1.1.1.1标题四（快捷键ALT+4）1.1.1.1.1标题五（快捷键ALT+5）1.1.1.1.1.1标题六（快捷键ALT+6）正文栏正文：（快捷键ALT+Z），最原始的正文样式，首行缩进0字。段落：（快捷键ALT+D），最原始的段落样式，首行缩进2字。可选栏如果正文中还需要进行编号按照如下格式：正文内编号1（应用Word自带编号工具，并加粗）再下一级编号1（应用Word自带编号工具）再下一级编号2正文内编号2并列项（应用Word自带编号工具）再一级并列项（应用Word自带编号工具）再一级并列项并列项整体需要注意的地方在文档中请尽量使用已定义好的标准的标题样式。正文样式统一用“正文”或“列出段落“样式（依是否需要首行缩进来选择）。对于拷贝来的文字，为了避免格式混乱，拷贝到本模板中时需选择“只保留文本”。（粘贴后在粘贴文字的右下角有一个粘贴选项的浮动图标，点击可进入对所粘贴文字设置格式）注意：如果需要插入宽图或宽表，要设置单独的节，将该单独节在页面布局中将纸张方向设置为横向，并将该节及下节页码设置为连续。附录：图表编辑要求图编辑要求示例图如下图所示：图STYLEREF1\s3SEQ图\*ARABIC\s11XX图图编号统一将上面的“图+图题注”一起拷贝到文档中需要贴图的位置用画好的新图替换本图片修改图题注中图的名称写分项内容的同事不需要再对图编号进行额外操作总稿人统一对全篇图题注进行“更新域”操作，使全篇图编号连续图格式参考图中文字：黑体五号（Visio图里选10pt），图中标题性文字可加大一级如小四（Visio图里选12pt），图中所有文字字号原则上不超过正文文字字号。图中文字和连线颜色必须是深色（最好为黑色），否则黑白打印时看不清楚。图背景可自行配色。表编辑要求示例表如下表所示：表STYLEREF1\s3SEQ表\*ARABIC\s11XX表表头表头表头表头表头表头表内文字表内文字表内文字表内文字表内文字表内文字表内文字表内文字表内文字表内文字表内文字表内文字表内文字表内文字表内文字表内文字表内文字表内文字表编号统一将上面的“表+表题注”一起拷贝到文档中需要贴图的位置用编辑好的新表替换本表，或直接在对本表进行编辑修改表题注中表的名称写分项内容的同事不需要再对表编号进行额外操作总稿人统一对全篇表题注进行“更新域”操作，使全篇表编号连续表格式参考点击表格左上角十字架选中整张表格，设置为“居中”将整张表格设置为“五号字”、“单倍行距”表头：加灰色底纹，文字加粗，单元格对齐方式设置为“水平居中”表内：单元格对齐方式设置为“靠上两端对齐（即左上对齐）”附录：如何避免标书打印时出问题避免图出问题在打印前将所有图转为图片格式，否则在打印时