设计说明书编写规范
毕业设计作品(产品)设计说明书撰写说明及要求
附件一毕业设计作品(产品)设计说明书撰写说明及要求在作品(产品)设计和实现过程中，每个工作流都产生了相关文档，如需求工作流有需求规格说明书，分析设计工作流有设计说明书，实现工作流有详细的源码，测试工作流产生了测试报告。
将这些文档进行整理，就形成了作品(产品)设计说明书，设计说明书应按学院规定的结构、格式排版编写。
一、设计说明书的结构设定设计说明书由前置部分、主体部分和后置部分三大部分组成。
前置部分由封面、摘要、关键词和目录四部分组成，主体部分由绪论、正文、结论三大部分组成，后置部分由参考文献、致谢和附录三大部分组成。
(一)前置部分1、封面。
封面是毕业设计的门面，提供毕业设计说明书的相应信息。
要求使用统一封面，封面样式附后，封面上的所有有关信息填写准确、完整、清晰。
2、摘要。
摘要是毕业设计说明书不加注释和评论的简短陈述，一般应说明毕业设计的工作目的、实验方法、结果和最终结论等，而重点是结果和结论。
摘要中一般不用图、表、化学结构式、计算机程序，也不用非公知公用的符号、术语和非法定的计量单位。
摘要页置于中文题名页后，中文摘要一般为200～300汉字左右，摘要应包括关键词。
3、关键词。
关键词是为了文献标引工作而从毕业设计说明书中选取出来用以表示全文主题内容的单词或术语。
一般选取3-5个词作为关键词，关键词位于摘要下方，另起一行，左对齐，关键词间用分号分隔，最后一个词后不打标点符号，如有可能，尽量用《汉语主题词表》等词表提供的规范词。
4、目录。
目录即毕业设计说明书的提纲，由毕业设计说明书的章、节、小节、参考文献、致谢等的序号、名称和页码组成。
另起一页排在摘要页之后，章、节、小节分别按相应要求标出。
(二)主体部分1、绪论(或引言)。
绪论简要说明设计工作的目的、范围、相关领域的前人工作和知识空白、理论基础和分析、设计方法、设计思路、预期结果和意义等。
绪论应言简意赅，不要与摘要雷同，不要成为摘要的注释。
一般教科书中有的知识，在绪论中不必赘述。
毕业论文(设计说明书)书写格式
毕业论文（设计说明书)书写格式、版面及装订标准一、毕业论文(设计说明书)的基本格式毕业论文（设计说明书）的各个组成部分按下述顺序依次排列：1。
封面2。
中文摘要和关键词3. 英文摘要和关键词4。
目录5. 正文6。
致谢7. 参考文献* 附录（如果设计(论文）需要，可主要列入正文内过分冗长的公式推导，供查读方便所需的辅助性数学工具或表格，重复性数据图表，论文使用的缩写，程序全文及说明等.）二、毕业论文（设计说明书）版面及编写标准1.毕业论文（设计说明书）书写格式必须符合科技文件书写格式与要求,文字部分不少于5000字，以6000字左右为宜。
图纸规范整洁，单位标注统一正确,说明书按照学校统一要求，用A4纸单面打印,与封面在左侧装订成册。
2。
毕业论文(设计说明书）的版面要求在页面设置中设置如下:1）页边距：上:2.8厘米、下：2。
2厘米,左：2。
8厘米、右：2.2厘米；纸张纵向。
2）纸张：A4；3）版式:页眉、页脚均为：1。
5厘米;4）文档网格:字符—-——-每行43；行—--—每页35。
根据上面的设置,毕业论文（设计说明书)的行跨度为20磅。
毕业论文（设计说明书)设有页眉及页码.从正文部分开始,设置页眉，单数页码的页眉为设计（论文)题目，双数页码的页眉为“论文（设计说明书）”。
页眉为小5号宋体、居中。
页码设在页眉右侧.中、英文摘要以及目录页码用罗马数字编写，正文及其后面部分页码用阿拉伯数字编写.3.毕业论文（设计说明书）打印、排版规范1)中文摘要及关键词：（1）居中打印设计（论文）题目（三号黑体，段后1行）.（2）另起一行居中打印“摘要”（四号黑体，段后1行，），字间空一字符。
(3）另起一行打印摘要内容（小四号宋体）（每段开头空两个中文字符）。
(4）另起一行打印“关键词:”三字（小四号黑体，段前0。
5行），其后为关键词(小四号宋体），每一关键词之间用逗号隔开,最后一个关键词后不打标点符号。
2)英文摘要及关键词:(1）中文关键词后,另起一页，居中打印设计（论文）英文题目（单词首字母大写（虚词首字母不大写）），三号Times New Roman，加粗,段后1行）。
设计说明书编写要求
设计说明书编写要求
1、需将所有的计算过程写出
2、需交代所有文中使用的数据来源
①若数据来源于参考文献，需列出参考文献。
②若数据来源于自己的假设，需说明假设的理由。
3、说明书正文末了需列出参考文献，格式按科技论文要求。
4、正式稿统一用A4纸电脑打印（单面或双面均可）或手写，但全
文需统一，需有页码。
5、最后需装订成册（订书钉两个，订左侧），封面格式按学院统一要求。
装订顺序如下：
①封面
②设计任务书
③正文（包括目录、计算过程、图表和参考文献）
④评分表
1。
毕业设计说明书格式及要求
西华大学电气信息学院毕业设计说明书格式及要求一份完整的毕业设计说明书应包括：封面、摘要、目录、正文（前言、总体方案设计、…、结论、总结与体会、谢辞等）、参考文献、附录等。
一、封面：单独1页（见样件）二、摘要、关键词：中文（180～300字）、英文；单独1页摘要应高度概括题目的内容、方法和观点，以及取得的成果和结论。
应反映出整个内容的精华。
中文摘要在300字以内为宜，同时要求写出外文摘要，以200个实词为宜。
并要求写出中文、外文的关键词。
①用精炼、概括的语言表达，每项内容不宜展开论证和说明；②要客观陈述，不宜加主观评价；③成果和结论性字句是摘要的重点，论述上要多些，以加深读者的印象；④要独立成文，选词用语要避免与全文尤其是前言和结论部份雷同；⑤既要简短扼要，又要表达清晰，结构合理。
摘要用中、英文对照编写；“摘要”两字加粗，缩进两格，字体用楷体四号字，“摘要”后面的内容不换行，行尾缩进两格，选用小四号宋体字，整体对齐，行距为固定值20磅。
关键词一般为3～8个，在摘要后另起一行排，各关键词之间用“，”号分隔。
关键词的字体和排版与“摘要”的相同；关键词与摘要之间不空行。
（见样件）三、目录：内容必要对应页码号“目录”的字体采用三号宋体加粗，居中；目录中的标题不宜超过三级。
一级标题用小四号宋体加粗；二级及其以后的标题用小四号字，不加粗。
四、设计报告正文：正文的标题可分为章(一级)、节(二级)、小节(三级)等。
一级标题用小三号字，编号用1级阿拉伯数字（如：2总体方案设计），字体选用宋体加粗；二级标题用四号字，编号用2级阿拉伯数字（如：2.1），字体选用宋体加粗；三级标题及其以后的标题用小四号字，三级标题编号用3级阿拉伯数字（如：2.1.3），字体选用宋体加粗。
标题的排列按：①一～三级标题文字均居左顶排，标题与标题间不空行，正文与标题之间不空行；②各一级标题之间要换页，空一行，小四；③在有副标题的情况下，应注意主标题与副标题的关系与比例。
毕业设计说明书与毕业论文撰写的规范化要求内容
毕业设计说明书与毕业论文撰写的规范化要求一篇完整的毕业设计说明书或毕业论文有题目、摘要及关键词、目录、引言（前言）、正文、结论、谢辞、参考文献、附录等几部分构成。
要求理工科专业不少于4000字，文科专业不少于6000字。
一、毕业设计说明书撰写的主要内容与基本要求一份完整的毕业设计说明书应包括如下主要内容：1．题目设计课题名称，要求简洁、确切、鲜明。
2．中外文摘要及关键词应扼要叙述本设计的主要内容、特点，文字要简练。
中文摘要约300字左右；外文摘要约250个实词左右。
关键词3—5个。
3．目录主要内容的目录。
4．前言应说明本设计的目的、意义、范围及应达到的技术要求；简述本课题在国内（外）的发展概况及存在的问题；本设计的指导思想；阐述本设计应解决的主要问题。
5．正文（1）设计方案论证：应说明设计原理并进行方案选择。
应说明为什么要选择这个方案（包括各种方案的分析、比较）；还应阐述所采用方案的特点（如采用了何种新技术、新措施、提高了什么性能等）。
（2）设计及计算部分：这是设计说明书的重要组成部分，应详细写明设计结果及计算结果。
（3）样机或试件的各种实验及测试情况：包括实验方法、线路及数据处理等。
（4）方案的校验：说明所设计的系统是否满足各项性能指标的要求，能否达到预期效果。
校验的方法可以是理论分析（即反推算），包括系统分析；也可以是实验测试及计算机的上机运算等。
6．结论概括说明本设计的情况和价值，分析其优点、特色，有何创新，性能达到何水平，并指出其中存在的问题和今后的改进方向。
7．谢辞简述自己通过本设计的体会，并对指导老师和协助完成设计的有关人员表示谢意。
8．参考文献应列出主要参考文献。
9．附录将各种篇幅较大的图纸、数据表格、计算机程序等作为附录附于说明书之后。
二、毕业论文撰写的主要内容与基本要求1．题目题目应该简短、明确，要有概括性，让人看后能大致了解文章的确切内容、专业的特点和学科的范畴。
题目的字数要适当，一般不宜超过20字。
系统概要设计说明书编写标准全套
系统概要设计说明书编写标准1 前言1.1 文档目的文档编写目的是为了阐述XXX系统的概要设计。
概要设计说明书是为了说明整个XXX系统的体系架构，以及需求用例的各个功能点在架构中的体现，为系统的详细设计人员进行详细设计时的输入参考文档。
本说明书的预期读者为系统设计人员、系统开发人员和项目评审人员。
1.2 背景XXX系统是[项目背景]1.3 文档范围1、产品范围：根据《需求规格说明书》，该文档阐述软件产品的功能2、涉及到的干系人有：公司高层、客户、项目经理、质量小组、开发小组。
1.4 读者对象项目经理、质量保证人员：据此来进入项目策划过程测试人员：据此进入测试过程。
需求管理员、配置管理员：可以识别配置项制定相关的活动计划用户IT主管：清楚与确认项目需求。
开发人员，包括设计人员、编码人员：明确任务与需求，清楚项目开发流程。
1.5 参考文档《需求规格说明书》1.6 术语与缩写解释2 总体设计2.1 系统描述2.1.1 系统概述XXX系统，采用XXX架构开发出的XXX平台。
2.1.2 运行环境对本平台所赖于运行的硬件、软件环境的描述。
1. 服务端操作系统：Windows Server 2003 SP2 及以上；2. 服务端运行环境：JDK1.7及以上；3. 数据库支持：Oracle10g企业版；4. 协议支持：TCP/IP、HTTP、HTTPS、SMTP、POP3等；5. 硬件支持：服务器CPU 2.0GHz以上、内存2G以上、需要300G 以上的空闲磁盘空间；6. 网络环境：有固定公网IP，网络畅通，可以远程访问(远程桌面连接或者借助辅助工具)；7. 客户端要求：IE10以上；2.1.3 数据管理要求2.1.4 故障处理要求（1）产品支撑环境运行错误，包括以下几个方面：数据库运行错误：系统无法使用，将提供错误提示页面，并记录日志。
系统配置参数错误：系统提供错误提示页面，要求管理员修改相关配置参数。
配置参数的修改方法应参考相关为管理员提供的手册。
课程设计设计说明书格式规范
课程设计设计说明书格式标准一、课程设计设计说明书格式标准装订成册的书面说明书和完整电子文档各一份，说明书统一采用A4纸打印，说明书格式如下，顺序为：〔一〕封面〔二〕索命数正文，包括：1、摘要〔包括中文摘要和英文摘要〕：分别为300字左右，应包括：工作目的、内容、结论、关键词2、目录以上部分以I、II……编制页码。
以下部分根据章节编写序号和页码。
3、主体部分〔不少于12000字,按要求设定页眉页角，要求居中〕主要包括引言或绪论、正文、结论、致谢，采用全角符号，英文和数字半角。
每页28行、每行32-35个汉字，倍行间距3.1格式：主体部分的编写格式由引言(绪论)开始，以结论结束。
主体部分必须由1页开始。
一级标题之间换页，二级标题之间空行。
3.2序号3.2.1毕业说明书各章应有序号，序号用阿拉伯数字编码，层次格式为：1××××〔三号黑体，居中〕××××××××××××××××××××××××××〔小三号黑体，居左〕×××××××××××××××××××××××××〔四号黑体，居左〕××××××××××××××××××××〔内容用小四号宋体〕。
毕业设计说明书（论文）撰写格式_论文格式_
毕业设计说明书（论文）撰写格式为提高我校毕业生毕业设计()的撰写质量，做到毕业设计说明书(毕业论文)在内容和格式上的统一和规范，特规定如下：一、装订顺序论文(设计说明书)内容一般应由9个部分组成，严格按以下顺序装订,但学院可根据专业特点制订装订项目。
(1) 封面 (6) 正文(2) 中文摘要 (7) 附录(根据具体情况可省略)(3) 英文摘要 (8) 参考文献(4) 目录 (9) 致谢(5) 主要符号表(根据具体情况可省略)二、内容及书写格式要求1、毕业设计说明书(毕业论文)应用中文撰写(外语专业除外)。
2、毕业设计(论文)成果分毕业设计说明书和毕业论文两种，所有出现相关字样之处请根据具体情况选择“毕业设计说明书” 或“毕业论文”字样。
3、毕业设计说明书(毕业论文)word软件编辑，一律打印在a4幅面白纸上，单面打印。
4、毕业设计说明书(毕业论文)的上边距：30mm;下边距：25mm;左边距：3omm;右边距：2omm;行间距1.5倍行距。
5、页眉的文字为“中北大学x届毕业设计说明书” 或“中北大学××××届毕业论文”，用小四号黑体字，页眉线的上边距为25mm;页脚的下边距为18mm。
6、论文页码从引言部分开始，至致谢止，在页脚中标出。
封面、摘要、目录不编入页码，目录单独编页码。
7、正文用小四号宋体字;每章的大标题用小三号黑体，加粗，留出上下间距为：段前0.5行，段后0.5行;二级标题用小四号黑体，加粗;其余小标题用小四号黑体，不加粗。
8、文中的图、表、附注、公式一律采用阿拉伯数字分章编号。
如图1.2，表2.3，附注3.2或式4.3。
图表应认真设计和绘制,不得徒手勾画。
表格与插图中的文字一律用5号宋体。
每一插图和表格应有明确简短的图表名，图名置于图之下，表名置于表之上，图表号与图表名之间空一格。
插图和表格应安排在正文中第一次提及该图表的文字的下方。
当插图或表格不能安排在该页时，应安排在该页的下一页。
毕业论文(设计)说明书撰写规范格式
毕业设计说明书（论文）撰写规范格式发布部门:实践教学科发布时间: ［2006—12—20]毕业设计(论文）是学生毕业前最后一个重要学习环节，是学习深化与升华的重要过程。
它既是学生学习、研究与实践成果的全面总结，又是对学生素质与能力的一次全面检验。
为了保证我校本科生毕业设计（论文)质量，特制定毕业设计说明书（论文)撰写的一般规范如下，各学院可根据各专业特点制定各自的撰写规范，没有制定规范的专业参照此规范执行。
一、论文（设计说明书）的文字量要求整篇论文（设计说明书）字数一般不少于15000字，要求计算机打印。
二、论文（设计说明书）撰写规格要求1.文字、符号论文（设计说明书）撰写文字要规范，汉字须使用国家公布的规范字。
中文的标点符号应按新闻出版署公布的“标点符号用法”使用.文稿内容要完整准确，有关实验数据表格、图示和照片的表达一定要规范化。
实验结果已用图表示了的一般不再列表。
图表中所述内容不必在正文中再做说明，应尽量避免重复。
每个图表必须要有图例序号和图表名称。
2。
名词、名称科学技术名词术语采用全国自然科学名词审定委员会公布的规范词或国家标准、部颁标准中规定的名称，尚未统一规定或叫法有争议的名称术语，可采用惯用的名称。
使用外文缩写词时，首次出现时应在括号内注明其含义.外国人名一般采用英文原名，按名前姓后的原则书写。
比较熟知的外国人名(如牛顿、达尔文、马克思等)可按通常标准译法写译名。
3.量和单位量和单位必须按照中华人民共和国的国家标准采用，以国际单位制（SI）为基础。
非物理量的单位，如件、台、人、元等,可用汉字与符号构成组合形式的单位，例如件/台、元/km.4.数字测量统计数据一律用阿拉伯数字，但在叙述不很大的数目时，一般不用阿拉伯数字，如“三力作用于一点”，不宜写成“3力作用于1点”。
大约的数字可以用中文数字，也可以用阿拉伯数字，如“约一百五十人”，也可写成“约150人”.5.标题层次标题层次应有条不紊，整齐清晰。
毕业设计说明书编写格式规范
南昌大学科技学院毕业设计说明书（论文）编写格式规范一、毕业论文包含的基本内容及排列顺序毕业设计说明书（论文）使用学院统一制发的封面格式（可下载打印），封面中题目、学科部、专业（填写全称）、班级、学号、学生姓名、指导教师、起讫日期应规范填写。
毕业设计说明书（论文）包含以下基本内容，按顺序排列：1、目录2、标题3、作者信息（顺序为：作者专业、学号、姓名、指导教师）4、中文摘要及中文关键词5、英文摘要及英文关键词6、正文7、注释（可选）8、参考文献9、谢辞（可选）10、附录（可选）二、层次设置：正文层次不宜设置过多，一般分为章、节、条、款、项，不超过5级，设置到哪一层次视需要而定，若节后无需“条”时可直接列“款”、“项”。
层次序号格式编排分理工科和文科两种规格，根据具体专业选择使用：1、理工科2、文科三、页面排版规范：1、排版软件：Microsoft Word 2000及以上版本。
2、打印纸张：论文打印纸规格统一为：A4（210×297毫米），纵向。
3、页边距设置：上2.5厘米；下3厘米；左3厘米；右3厘米；装订线0.5厘米（左侧）；页脚距边界1.75厘米。
4、段落间距：段前、段后均为0。
5、行间距：多倍行距1.25。
6、字间距：按默认设置（标准）。
7、按“单行不占页原则，按单字不占行”原则，具体排版出现单行占页或单字占行时，可对字距或行距进行适当微调。
四、字号、字体和标点规范：1、标题：三号宋体加粗居中；2、副标题：四号楷体居中，前加2个全角长横线（如：——×××××）；3、层次标题：按毕业论文层次设置规定格式设置；4、表名：五号宋体加粗居中，置于表上一行；5、图名：五号宋体居中，置于图下一行；6、目录、作者信息、摘要正文、论文正文（含表格文字）、参考文献正文、页码：均使用五7、号宋体；8、注释：小五号宋体；9、英文字统一采用Times New Roman 字体，中文标点一律采用全角。
数据库设计说明书编写规范
数据库设计说明书编写规范1.引言在引言部分，需要对数据库设计说明书进行简要介绍，包括项目背景、目的和范围等。
同时，在引言中还需对数据库设计的基本原则和设计思路进行阐述，以帮助读者更好地理解和使用数据库。
2.数据库设计目标在数据库设计目标部分，明确数据库设计的目标和要达到的效果。
例如，提高数据存取效率、减少数据冗余、保证数据一致性等。
同时，还需说明数据库设计的业务需求和用户需求，以确保数据库设计满足实际需求。
3.数据库设计需求分析在数据库设计需求分析部分，对数据库设计的需求进行详细的分析和说明。
主要包括数据量估计、数据类型、数据关系、数据完整性、安全性等方面的需求。
此外，还需分析用户的查询需求和业务操作需求，以确保数据库设计满足用户需求。
4.数据库设计方法与过程在数据库设计方法与过程部分，详细描述数据库设计的方法和过程。
首先，对数据库设计的整体流程进行说明，包括需求分析、概念设计、逻辑设计、物理设计等阶段。
然后，对每个阶段的具体方法和步骤进行描述，包括使用的工具和技术。
5.数据库结构设计在数据库结构设计部分，详细描述数据库的架构、模型和表结构。
首先，对数据库的整体架构进行描述，包括数据库管理系统的选择、数据库服务器的配置等。
然后，对数据库的模型进行描述，包括概念模型、逻辑模型和物理模型。
最后，对数据库的表结构进行描述，包括表的定义、字段定义、约束条件等。
6.数据库性能优化策略在数据库性能优化策略部分，详细描述如何优化数据库的性能，以提高查询效率和响应速度。
主要包括索引的设计、查询语句的优化、物理存储结构的调整等方面。
此外，还需说明如何监控和调整数据库的性能，以及如何解决性能问题和故障。
7.数据库备份与恢复策略在数据库备份与恢复策略部分，详细说明如何进行数据库的备份和恢复。
主要包括备份频率、备份方式、备份目标、恢复方式等方面。
此外，还需说明如何验证备份的完整性和正确性，以确保备份数据的可用性和可靠性。
设计说明书撰写规则
课程设计文件撰写规则设计说明书是学生在教师的指导下经过调查研究、科学实验或工程设计，对所取得成果的科学表述，是认定课程设计成绩的重要依据。
在撰写设计说明书时，需参照国家、各专业部门制定的有关标准及语法规范，并应遵照本次设计制定的如下规则：1．结构要求可参照已下发的设计说明书的结构撰写，若确有必要，也可适当添加需要的章节。
2．书写要求2.1 编辑软件设计说明书要求统一使用Microsoft Word软件进行文字处理，2.2 标题题目使用小二号黑体，居中。
2.3 目录目录应包括说明书中全部章节的标题及页码，含正文章、节题目、致谢、参考文献、附录等。
目录编排最多使用三级目录（即：1……、1.1……、1.1.1……），二、三级目录相对前级目录右缩进一个汉字位置，要求标题层次清晰。
目录题头用四号黑体字居中排写，隔行书写目录内容。
2.4 说明书正文2.4.1 章节标题章节标题应突出重点、简明扼要，字数一般在15字以内，不使用标点符号。
标题中尽量不采用英文缩写词，对必须采用者，应使用本行业的通用缩写词。
2.4.2 层次层次根据实际需要选择，以少为宜。
各层次标题不得置于页面的最后一行（孤行）。
层次代号格式要求参照表2-1。
表2-1 层次代号及说明2.5 参考文献2.5.1 文献标识正文中须标识参考文献编号，按出现顺序用小五号字体标识，置于所引内容最末句的右上角（上标）。
文献编号用阿拉伯数字置于方括号“[ ]”中，如：×××××[1]；×××××[4，5]；×××××[6~8]。
当提及的参考文献为文中直接说明时，其序号应该与正文排齐，如“由文献[8，10～14]可知……”。
论文中引用文献原文应加引号；若引用原意，文前用冒号或逗号，不用引号。
较完整的长段引文应提行独立成段，即在冒号后另起一段。
详细设计说明书编写规范
详细设计说明书编写规范1.文档结构-引言：简要介绍软件系统的背景和目的。
-系统概述：概括性地描述软件系统的功能和特点。
-模块设计：对系统中各个模块的设计进行详细说明。
-数据结构设计：描述系统中各个数据结构的设计。
-接口设计：详细描述系统中各个模块之间的接口设计。
-流程设计：描述系统中的各个流程的设计。
2.内容准确性-设计说明书应该准确地描述各个模块、数据结构和接口的设计。
-避免使用模糊和不明确的语言，确保文档所描述的内容一目了然。
-在设计过程中充分考虑到系统的可靠性、安全性和扩展性等方面的要求。
3.可读性和可理解性-使用清晰、简洁的语言，避免使用过于专业术语或过分简化的语句。
-使用图表、流程图等辅助工具来展示设计方案，使读者更容易理解。
-对于复杂的设计思路，可以进行分步详解，确保读者能够逐步理解。
4.格式规范-使用统一的字体、字号和行间距，使文档整体风格统一-使用标题、段落和编号等，使文档结构清晰、易读。
-对于代码、变量名等关键词，使用特定的格式或颜色标注，以便于阅读和查找。
5.补充说明-针对关键的设计决策，如算法选择、技术选型、数据结构的优缺点等，要进行适当的说明和分析。
-如有必要，可以附上相关的流程图、数据流图、类图等具体的设计图示，以辅助读者理解。
-如果存在已实施的系统或已有的模块，可以提供相关的代码片段或函数说明，以便于后续的参考和修改。
总之，详细设计说明书是软件开发过程中的重要文档，需要准确、清晰、易读、结构良好，并包含必要的图表和文档辅助说明。
只有符合规范的详细设计说明书才能更好地指导开发人员进行编码工作，从而保证软件系统的质量和可靠性。
设计说明书格式要求
设计说明书要求一、说明书篇幅：不少于5000字。
二、包括下述几部分(一)、封面：包括题目，学院名称，姓名，学号。
题目：能概括整个说明书最重要的内容，恰当、简明、引人注目（严格控制在20字以内）。
（二）、摘要（中文）：说明书第一页为中文摘要（100字左右），应说明本设计的目的、内容、成果或结论。
相应注明本文的关键词3至4个。
（三）、目录：应是说明书的提纲，也是说明书组成部分的小标题，应将文内的章节标题依次排列，标题应简明扼要。
（四）、设计说明书包括以下内容：1.前言：是对整篇设计说明书的一个简短开场白，介绍研究背景、相关定义等。
2.正文：正文是说明书的核心内容，详细描述该设计的具体细节。
本设计包括工艺设计、物料横算2部分。
3.结语：是对前面设计的内容作系统的分析，给出一个总结，并提出设计的优缺点等。
4.附件：2张A4图纸。
一张总工艺图，一张工厂平面设计图。
（五）、参考文献：综述中列出的参考文献必须是与论文有密切关系的重要文献，要求10个以上。
参考文献按在正文中出现的先后次序列表于文后；具体格式要求见后。
三、说明书格式：（一）题目、署名及层次格式、文字、字数要求：1、文稿采用A4幅面word文档；中文标题为三号黑体，如有副标题，另起一行，字体为四号宋体；正文为小四号仿宋体；英文字体为Times NewRoman，标题字号为三号，字母全部大写；如有副标题，另起一行，首字母大写，正文为小四号字体；文稿应加注页码。
2、摘要和关键词（五号、黑体）写在题目后、正文前，摘要和关键词的内容部分为五号仿宋体。
3、说明书的层次，统一要求采用：1 *******1.1 *******(占一行或接排。
当接排时，标题后要加标点。
一级标题采用四号黑体，二级标题采用小四号黑体，三级标题采用小四号宋体加粗)1.1.1 *******1.1.1.1*******（二）文稿和图稿其它要求：1、正确阐述技术内容。
名词术语应符合国家有关标准、规范。
设计说明书编制要求
设计说明书编制要求简介设计说明书是设计团队在项目实施过程中必须遵循的一个重要文档，它是在项目启动和定义阶段编写的，通过对产品/项目的需求、目标、功能和规范的详细描述，为整个项目的顺利进行提供有力的保障。
本文将介绍设计说明书的编写要求和规范。
编写规范文件格式设计说明书应当采用便于编写、阅读和传递的文本格式，Markdown是一种严格的标记语言，可以方便的进行文件的编辑以及版本管理。
同时也保证了文档的清晰、简洁和易于理解。
文档结构设计说明书应当包含如下的结构内容：•项目简介：简要描述项目的背景，目标，范围等概要信息。
•需求定义：包含功能、限制和接口等方面的详细需求定义。
•方案设计：介绍项目的方案设计，包括系统结构、算法、实现方法等。
•实施计划：概括说明项目的执行计划和工作流程。
•质量保证：介绍与项目质量保证相关的方案，包括测试、验收等。
•风险管理：内容包含项目的可持续性、安全性以及可能出现的风险。
内容要求在编写设计说明书的过程中，需要牢记以下要求：•文档的语言应该准确清晰，避免主观、不严谨描述。
•需求、方案、实施计划、质量保证、风险管理的详细信息必须充分表述，完整易懂。
•需要充分考虑潜在用户、评审人员、开发人员并针对不同受众的不同需求做出相应描述。
•所有可视化内容必须明确附上标注和说明，方便读者了解。
编写建议设计说明书的编写不应被视为简单的原始工作，以下建议可以帮助您提升编写质量和效果。
逐步编写设计说明书项目复杂度较高，涵盖的方面多种多样主。
面可以分别对各个模块进行完善阐述，在结构明确、内容完整的情况下，逐步完成整个文档。
团队协同设计团队中，不同人角色和职责存在区别，如产品和设计等多类员工在设计说明书的编写中承担不同部分任务，这就要求需求和方案设计的交流和沟通是必不可少的。
设计师们也应该有效协调、跟踪进度和质量，互相学习、交流经验。
多角度思考在编写设计说明书的过程中，设计师们需要运用想象力和更深的洞察力，考虑到用户的需求，尽可能的同时统筹各种情况所需的设计、交互等方面的考量。
CMMI-3概要设计说明书编写规范
概要设计说明书编写规范作者：王建明完成日期：2007/6/10签收人：签收日期：修改情况记录：目录1 引言 (1)1.1 编写目的 (1)1.2 范围 (1)1.3 定义 (1)1.4 参考资料 (1)2 总体设计 (2)2.1 需求规定 (2)2.2 运行环境 (2)2.3 基本设计概念和处理流程 (2)2.4 结构 (2)2.5 功能需求与程序的关系 (2)2.6 人工处理过程 (3)2.7 尚未解决的问题 (3)3 接口设计 (3)3.1 用户接口 (3)3.2 外部接口 (3)3.3 内部接口 (3)4 运行设计 (4)4.1 运行模块组合 (4)4.2 运行控制 (4)4.3 运行时间 (4)5 系统数据结构设计 (4)5.1 逻辑结构设计要点 (4)5.2 物理结构设计要点 (4)5.3 数据结构与程序的关系 (4)6 系统出错处理设计 (5)6.1 出错信息 (5)6.2 补救措施 (5)6.3 系统维护设计 (5)1. 引言1.1编写目的服务于XX集团网络化运营，管理销售中的各个环节，最终用户为XX集团销售公司,销售办事处和集团领导。
1.2范围说明：a．待开发的软件系统的名称；b．列出本项目的任务提出者、开发者、用户以及将运行该项软件的单位。
1.3定义列出本文件中用到的专门术语的定义和缩写词的原词组。
1.4设计依据列出要用到的设计依据，如：a．本项目的经核准的计划任务书或合同、上级机关的批文；b．属于本项目的其他已发表的文件；c．本文件中各处引用的文件、资料，包括所要用到的软件开发标准。
列出这些文件的标题、文件编号、发表日期和出版单位，说明能够得到这些文件资料的来源。
1.5参考资料列出要用到的参考资料，如：a．本项目各处引用的的行业标准、规范；b．属于本项目的其他已经确认的文件；c．本文件中各处引用的文件、资料。
列出这些文件的标题、文件编号、发表日期和出版单位，说明能够得到这些文件资料的来源。
如何规范编写“电气设计说明”？
如何规范编写“电气设计说明”？（1）设计依据中列出与工程无关的设计规范在一些设计依据中除了列有与本工程的设计规范外，还列入与本工程无关的规范，例如《人民防空地下室设计规范》。
经查阅图纸，设计文件从头到尾没有发现人防工程设计内容，建筑专业也没有设计人防地下室。
（2）说明书条文中应用了大量规范语言“应”“应”在规范中表示严格，在正常情况下均应这样做的，它是指导性的词语，在说明书中设计师应落实规范“应”后面的内容，不是指导他人再做设计。
说明书中常出现这样的语句——“配电室‘应’采取防水措施”；“电气竖井‘应’采取防火措施”。
但具体采取什么措施？也没有看到设计图纸。
这个措施要由设计师去实施，设计出防水、防火的图纸。
（3）采用被淘汰产品在防火安全上，常出现“功率大于100W的白炽灯泡安装时应做隔热保护”，实际上白炽灯在住建部《1998~2007年发布的前五批限制和禁止使用的建筑材料目录》中已列入被淘汰产品，设计规范明确规定禁止选用淘汰产品，同时本设计也未选用100W 以上的白炽灯，所以不要画蛇添足，影响设计文件的严谨性。
（4）对施工单位提出相矛盾的要求说明书对承包商提出“未经设计人同意，不得修改图纸”；但又说明“未尽事宜，参见国家或地方相关法律、法规、强制性条文、国家及各行业设计规范、规程、行业条例及工程所在地方的规定和标准”。
这种说明似乎很全面、滴水不漏，实际上两者相互矛盾，有不妥之处。
既然“不得修改”，何必又要参见规范“自行决定”呢？因此，设计图纸要力求完善、正确，避免较大的改动，修改要有程序，有理有据。
（5）10kV系统自动解除三级负荷在10kV两路电源论述中写道，“两路10kV电源采用单母线分段运行，设母联开关，平时两段母线分列运行，当一路断电时，通过手动操作联络开关，另一路电源负担全部一、二级负荷”或“两路10kV电源采用单母线分段运行，设母联开关，平时两段母线分列运行，当一路断电时，联络开关自动投入，另一路电源负担全部一、二级负荷”。
设计说明书格式的要求
设计说明书格式的要求⑴页面设置：①A4纸张，纵向，上下边距 2.5cm，左边距2.6cm，右边距2.6cm，页眉1.8cm，页脚1.5cm，文档网格一律使用“无网格”。
②页眉页脚：页眉设置为：“***毕业设计”，五号字，宋体，居中。
页脚设置为：插入页码（格式：第X页，共X页），居中对齐，从“摘要”页开始设为第１页。
③段落“行距”一律为1.5倍行距。
学⑵题目：2号宋体加粗，居中。
⑶正文：小四号字宋体段前后间距0行左右缩进0字符首行缩进2字符。
⑷正文部分标题：各层次标题一律用阿拉伯数字连续编号，如1，1.1，1.2，2，2.1，2.2等。
一级标题：小3号字，宋体，段前间距0.5行，段后间距0行，左右缩进0字符，首行缩进0字符。
二级标题：4号字，宋体，段前后间距0行，左右缩进0字符，首行缩进0字符。
三级标题：小4号字，宋体加粗，段前后间距0行，左右缩进0字符，首行缩进0字符。
⑸图和表：应精选和精心设计，具有自明性，切忌与文字表述重复。
图要大小适中，线条均匀，主辅线分明。
图中文字、数字、符号要写清楚。
表一律用三线表，应有表序和表题。
图表中的序号和标题应设置为小四号字，黑体，居中。
⑹参考文献：①“参考文献”名称设置为五号黑体顶格，其它设置为宋体，段前间距0.5行，段后间距0行，左右缩进0字符。
②另起一行用五号宋体排列参考文献内容。
③正文引用参考文献处应以方括号标注出。
如“…效率可提高到25%[7]。
”或者“…效率可提高到25%[7]。
”表示此结果援引自文献7。
④参考文献的编写格式为：期刊文献的格式：［编号］作者（注：多个作者之间用逗号，下同）.文章题目名. 期刊名，年份，卷（期）：起页～止页。
例：[1]张三，李四.点与多边形关系的射线法.电脑编程技巧与维护,2008,28:1866-1868.图书文献的格式：［编号］作者.书名.版次.出版地:出版单位，出版年份: 起页～止页。
例：[2]冯泽森，王崇国.计算机文化基础.第三版.北京：电子工业出版社，2007：3-13.会议文献的格式：［编号］作者.文章题目名. 会议地点，会议名（论文集），年份: 起页～止页。
- 1、下载文档前请自行甄别文档内容的完整性，平台不提供额外的编辑、内容补充、找答案等附加服务。
- 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
- 3、如文档侵犯您的权益，请联系客服反馈,我们会尽快为您处理(人工客服工作时间：9:00-18:30)。
＜能耗采集器＞详细设计说明书作者：姜建康完成日期：签收人：签收日期：修改情况记录：目录1 引言 (1)1.1 编写目的 (1)1.2 背景 (1)1.3 定义 (1)1.4 参考资料 (2)2 程序系统的结构 (3)3 程序设计说明 (6)3.1 程序描述 (6)3.2 功能 (6)3.3 性能 (8)3.4 输入项 (9)3.5 输出项 (10)3.6 算法 (10)3.7 流程逻辑 (11)3.8 接口 (11)3.9 存储分配 (12)3.10 注释设计 (12)3.11 限制条件 (13)3.12 测试计划 (13)3.13 尚未解决的问题 (13)1 引言1.1 编写目的本说明书是山东确信信息产业股份有限公司的“数据采集器”系统项目产品的详细设计说明，主要任务是根据需求规格说明确定设计目标，以及它们的优先顺序，并根据目标确定最适合的设计方法，制定各种规范。
将系统按功能划分成模块的层次结构。
确定每个模块的功能，建立与已确定的软件需求的对应关系。
确定模块之间的调用关系，确定模块之间的接口，即模块之间传递的消息。
设计好接口的信息结构，评估模块划分的质量及导出模块结构的规则。
完成数据库设计，避免数据大量冗余软件开发小组和详细设计的每一位参者与开发成员应该阅读本说明书，清楚产品在数据的准确性和完整性方面的要求，本手册将进行数据评审和数据完整性检查，同时为下一步的测试报告提供测试数据。
1.2 背景说明：a．项目系统的名称：公共建筑节能监测系统确信数据采集器；b．项目任务提出者：山东确信信息产业股份有限公司研发中心；c．项目系统开发者：山东确信信息产业股份有限公司硬件开发部；d．项目系统的用户：公共建筑节能监测的用户；1.3 定义GPS Global Position System卫星定位对时系统；BCD 二-十进制编码BIN 二精致编码C 控制域CRC 循环冗余码校验CS 帧校验码RS232制定的一种串行物理接口标准。
RS485 制定的一种串行物理接口标准。
USB USB是英文Universal Serial BUS的缩写，中文含义为“通用串型总线”。
APN 接入点名称Access Point NameDDN 数字数据网Digital Data NetworkDNS 域名系统Domain Name SystemDTU 数据终端单元Data Terminal UnitEMC 电磁兼容Electro Magnetic CompatibilityGPRS 通用分组无线业务 General Packet Radio ServiceGSM 全球移动通信系统 Global System for Mobile CommunicationsIP 互联网协议 Internet ProtocolPAP 密码授权协议Password Authentication ProtocolPDP 分组数据协议Packet Data ProtocolRTU 远程终端单元Remote Terminal UnitSIM 用户标识模块Subscriber Identify ModuleTCP 传输控制协议Transmission Control ProtocolUDP 用户自带寻址信息协议User Datagram Protocol1.4 参考资料相关的文档，如：a．山东省工程建筑标准DBJ/T14-071-2010 《公共建筑节能监测系统技术规范》；b．CJ 188-2004-T 户用计量仪表数据传输技术条件；c．DLT 645-1997多功能电能表通信规约d．DLT_645-2007_多功能电能表通信协议2010e．山东确信信息产业股份有限公司内部文件《子系统与遥测终端机的通讯协议协议-20120614-V1.0》f．山东确信信息产业股份有限公司内部文件《采集终端与仪表通讯协议DL-T645-1997》g．山东确信信息产业股份有限公司内部文件《采集终端与仪表通讯协议DL-T645-2007》h．山东确信信息产业股份有限公司内部文件《采集终端与仪表通讯协议DL-T645-2004》i．山东确信信息产业股份有限公司内部文件《采集终端与仪表通讯协议MODBUS》参考数据a．ARM9 MC9260 Linux 开发环境搭建开发板b．MC9260_GKA硬件手册c．MC9260-GKA Linux 系统配置d．MC9260-GKA Linux系统烧写e．MC9260-GKA 快速开始f．MC9260核心板硬件手册2 程序系统的结构下面一系列图表列出本程序系统软、硬件的每个程序（包括每个模块和子程序）的名称、标识符和它们之间的层次结构关系。
图1 确信采集器的总体结构图图2 串口通讯模块连接结构图图3 采集模块的结构图图3 XML 配置方法图 图4 SQLite 数据库存储图采集器流程图5 采集器总体流程图采集器系统在上电后，开始对服务器端进行监听和对配置的XML配置文件进行载入，如果监听时出错或是配置XML文件出错，则程序不能正常运行，提示配置错误。
当正常监听和配置XML文件正常载入时，采集系统开启网络监听线程和接收线程，用来处理连接进来的网络和处理附录H中的协议，设置和查询指令。
采集的时钟线程用来处理时间配置的采集间隔和保存间隔。
当到达采集间隔时，开启6路采集线程对数据进行处理，采集仪表的对应数据存储到字面量的临时存储区中，当到达保存时间时，保存到数据库中。
当有客户端网络连接到采集器时，网络线程对用户下传指令进行采集，对数据进行分析后，回传给网络的客户端用户对应的数据。
配置方式可以通过网络上传XML配置文件，还可以使用WEB 对配置参数进行配置。
3 程序设计说明逐个地给出各个层次中的每个程序的设计考虑。
以下给出的提纲是针对一般情况的。
对于一个具体的模块，尤其是层次比较低的模块或子程序，其很多条目的内容往往与它所隶属的上一层模块的对应条目的内容相同，在这种情况下，只要简单地说明这一点即可。
3.1 程序描述本程序的运行是运行在多线程的状态下，并提供实时的检测设备的功能，程序运行时载入设备的配置文件信息，使程序按照配置信息的内容进行工作，并接受用户的现场和远程修改，配置信息以XML文件形式记录。
程序启动后根据配置信息启动最多5个服务器的连接，来接收服务器端的指令协议，并相应其中的操作。
设备自动更具设定的时间参数对数据进行数据采集和保存，并且实时监控网络连接和对指令响应等；提供对配置文件的手动操作，此功能在初始化安装和对仪表的添加和维护管理中使用，增强数据的准确性和精度。
程序使用SQLite嵌入式数据库实现对数据的存储，实现对数据的保留和查询。
3.2 功能山东确信信息产业股份有限公司采集器终端程序应具有的功能如下：基本功能：1.服务器端的监听维护2.客户端网络连接的数据通讯3.附录H中的指令的功能实现4.配置文件的读取、修改、保存实现（指令、WEB、COM、FTP）5.实现645-1997、645-2004、645-2007、MODBUS多协议的切换6.对SQLite的移植和使用7.RS485采集的指令（不同协议）和收发的实现8.外部的FTP、TELNET、WEB的操作实现采集器系统基本功能响应召测查询：响应子系统召测命令发送相应数据，返回查询当前的总显示数值。
定时采集：当到达采集的时间间隔时，通过采集线程对RS485连接的仪表的数据进行采集，并解析返回的指令数据保存到字面量中。
响应子系统的设置命令，可以设置终端采集器的地址。
具有远端设置采集器密码功能。
具有时钟同步功能。
具有在采集器数据存储功能，保证数据不丢失，便于数据整编，存储在TF卡中，实现存储数据的现场保存。
内置或外置接入（人工配置），可实现人工设置、查询等。
可外接计算机本地编程、组态、诊断、数据下载、维护等。
具有固态存储功能（实现TF保存），可外接计算机读取原始数据或历史数据下载；具有历史数据远程下载功能。
能最多连接5个客户端的连接；具有多种通讯接口：可外接超短波电台、PSTN（拨号MODEM）、Inmarsat-C Modem、GSM/GPRS MODEM、V AST、北斗卫星、全线通卫星、RS485、RS232等，并实现自动主备信道切换；超短波电台方式下传输速率1200BPS/2400BPS，发射机功率5-25W可调，其他方式传输速率用户自由定义，一般选择9600BPS；当到达采集数据间隔时，自动采集并主动存储到临时存储区的字面量中，当用户发送查询指令时向用户发送采集到的数据，同时还可以按照保存间隔把临时存储区中的数据保存到数据库中。
用户可设置查询产品信息的内容，包括厂商的代号、产品编号、硬件版本号、软件版本号；用户还可以设置查询采集器终端的运行参数，包括心跳周期、采集周期、历史数据保存周期；用户还可以设置仪表的仪表序号、仪表类型、通讯速率和端口号、仪表通讯地址、数据采集方按。
采集协议包括：645-1997 、645-2004、645-2007、MODBUS（可自定义）支持RJ-45和GPRS （CDMA）通信方式传输数据，采集器可选择向一个或多个（子系统或）发送实时数据。
采用定时采集查询返回的工作机制，把遥测站的信息发回子系统，定时间隔1-1440分钟可设置。
采集数据：采集器按照采集间隔来采集各个总线上仪表的仪表的数据。
保存数据：采集器按照保存间隔来把采集各个总线上仪表的仪表的数据，存储到TF卡中的数据库中。
参数设置：采集器地址、采集器密码、采集器RTC时钟、采集器运行参数、仪表的配置参数、产品信息内容。
数据存储：采集器配置大容量非易失存储模块（2G），可存储1年天的数据，可以通过GPRS或RJ-45 远程读取，读取的最小时间间隔为1天。
响应召测：采集器能响应子系统远程资料召测命令，将固态存储数据上传到子系统。
双向确认：采集器给子系统发送数据；采集器收到修改配置命令后，首先修改系统配置，然后读出已修改的配置，返回一条确认核对信息。
扩展接口：采集器预留4路模拟量的传感器输入口，以实现今后对温度等参数的自动采集，并处理传输。
测试功能：提供测试状态，保证在检修和维护时产生的数据进行显示。
3.3 性能说明对该程序的全部性能要求，包括对精度、灵活性和时间特性的要求。
正向有功（总电能）：目前使用XXXXXX.XX来表示，表示的范围000000.00-999999.99的刻度使用的单位为千瓦时。
正向无功（总电能）：目前使用XXXXXX.XX来表示，表示的范围000000.00-999999.99的刻度使用的单位为Kvarh（千乏时）。
三向电流：A相电流、B相电流、C相电流，目前使用格式XX.XX形式表示，有2个字节格式，表示的电流的范围为00.00-99.00 ，单位为A（安培），数据精度精确到小数点的2位。