详细设计书编写规范模板（初步设计文本编制规范）
本篇文章给大家谈谈详细设计书编写规范模板，以及初步设计文本编制规范对应的知识点，希望对各位有所帮助，不要忘了收藏本站喔。
本文目录一览：
设计说明书格式是怎样的？
课程设计说明书撰写格式
为了保证课程设计质量，特制定本规范。
设计说明书要求按统一格式打印，其版面要求：A4纸，页边距：上2cm，下
2cm，左
2.5cm、右
2cm;字体：正文宋体、小四号；行距：固定值
20;页码：底部居中。
一份完整的设计说明书应包括以下几个方面：一、封面（包括题目、院系、学生班级、设计组号、学生组员姓名、指导
教师姓名等）（见附
1）。
二、目录
居中打印目录二字，（四号黑体，段后
1
行），字间空一字符；章、节、小
节及其开始页码（字体均为小四号宋体）。节向右缩进两个字符，小节及以后标
题均向右缩进四个字符。目录中应包含正文及其后面部分的条目。目录的最后一
项是无序号的“参考文献资料”.
三、正文
（一）正文内容一般应包括：1、设计任务和要求：说明本课题应解决的主要问题及应达到的技术要求；
简述本设计的指导思想。
2、设计依据和设计原则。
3、方案论证：阐明为什么要选择这个设计方案以及所采用方案的特点。
4、设计论述：对设计工作的详细表述（包括设计计算）。要求层次分明、表
达确切。
5、结论或总结：对整个设计工作进行归纳和综合。
（二）正文要求：（1）计算正确，论述清楚，文字简练通顺，插图简明，书写整洁。文中图、表按制图要求绘制。
（2）
段落及层次要求：每节标题以四号黑体左起打印
（段前段后各0.5行），
节下为小节，以小四号黑体左起打印（段前段后各
0.5
行）。换行后以小四号宋
体打印正文。节、小节分别以1、1.1、1.1.1依次标出，空一字符后接各部分的标题。
当论文结构复杂，
小节以下的标题，
左起顶格书写，
编号依次用
（1）、（2）
……
或
1）、2）……顺序表示。字体为小四号宋体。
对条文内容采用分行并叙时，其编号用（a）、（b）……或
a）、b）……
顺序表示，如果编号及其后内容新起一个段落，则编号前空两个中文字符。
（3）图纸要求：图面整洁，布局合理，线条粗细均匀，圆弧连接光滑，尺
寸标注规范，使用计算机绘图。
（4）曲线图表要求：所有曲线、图表、线路图、流程图、程序框图、示意
图等不准徒手画，必须按国家规定标准或工程要求绘制（采用计算机辅助绘图）。
（5）课程设计说明书（报告）中图表、公式要求如下：（a）图：图的名称采用中文，中文字体为五号宋体，图名在图片下面。引
用图应在图题右上角标出文献来源。图号以章为单位顺序编号。格式为：图1-1，
空一字符后，接图名。
（b）表格：表的名称及表内文字采用中文，中文字体为五号宋体，表名在
表格上面。
表号以章为单位顺序编号，
表内必须按规定的符号标注单位。
格式为：表
1-1，空一字符后，接表格名称。
（c）公式：公式书写应在文中另起一行，居中排列。公式序号按章顺序编
号。字体为五号宋体，序号靠页面右侧。格式为：（1-1）……
四、设计体会及今后的改进意见
五、参考文献（资料）
参考文献：另起一页，
居中打印参考文献四字
（四号黑体，
段前段后1行），
字间空一字符；另起一行，按论文中参考文献出现的先后顺序用阿拉伯数字连续
编号（参考文献应在正文中注出）；参考文献中每条项目应齐全（字体均为小四
号宋体）。（格式：[编号]作者。论文或着作名称。期刊名或出版社。出版时间）。
（期刊应注明第几期、起止页数（包括论着））。
六、课程设计资料的装订
课程设计说明书按以下顺序装订成册：封面、目录、正文、设计体会及今
后的改进意见、参考文献；设计任务书、设计说明书（报告）和图纸等装入课程
设计专用袋中。
附
1
课程设计
给水处理厂设计说明书
设计组名
学生姓名
学
院
年级/专业
指导教师
完成日期
年
月
设计说明书怎么写，应该注意什么？正确格式？
概要设计说明书又可称系统设计说明书，这里所说的系统是指程序系统。编制的目的是说明对程序 系统的设计考虑，包括程序系统的基本处。流程、程序系统的组织结构、模块划分、功能分配、接口设计。 运行设计、数据结构设计和出错处理设计等，为程序的详细设计提供基础。
编制概要设计说明书的内容，要求如下：
11．1引言
11.1． 1编写目的
11．1．2背景
11．1．3定义
11.1．4参考资料
11.2总体设计
11.2.1需求规定
11.2．2运行环境
11．2．3基本设计概念和处理流程
11． 2． 4”结构
11．2．5功能需求与程序的关系
11． 2． 6人工处理过程
11．2．7尚未解决的问题
11．3接口设计
11．31用户接口
11．32外部接口
11．3 3内部接口
11．4运行设计
11. 4. 1运行模块组合
11.4.2运行控制
11.4.3运行时间
11.5系统论据结构设计
11. 5. 1逻辑结构设计要点
11. 5. 2物理结构设计要点
11.5.3数据结构与程序的关系
11． 6系统出错处理设计
11. 6. 1出错信息
11.6．2补救措施
11.6 3系统维护设计
概要设计说明书的编写提示（参考件）
E.1引言
E.1.1编写目的
说明编写这份概要设计说明书的目的，指出预期的读者。
E.1.2背景
说明：
a．待开发软件系统的名称；
b．列出此项目的任务提出者、开发者、用户以及将运行该软件的计算站（中心）。
E.1．3定义
列出本文件中用到的专门术语的定义和外文首字母组词的原词组。
E.1.4参考资料
列出有关的参考文件，如：
a．本项目的经核准的计划任务书或合同，上级机关的批文；
b．属于本项目的其他已发表文件；
c．本文件中各处引用的文件、资料，包括所要用到的软件开发标准。 列出这些文件的标题、文件编号、发表日期和出版单位，说明能够得到这些文件资料的来源。
E.2总体设计
E.2.1需求规定
说明对本系统的主要的输入输出项目、处理的功能性能要求，详细的说明可参见附录C。
E.2.2运行环境
简要地说明对本系统的运行环境（包括硬件环境和支持环境）的规定，详细说明参见附录C。
E．2．3基本设计概念和处理流程
说明本系统的基本设计概念和处理流程，尽量使用图表的形式。
E.2.4结构
用一览表及框图的形式说明本系统的系统元素（各层模块、子程序、公用程序等）的划分，扼要说明每个系统元素的标识符和功能，分层次地给出各元素之间的控制与被控制关系.
E.2.5功能器求与程序的关系
本条用一张如下的矩阵图说明各项功能需求的实现同各块程序的分配关系：
E．2．6人工处理过程
说明在本软件系统的工作过程中不得不包含的人工处理过程（如果有的话）。
E.2.7尚未问决的问题
说明在概要设计过程中尚未解决而设计者认为在系统完成之前必须解决的各个问题。
E．3 接口设计
E．3．1用户接口
说明将向用户提供的命令和它们的语法结构，以及软件的回答信息。
E．3.2外部接口
说明本系统同外界的所有接口的安排包括软件与硬件之间的接口、本系统与各支持软件之间的接 口关系。
E．3．3内部接口
说明本系统之内的各个系统元素之间的接口的安排。
E．4运行设计
E．4．1运行模块组合
说明对系统施加不同的外界运行控制时所引起的各种不同的运行模块组合，说明每种运行所历经的内部模块和支持软件。
E．4．2运行控制
说明每一种外界的运行控制的方式方法和操作步骤。
E．4．3运行时间
说明每种运行模块组合将占用各种资源的时间。
E.5系统数据结构设计
E.5．1逻辑结构设计要点
给出本系统内所使用的每个数据结构的名称、标识符以及它们之中每个数据项、记录、文卷和系的标识、定义、长度及它们之间的层次的或表格的相互关系。
E.5．2物理结构设计要点
给出本系统内所使用的每个数据结构中的每个数据项的存储要求，访问方法、存取单位、存取的物理关系（索引、设备、存储区域）、设计考虑和保密条件。
E.5.3数据结构与程序的关系
说明各个数据结构与访问这些数据结构的形式:
E.6系统出错处理设计
E.6.1出错信息
用一览表的方式说朗每种可能的出错或故障情况出现时，系统输出信息的形式、含意及处理方法。
E.6.2补救措施
说明故障出现后可能采取的变通措施，包括：
a.后备技术说明准备采用的后备技术，当原始系统数据万一丢失时启用的副本的建立和启动的技术，例如周期性地把磁盘信息记录到磁带上去就是对于磁盘媒体的一种后备技术；
b．降效技术说明准备采用的后备技术，使用另一个效率稍低的系统或方法来求得所需结果的某些部分，例如一个自动系统的降效技术可以是手工操作和数据的人工记录；
c．恢复及再启动技术说明将使用的恢复再启动技术，使软件从故障点恢复执行或使软件从头开始重新运行的方法。
E.6.3系统维护设计
说明为了系统维护的方便而在程序内部设计中作出的安排，包括在程序中专门安排用于系统的检查与维护的检测点和专用模块。 各个程序之间的对应关系，可采用如下的矩阵图的形式；
如何写详细设计文档
在大多数软件项目中，要末不作详细设计，要么开发完成后再补详细设计文档，质量也不容乐观，文档与系统往往不能同步，使详细设计文档完全流于形式，对工作没有起到实际的帮助。
·
详细设计是相对概要设计而言的，是瀑布开发流程的一个重要环节，在概要设计的高层设计的基础上，从逻辑上实现了每一模块的功能，是编码阶段的主要参考资料，是从高层到低层、逐步精化思想的具体实现。
详细设计文档的内容包括各个模块的算法设计，
接口设计，
数据结构设计，交互设计等。必须写清楚各个模块/接口/公共对象的定义，列明各个模块程序的
各种执行条件与期望的运行效果，还要正确处理各种可能的异常。
·
在开发过程中，由需求及设计不正确、不完整所导致的问题是项目进度拖延、失败的一个主要因素，而软件系统的一个重要特性就是需求和设计的不断构建和改进，在写详细设计文档过程中，
详细设计实际上是对系统的一次逻辑构建，可以有效验证需求的完整性及正确性。
如果不写详细设计文档，一般就从概设直接进入编码阶段，这时开发人员所能参考的资料就是需求规格说明书及页面原型、数据库设计等，不能直接进行开发，需要进行信息的沟通，把页面原型不能体现的设计讲清楚，这样既容易遗忘，也容易发生问题，详细设计文档可以作为需求人员、总体设计人员与开发人员的沟通工具，把静态页面无法体现的设计体现出来，包含整体设计对模块设计的规范，体现对设计上的一些决策，例如选用的算法，对一些关键问题的设计考虑等等，使开发人员能快速进入开发，提高沟通效率，减少沟通问题。
对于系统功能的调整，后期的维护，详设文档提供了模块设计上的考虑、决策，包括模块与整体设计的关系、模块所引用的数据库设计、重要操作的处理流程、重要的业务规则实现设计等等信息，提供了对模块设计的概述性信息，阐明了模块设计上的决策，配合代码注释，可以相对轻松读懂原有设计。
·存在的问题要由专门的人写，是比较麻烦的，也是很需要时间的，会对进度造成压力，也容易形成工作瓶颈，使设计人员负担过重，而开发人员无事可作。对于现在一般的以数据库为中心的管理系统而言，这个工作始终是要作的，区别只不过是不是形成专门文档，形成文档可能会多花一两周时间，但相对于规避的风险和问题来说，也是值得的，另外由于现在高级语言的流行，所以更详细的设计应该直接体现在代码的设计上，而文档则只体现设计上的一些决策，协调整体设计与模块设计的关系，把页面原型所不能体现的设计情况文档化，所以所花费的时间是有限的。
设计内容容易过细，但设计阶段是不能考虑特别清楚地，时间也不允许。
对于这个问题，一个对策是上边所提到的，文档只体现设计上的决策，页面原型所不能反映的信息，详细设计只体现总体设计对模块设计的一些考虑，例如对功能的数据库设计等等，而具体的实现实现，则到代码中再去实现，相关的设计也仅体现在代码中。
需求、设计需要不断的被更新、构建，则设计文档需要不断的重新调整，文档的维护需要跟上，否则文档和系统的同步就很难得到保障了，且造成多余的工作量。文档的内容易流于形势，质量糟糕，不能成为开发人员的参考手册，一是要建立起相关制度，如有修改，先改文档，后作开发，从工作流程上切实保障文档与系统的同步，二是要规范文档质量，对文档该写什么，不该写什么，标准是什么，粒度是什么，语法应该如何组织，有明确的标准和考虑，同时，建立审计文档评审、审核制度，充分保障系统的使用。·
首先是文档的内容，根据项目和团队的不同，详细设计文档的内容也有所不同，一般说来，粒度不宜过细，不能代替开发人员的设计和思考，但要把有关设计的决策考虑进去，包括与其他模块、整体设计的关系、操作的处理流程，对业务规则的设计考虑等，有一个标准为，凡是页面原型、需求规格说明书所不能反映的设计决策，而开发人员又需要了解的，都要写入文档。
其次是文档所面向的读者，主要为模块开发人员、后期维护人员，模块开发人员通过详细设计文档和页面原型来了解所开发的功能，后期维护人员通过实际系统、模块代码、详细设计文档来了解一个功能。
再有就是谁来写文档，因为文档主要考虑的是设计上的决策，所以写文档的人应该为负责、参加设计的技术经理、资深程序员，根据团队情况和项目规模、复杂度的不同，也有所不同。
还需要保证文档的可读性、准确性、一致性，要建立严格的文档模板及标准，保证文档的可读性及准确性，同时建立审核及设计评审制度，来保障设计及文档的质量，另外在工作流程中要强调，要先设计、先写文档，再进行开发。
关于详细设计书编写规范模板和初步设计文本编制规范的介绍到此就结束了，不知道你从中找到你需要的信息了吗 ？如果你还想了解更多这方面的信息，记得收藏关注本站。
