设计文档编写规范
一.项目立项文档编写规范
(一)规范文档清单
①立项申请报告
②可行性研究报告
③可行性研究评审报告
④产品规格说明书
(二)规范文档内容
(1)立项申请报告
本文档用来说明开发项目的主要内容和达到的目标〈主要技术指标〉、经费概算及计划完成时间等。具体编写内容如下:
关键词:
摘要:
缩略语说明：列出本文档中用到的所有非通用的缩写与略语的全称、专门术语的定义。
参考资料:列出本文档所引用的参考资料的名称、作者、标题、编号、出版日期、出版单位。
1.引言
2.项目名称、型号、项目来源、承担部门
3.项目的根据及必要性
4.国内外技术水平比较和发展趋势
5.开发项目的目标和主要技术指标
6.研究方向的选择或初步设想的方案和主要技术途径
7.需要解决的重大关键技术问题
8.工业标准化技术或产品以及公司内成熟技术或产品的利用情况
9.关键器材、设备及必要条件
10.经济合理性分析和经费
11.研究进度(起止时间)
12.成果形式
13.项目负责人及主要成员
14.其它
15.评审报告
预审意见:
1.研究方向与公司发展领域的一致性
2.关键技术的可实现性
3.工业标准化技术或产品以及公司内成熟技术或产品的利用率
4.进度、经费合理性
5.结论及应采用的开发策略
6.审核者姓名，职务或职称及日期
7.其它
(2)可行性研究报告
本文档主要论证开发项目在技术上和经济上实现的可行性、市场可行性以及专利可行性。具体编写内容如下：
关键词：
摘要：
缩略语说明：
参考资料：
1.引言
2.开发目标
3.功能、性能及主要技术指标
4.国内外现状及发展趋势，分析可能的替代技术或产品所引发的产品生命周期问
题。
5.技术可行性分析
技术可行性分析可包括以下内容：
●技术关键
●技术途径
现有公司的技术条件及可供利用共享的程度，可利用合作资源及知识产权现状。
●试用方法
●风险分析
●现有测试条件及设备条件
6.市场可行性分析
●产品在国内外的销售数量
●市场预测的调查和估计
●竞争对手情况分析
7.人力资源需求情况
分阶段提出产品开发各阶段所需各类人员
8.经济可行性分析
经济可行性分析可包括以下内容：
●经济效益估计，包含整个估计的产品生命周期
●现有研究设备情况
●研究成本估计
包括仪器设备费、样机材料费、对外合作费用、产品产生效益后的在开发费用、产品维护等费用及其它人力费用。
9.专利可行性分析
●专利情报检索、分析（国内、国外）
●科技情报及对手技术分析
●专利申请策略
●制定专利技术合作、许可、借鉴、策略
10.阶段计划
确定各阶段的分目标研究内容及成果形式
11.详细计划和成果形式
详细计划的安排及落实措施，预计进行哪种鉴定。
12.对外合作单位情况和分工意见
包括以下内容：
●对外合作的单位名称
●合作单位的实力分析
●委托项目及完成日期
●备注
13.其它
(3)可行性研究评审报告
可行性研究评审报告是按立项申请报告的要求，对可行性研究报告中关于开发
项目的技术可行性、经济可行性、市场可行性、专利可行性和人员需求情况的审查核实和评议，最后提出的可行性研究评审报告。具体编写内容如下:
关键词:
摘要:
缩略语说明:
参考资料:
1.引言
2.开发项目名称、项目代码及型号
3.系统的开发目标、功能、性能和主要技术指标
4.可行性评审内容
4.1技术可行性评审
●技术关键
●技术途径
●现有公司的技术条件
●试验方法
●风险分析
●测试条件及设备条件
4.2经济可行性评审
●经济效益评估
●现有开发环境和设备
●研究成本估算
4.3市场可行性评估
●销售数量
●市场预测
●竞争对手状况
4.4专利可行性评审
●国外专利状况(借鉴利用)
●国内专利状况(合作、许可)
●主要竞争对手技术现状评估
●专利申请策略
5.人员需求情况评审
研究小组核心成员能否到位，人员需求合理性。
6.结论
经过对可行性报告逐项评审后，编写可行性评审报告，除对可行性报告中的准确性给予结论意见外，若有不够之处，还可提出改进意见或存在问题，以利修改。给出应采用的开发策略。
7.评审者姓名，职务或职称及日期。
8.其它
(4)产品规格说明书
产品规格说明书是对产品用途、性能、结构特征、基本工作原理和使用等说明，具体编写内容如下:
关键词:
摘要:
缩略语说明:
参考资料:
1.引言
2.产品的名称和型号
3.用途、性能及使用要求
简述产品用途和性能，详细说明产品的使用要求(环境条件、注意事项等等)。
4.技术参数
5.基本工作原理
按本产品的使用要求，以通俗易懂的文字和必要的图样、略图、简要说明产品的基本工作原理。
6.结构特征
简要说明本产品的结构特征(如外形尺寸、安装只寸等)可用外形图、安装图及有关图形符号等表明其主要的结构情况和功能原理。
7.应用指南
对本产品的应用环境和应用方法以及可能的配置及配套情况作全面描述，并举例说明
8.其它
二．总体方案书编写规范
关键词:
摘要:
缩略语说明:
参考资料:
1.引言
2.概述
2.1系统描述
2.2系统功能
2.3开发环境
2.4一般约束
3.系统需求
3.1需求分析
3.2格式要求
3.3功能需求
3.4外部接口需求
3.4.1用户界面
3.4.2硬件接口
3.4.3软件接口
3.4.4通讯接口
3.5性能需求
3.5.1静态数值需求
3.5.2动态数值需求
3.6属性需求
3.6.1可靠性
3.6.2安全性
3.6.3可维护性
3.6.4可移植性
3.6.5兼容性
3.6.6可配置性
3.6.7系统升级
3.6.8属性需求
4.其它
三．软件设计文档编写规范
(一)规范文档清单
①软件需求规格说明书
②软件概要设计说明书
③软件详细设计说明书
④通讯协议说明书
⑤函数调用协议说明书
⑥软件测试方案
⑦软件测试报告
(二)规范文档内容
(1)软件需求规格说明书
关键词：
摘要：
缩略语说明：列出本文档中用到的所有非通用的缩写与略语的全称、专门术语
的定义。
参考资料：列出本文档所引用的参考资料的名称、作者、标题、编号、出版日
期、出版单位。
1.引言
1.l背景
A.用一个名字标识要开发的软件产品。
B.说明软件产品的用途。
1.2参考资料
2.概述
2.1产品的描述
2.1.1如果被开发软件是独立的，则应在本节描述被开发软件概况。
2.1.2如果本软件系统是一个较大的系统或项目中的一个组成部分，那么概
述这个较大的系统或项目的每一个组成部分的功能，并标识其接口；标识
被开发软件的主要外部接口。用图形表达其主要组成、相互联系和外部接口是非常直观的。
2.2产品的功能
简明叙述被开发软件的功能。内容可以直接从较高层次的规格说明中引用。
2.3开发环境
列出所采用的操作系统、编程语言、编程工具(编译器和调试器)、数据库平台和网络平台。
2.4一般约束
A.硬件的限制
B.与其他应用系统的接口
3.具体需求
3.1功能需求
描述软件产品的输入经过什么处理转换为输出，必须描述在软件中进行的基本操作。对于每一类功能或者对于每一个功能，需要描述其输入、处理和输出等需求。
3.1.1功能需求1
3.1.1.1引言
描述完成本功能的目的、所使用的方法和技术，还应当包括可以清楚说明本功能意图的来源或背景材料。
3.1.1.2输入
A.对本功能全部输入数据的详细描述，它们包括输入源、数量、度量单位、
时间关系、有效输入的范围、精度和公差。
B.操作员具体的控制需求，其中包括操作员活动的描述，控制台或操作员
的位置等。
C.指明引用的接口规格说明或相应的接口控制文档。
3.1.1.3输出
A.输出的目的地；
B.有效输出的范围、精度和公差；
C.非法值的处理；
D.错误信息。
3.l.2功能需求2
3.1.N功能需求N
3.2外部接口需求
3.2.1用户界面
A.用户使用软件产品时的界面需求。例如，如果系统的用户通过显示终端
操作，就必须指定如下需求：对屏幕格式的要求，报表或菜单的页面显示格式和内容，有关输入和输出的时间，用户命令的形式；
B.界面的优化问题。可以简单地用一个表列出系统用户做什么或不做什
么。例如，要求的是长的还是短的出错信息。与其他需求一样，这种需求也应该是可验证的。
3.2.2硬件接口
陈述软件产品与系统硬件设备之间每一个接口的逻辑特点。还可能包括如下事宜：要支持什么样的设备，如何支持这些设备，如何约定。
3.2.3软件接口
陈述其它有关软件(如数据库管理系统、操作系统、或者数学软件包)的使用方法，以及同其它相连接软件的接口。对每一个有关的软件产品，应该提供如下内容：
A.名字
B.助记符
C.版本号
对于每个与其它软件的接口，本部分应：
A.描述在与本软件产品相连接的软件的基本功能，以及达到的目的。
B.描述传递信息的内容、格式和接口定义。对于己有完整文档的接口，只
需要引用描述该接口的文档。
3.2.4通讯接口
说明各种通讯接口。例如局部网络协议等。
3.3性能需求
从整体上说明对该软件、或人与该软件相互作用的静态或动态数值需求。
3.3.1静态数值需求包括
A.支持的终端数
B.支持的同时操作的用户数
C.处理的文件和记录数
D.表和文件的大小
E.对数据的精度要求，包括数学的、逻辑的和传输的精度等。
3.3.2动态数值需求可以包括诸如处理和任务的数量，以及在正常情况下和
峰值工作条件下，在一定时间周期中要处理的数据总数。有关响应时间、更新处理时间、数据转换和传输时间也在这一部分陈述。
3.4设计约束
说明需遵守的其它标准和硬件限制等设计约束。
3.4.1需遵守的其它标准
A.报表格式
B.数据命名
C.检查追踪
3.4.2硬件限制
描述各种影响或约束软件产品的硬件成分，应包括：
A.硬件配置的特点(接口数，指令系统等)；
B.主存贮器和辅助存贮器的容量；
C.CPU速度。
3.5属性需求
在软件的具体需求中可以有若干属性。
3.5.1可靠性
3.5.2安全性
指出保护软件的要求，以防止突然或非法的访问、使用、修改或者泄密。
3.5.3可维护性
指定若干需求，以确保软件是可维护的。
3.5.4可移植性
列出确保用户程序和用户界面兼容方面的需求，以及为把被开发软件从一种运行环境移植到另一个运行环境的需求等。
3.6其它需求
由于软件的类型、用户组织的特点等，某些特殊的需求可在下面描述。3.6.1故障处理
列出可能发生的软件和硬件故障，并指出这些故障对各项性能指标所产生
的影响以及对故障处理的要求。
(2)软件概要设计说明书
关键词：
摘要：
缩略语说明：
参考资料：
1.引言
A.待开发软件系统名称。
B.该系统基本概念，如该系统的类型、从属地位等。
D.项目代号。
2.总体设计
2.1系统描述
2.1.1需求规定
对所开发软件的概要描述，包括主要的输入/输出、主要功能、性能等。
2.1.2运行环境规定
描述本系统赖于运行的硬件、软件环境
2.2总体设计说明
2.2.1基本设计概述
列出在描述、说明总体设计时要用到的一些基本概念，给出其解释说明。
2.2.2设计思想
阐述在进行总体设计时的基本考虑。结合设计限制，说明如何根据这些设
计限制进行综合考虑后而建立起目标系统的总体结构及功能划分；亦可将
所考虑过的多个总体设计作对比分析，说明选择当前总体结构的原因。
2.3系统结构和处理流程
2.3.1系统结构
用框图形式说明目标系统的模块划分，扼要说明每个模块的标识符和功能，
分层次地给出各元素之间的控制与被控制关系。
3.接口设计
3.1外部接口
3.1.1用户接口
列出系统将向用户提供的操作命令、功能说明和用法描述，系统的响应信息及其含义。
3.1.2硬件接口
说明本系统的硬件接口的设计安排。
3.1.3软件接口
说明本系统的软件接口的设计安排。
3.1.4通讯接口
说明本系统的通讯接口的设计安排。
3.2内部接口
说明本系统内各功能模块间的接口设计。
4.属性设计
说明系统对以下三个方面的属性所作的特殊设计和考虑。
4.1可靠性
4.2安全性
4.3可维护性
5.系统数据结构
5.1逻辑结构设计要点
说明系统主要数据的逻辑结构，包括定义、存储要求、一致性约束条件等。
5.2数据结构与模块的关系
可采用矩阵图形式，并规定以下符号
C创建 U更新 R读出使用
6.运行设计
说明对系统运行时的顺序、控制、时间等的设计安排。
7.系统出错处理
7.1出错类别
对系统对可能出现的某些错误和故障作了专门的设计考虑，并给出这些错误或故障的定义。
7.2出错处理
说明将使用的恢复或再启动技术，使软件从故障点恢复执行或软件从头开始重新运行的方法。
8.开发环境
8.1硬件环境
列出开发本系统所需要的硬件平台、工具等。
8.2软件环境
列出开发本系统所需要的软件平台，如操作系统、数据库、网络平台、软
件辅助工具及使用周期等。
9.系统调试与测试方法
9.l调试方法
说明系统调试的环境、工具，应观察的结果等。
9.2测试方法
说明集成测试的方法(从下而上或从上而下)、模块测试的顺序，给出辅助
模块、驱动模块及测试用例，说明这些测试用例的选取原则。
(3)软件详细设计说明书
关键词：
摘要：
缩略语说明：
参考资料：
1.引言
说明是哪个系统或何种系统的哪个模块的软件详细设计说明书。
2.设计思想
阐述在进行设计时的基本考虑。结合设计限制，说明如何根据这些设计限制进行综合考虑后而建立起目标系统的结构及功能划分；亦可将所考虑过的多个设计作对比分析，说明选择当前结构的原因。
3.软件结构
3.1功能需求
详细描述其功能，若是模块，应描述它所处的大系统中的位置、与系统的
关系及相关模块的关系。
3.2子模块划分
用图形说明本系统(或模块)的实现，即系统内部的子模块划分。
3.3子模块间关系
说明各子模块间的控制、顺序等藕合关系。
4.公共数据结构
给出本系统使用的每一个公共数据结构的类型定义、存储方式，公共数据结构内各元素项的类型定义、初始取值、可能取值的范围及相应的物理含义。建议以类似C语言的数据说明格式来描述。
5.程序1
5.1输入
详细说明本程序的输入参数，包括取值范围、含义，参数间的控制、顺序、
独立或依赖等关系。
5.2输出
详细说明本程序的输出参数，包括取值范围、含义，参数间的控制、顺序、
独立或依赖等关系。
5.3返回
说明返回值的含义
6.程序2
N.程序m(结构与5相同)
(4)通讯协议说明书
关键词：
摘要：
缩略语说明：
参考资料：
1.引言
1.1背景
说明本文档所属的软件项目名称。
1.2硬件环境
用图形方式描述通讯双方的硬件环境构成及通讯物理链路。
1.3功能说明
简述通讯双方各自的功能，说明通讯目的。
2.通讯协议
2.1命令格式
含发命令格式及收命令格式，说明每一项的数据类型和含义。
2.2命令描述
说明每一种命令的具体格式、含义及要求的应答格式，该部分内容的编写
要依据各自的特点编写。例如可分类描述，若有命令码编写规则要专门描
述，描述的原则是清晰、完整、易懂。
(5)函数调用协议说明书
关键词：
摘要：
缩略语说明：
参考资料：
1.引言
l.1背景
说明本文档属于哪个软件项目。
1.2硬件环境
用图形方式描述通讯双方的硬件环境构成及通讯物理链路。
1.3功能说明
简述通讯双方各自的功能，说明通讯的可靠性及速率要求。
2.函数调用说明
(6)系统对接联调说明书
1 引言
1.1 编写目的
1.2 用途
1.3 参与对接联调的人员名单
1.4 对接联调起始时间
2 用户系统
3 本系统设备配置
5 对接安装步骤
6 发现的问题
7 适应性修改
8改进建议
(7)软件测试计划
关键词：
摘要：
缩略语说明：
参考资料：
1.测试计划名称
为本测试计划书定义一个专用名称。
2.引言
归纳所要求测试的软件项和软件特性，可以包括系统目标、背景、范围及引用材料等。在最高层测试计划书中，如果存在下述文件，则需要引用它们：项目计划、质量保证计划、有关的政策、有关的标准等。
3.测试项
描述被测试的对象，包括其版本、修订级别，并指出在测试开始之前对逻辑或物理变换的要求。
4.被测试的特性
指明所有要被测试的软件特性及其组合，指明每个特性或特性组合有关的测试设计说明。
5.不被测试的特性
指出不被测试的所有特性和特性的有意义的组合及其理由。
6.方法
描述测试的总体方法，规定测试指定特性组所需的主要活动、技术和工具，应详尽地描述方法，以便列出主要的测试任务，并估计执行各项任务所需的时
间。规定所希望的最低程度的测试彻底性，指明用于判断测试彻底性的技术
(如：检查哪些语句至少执行过一次)。指出对测试的主要限制，例如：测试项
可用性、测试资源的可用性和测试截止期限等。
7.测试项通过准则
各测试项通过测试的标准。
8.暂停标准和再启动要求
规定用于暂停全部或部分与本计划有关的测试项的测试活动的标准，规定当测试再启动时必须重复的测试活动。
9.应提供的测试文件
规定测试完成后所应递交的文件，这些文件可以是前述文件的全部或者部分。
10.测试任务
指明执行测试所需的任务集合，指出任务间的一切依赖关系和所需的一切特殊技能。
11.环境要求
规定测试环境所必备的和希望有的性质，其中包括硬件、通信和系统软件的物理特征、使用方式以及任何其它支撑测试所需的软件或设备，指出所需的
特殊测试工具及其它测试要求，指出测试组目前还不能得到的所有要求的来
源。
12.职责
指出负责管理、设计、准备、执行、监督、检查和仲裁的小组，指出负责提供测试项和提供测试环境的小组。这些小组可包括开发人员、测试人员、操
作员和质量保证人员。
13.人员和训练要求
指明测试人员应有的水平以及为掌握必要技能可供选择的训练科目。
14.进度
在软件项目进度中规定的测试起点以及所有测试项传递时间。定义所需的新的测试起点，估计完成每项测试任务所需的时间，为每项测试任务规定进度，对每项测试资源规定使用期限。
(8)软件测试报告
关键词：
摘要：
缩略语说明：
参考资料
1．测试任务名称和内容
2．模块功能概述
3．测试项目
3.1 测试项目一
3.1.1 目的
3.1.2 测试环境与版本
3.1.3 输入
3.1.4 预期结果
3.1.5 实际结果
3.1.6 异常现象及分析
3.1.7 环境影响分析
3.1.8 测试人员和日期
3.1.9 重复执行结果
3.2 测试项目二
…
3.N 测试项目N
4．测试充分性评价
5．结果分析
6．测试结论
四．硬件设计文档编写规范
(一)规范文档清单
①硬件需求规格说明书
②硬件概要设计说明书
③单板硬件概要设计说明书
④单板硬件详细设计说明书
⑤单板软件详细设计说明书
⑥单板硬件过程调试报告
⑦单板软件过程调试报告
⑧单板硬件测试报告
⑨硬件系统联调报告
(二)规范文档内容
(1)硬件需求规格说明书
硬件需求规格说明书是描写硬件设计目标、基本功能、基本配置、主要性能
指标、运行环境、约束条件以及开发经费和进度等要求，它的基本依据是《产品需求规格说明书》及《总体方案书》。它是硬件总体设计和制订硬件开发计划的依据。具体编写内容如下：
关键词：
摘要：
缩略语说明：列出本文档中用到的所有非通用的缩写与略语的全称、专门术语的定义
参考资料：列出本文档所引用的参考资料的名称、作者、标题、编号、出版日期、出版单位。
1.引言
2.开发项目的名称和型号
3.系统历史及修改说明
4.基本配置
5.运行环境
6.硬件整体系统的基本功能和主要性能指标
7.硬件分系统的基本功能和主要性能指标
8.功能模块的划分
9.关键技术的攻关
10.外购硬件的名称、型号、生产单位、主要技术指标
11.主要仪器设备
12.国内外同类产品的技术介绍
13.开发经费
14.开发进度及文档计划
15.其它
(2)硬件概要设计说明书
《硬件概要设计说明书》是根据《需求规格说明书》、《总体方案书》及《硬件需求规格说明书》的要求进行设计后编制的报告，它是硬件详细设计的依据，具体编写内容如下：
关键词：
摘要：
缩略语说明：
参考资料：
1.引言
2.开发项目的名称和型号
3.系统历史及修改说明
4.功能及主要性能指标
5.系统总体结构图及功能划分
6.单板命名
7.系统逻辑框图
8.组成系统各功能块的逻辑框图、电路结构图及单板组成
9.单板逻辑框图和电路结构图
10.关键技术讨论
11.关键器件
12.可靠性、安全性、电磁兼容性讨论
13.电源设计
14.工艺、结构设计初步
15.包装设计
15.硬件联调测试方案
16.其他
(3)单板硬件概要设计说明书
关键词：
摘要：
缩略语说明：
参考资料：
1.概述
2.单板版本号、单板在整机中的位置、开发目的及主要功能
3.单板功能描述、单板尺寸(单位)
4.单板逻辑框图及各功能模块说明
5.单板软件功能描述
6.单板软件功能模块划分
7.接口简单定义、与相关板的关系
8.指标(主要性能指标、功耗、采用标准)
＜项目名称＞ 软件需求说明书 作者： 完成日期： 签收人： 签收日期： 修改情况记录：
目录 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 假设和依据 (3) 3 具体需求 (3) 3.1 功能需求 (3) 3.1.1 功能需求1 (3) 3.1.2 功能需求2 (4) 3.1.n 功能需求n (5) 3.2 外部接口需求 (5) 3.2.1 用户接口 (5) 3.2.2 硬件接口 (5) 3.2.3 软件接口 (5) 3.2.4 通信接口 (6) 3.3 性能需求 (6) 3.4 设计约束 (6) 3.4.1 其他标准的约束 (6) 3.4.2 硬件的限制 (7) 3.5 属性 (7) 3.5.1 可用性 (7) 3.5.2 安全性 (7) 3.5.3 可维护性 (7) 3.5.4 可转移＼转换性 (8) 3.5.5 警告 (8) 3.6 其他需求 (8) 3.6.1 数据库 (8) 3.6.2 操作 (8) 3.6.3 场合适应性需求 (9) 4 附录 (9)
1 引言 1.1 编写目的 说明编写这份软件需求说明书的目的，指出预期的读者范围。 1.2 范围 说明： a．待开发的软件系统的名称； b．说明软件将干什么，如果需要的话，还要说明软件产品不干什么； c．描述所说明的软件的应用。应当： 1）尽可能精确地描述所有相关的利益、目的、以及最终目标。 2）如果有一个较高层次的说明存在，则应该使其和高层次说明中的类似的陈述相一致（例如，系统的需求规格说明）。 1.3 定义 列出本文件中用到的专门术语的定义和缩写词的原词组。 1.4 参考资料 列出要用到的参考资料，如： a．本项目的经核准的计划任务书或合同、上级机关的批文； b．属于本项目的其他已发表的文件； c．本文件中各处引用的文件、资料，包括所要用到的软件开发标准。 列出这些文件的标题、文件编号、发表日期和出版单位，说明能够得到这些文件资料的来源。
系统设计报告编写规范 沈阳东大阿尔派软件股份有限公司 （版权所有，翻版必究） 文件修改控制 目录 1. 目的 2. 适用范围 3. 术语及缩略语 4. 编写规范 4.1排版规范 4.2模板使用 5. 引用文件 6. 附录
1.目的 系统设计报告主要为使软件产品和软件项目满足规定的软件规格要求而确定软件系统的体系结构、组成成分、数据组织、模块、内外部接口。主要任务有： 1)建立软件产品和软件项目目标系统的总体结构。对于大规模软件系统，应分为若干 子系统，在本报告中只说明总体设计，然后为每个子系统编写《系统设计报告》； 2)总体设计； 3)模块设计； 4)涉及使用数据库的设计需编写数据库设计。 2.适用范围 适用于软件开发设计阶段的《系统设计报告》的编写。 3.术语及缩略语 本程序采用NQ402100《质量手册》中的术语和缩略语及其定义。 4.编写规范 4.1排版规范 1）整个规范由2节构成，模板单独一节。 2）正文样式采用“规范正文”。 3）标题编号采用每节独立编号。 4.2模板使用 系统设计报告的编写可依据具体情况选用摸板的格式或编写指南的格式。 1）拷贝规范。 2）删除第一节（系统设计报告封面前的所有页）。 3）在修改完内容后，更新目录域和相关的页数域。 5.引用文件 (无) 6.附录 以下部分为系统设计报告的模板与编写指南。
密级：机密 文档编号：第版分册名称：第册/共册项目名称（项目编号） 系统设计报告 （部门名称） 沈阳东大阿尔派软件股份有限公司 目录 1. 引言............................................................................................................... 错误！未定义书签。 1.1目的...................................................................................................... 错误！未定义书签。 1.2背景...................................................................................................... 错误！未定义书签。 1.3术语...................................................................................................... 错误！未定义书签。 1.4参考资料.............................................................................................. 错误！未定义书签。 2. 总体设计....................................................................................................... 错误！未定义书签。 2.1系统运行环境...................................................................................... 错误！未定义书签。 2.2软件功能描述...................................................................................... 错误！未定义书签。 2.3软件结构.............................................................................................. 错误！未定义书签。 2.4技术路线.............................................................................................. 错误！未定义书签。 2.5外部接口.............................................................................................. 错误！未定义书签。 2.5.1 用户接口 .......................................................................................... 错误！未定义书签。 2.5.2 软件接口 .......................................................................................... 错误！未定义书签。 2.5.3 其它接口 .......................................................................................... 错误！未定义书签。 3. 模块设计....................................................................................................... 错误！未定义书签。 3.1功能...................................................................................................... 错误！未定义书签。
附2: 软件文档编写向导 文档分类 项目包括如下几类文档： 项目管理文档。包括：《软件项目计划》、《项目进度报告》、《项目开发总结报告》 软件开发文档。包括：《需求规格说明》、《概要设计说明》、《详细设计说明》、《测试计划》、《软件测试分析报告》。 产品文档。包括：《用户操作手册》《演示文件》。 软件项目计划 （Software Project Plan） 一?引言 1?编写目的（阐明编写软件计划的目的，指出读者对象。） 2?项目背景（可包括：（1 ）项目委托单位、开发单位和主管部门；（2）该软件系统与 其他系统的关系。） 3?定义（列出本文档中用到的专门术语的定义和缩略词的原文。） 4?参考资料（可包括：文档所引用的资料、规范等；列出资料的作者、标题、编号、发 表日期、出版单位或资料来源。） 二?项目概述 1.工作内容（简要说明项目的各项主要工作，介绍所开发软件的功能性能等?若不编写可行性研究报告，则应在本节给出较详细的介绍。） 2.条件与限制（阐明为完成项目应具备的条件开发单位已具备的条件以及尚需创造的 条件?必要时还应说明用户及分合同承包者承担的工作完成期限及其它条件与限制。） 3.产品 （1）程序（列出应交付的程序名称使用的语言及存储形式。） （2）文档（列出应交付的文档。） （3 ）运行环境（应包括硬件环境软件环境。） 4?服务（阐明开发单位可向用户提供的服务?如人员培训安装保修维护和其他运行支持。 5.验收标准
三.实施计划 1.任务分解（任务的划分及各项任务的负责人。） 2?进度（按阶段完成的项目，用图表说明开始时间完成时间。） 3?预算 4?关键问题（说明可能影响项目的关键问题，如设备条件技术难点或其他风险因素，并说明对策。） 四.人员组织及分工 五.交付期限 六.专题计划要点（如测试计划等。） 项目开发进度报告 一.报告时间及所处的开发阶段 二.给出进度 1.本周的主要活动 2.实际进展与计划比较 三.所用工时（按不同层次人员分别计时。） 四.所有机时 五.工作遇到的问题及采取的对策 六.本周完成的成果 七.下周的工作计划 八.特殊问题 项目开发总结报告 一.引言 1.编写目的（阐明编写总结报告的目的，指明读者对象。） 2.项目背景（说明项目的来源、委托单位、开发单位及主管部门。） 3.定义（列出报告中用到的专门术语定义和缩写词的原意。） 4.参考资料（列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源，可包括： （1 ）项目开发计划；（2 ）需求规格说明书；（3 ）概要设计说明书；（4 ）详细设计说明
工程设计资质标准
为适应社会主义市场经济发展，根据《建设工程勘察设计管理条例》和《建设工程勘察设计资质管理规定》，结合各行业工程设计的特点，制定本标准。一、总则 （一）本标准包括21个行业的相应工程设计类型、主要专业技术人员配备及规模划分等内容（见附件1: 工程设计行业划分表，附表2：各行业工程设计主要专业技术人员配备表，附件3：各行业建设项目设计规模划分表）。 （二）本标准分为四个序列： 1、工程设计综合资质 工程设计综合资质是指涵盖21个行业的设计资质。 2、工程设计行业资质 工程设计行业资质是指涵盖某个行业资质标准中的全部设计类型的设计资质。3、工程设计专业资质 工程设计专业资质是指某个行业资质标准中的某一个专业的设计资质。 4、工程设计专项资质 工程设计专项资质是指为适应和满足行业发展的需求，对已形成产业的专项技术独立进行设计以及设计、施工一体化而设立的资质。 （三）工程设计综合资质只设甲级。工程设计行业资质和工程设计专业资质设甲、乙两个级别；根据行业需要，建筑、市政公用、水利、电力（限送变电）、农林和公路行业可设立工程设计丙级资质，建筑工程设计专业资质设丁级。建筑行业根据需要设立建筑工程设计事务所资质。工程设计专项资质可根据行业需要设置等级。 （四）工程设计范围包括本行业建设工程项目的主体工程和配套工程（含厂/矿区内的自备电站、道路、专用铁路、通信、各种管网管线和配套的建筑物等全部配套工程）以及与主体工程、配套工程相关的工艺、土木、建筑、环境保护、水土保持、消防、安全、卫生、节能、防雷、抗震、照明工程等。 建筑工程设计范围包括建设用地规划许可证范围内的建筑物构筑物设计、室外工程设计、民用建筑修建的地下工程设计及住宅小区、工厂厂前区、工厂生活区、小区规划设计及单体设计等，以及所包含的相关专业的设计内容（总平面布置、竖向设计、各类管网管线设计、景观设计、室内外环境设计及建筑装饰、道路、消防、智能、安保、通信、防雷、人防、供配电、照明、废水治理、空调设施、抗震加固等）。
231 GB 8567－88软件开发主要文档编写规范 本附录中列出了《计算机软件产品开发文件编制指南》GB 8567－88中主要软件文档的编写说明，供编写时参考。这些文档主要是：可行性研究报告、项目开发计划、软件需求说明书、概要设计说明书、详细设计说明书、模块开发卷宗、测试计划、测试分析报告、项目开发总结报告。 一、可行性研究报告 l 引言 1.1 编写目的 说明：说明本可行性研究报告的编写目的，指出预期的读者。 1.2 背景 说明： a ．所建议开发的软件系统的名称。 b ．本项目的任务提出者、开发者、用户及实现该软件的计算中心或计算机网络。 c ．该软件系统同其他系统或其他机构的基本的相互来往关系。 1.3 定义 列出本文件中用到的专门术语的定义和外文首字母组词的原词组。 1.4 参考资料 列出用得着的参考资料，如： a ．本项目的经核准的计划任务书或合同、上级机关的批文。 b ．属干本项目的其他已发表的文件。 c. 本文件中各处引用的文件、资料，包括所需用到的软件开发标准。 列出这些文件资料的标题、文件编号、发表日期和出版单位，说明能够得到这些文件资料的来源。 2 可行性研究的前提 说明对建议开发项目进行可行性研究的前提，如要求、目标、条件、假定和限制等。 2.1 要求 说明对所建议开发软件的基本要求，如： a ．功能。 b ．性能。 c ．输出如报告、文件或数据，对每项输出要说明其特征，如用途、产生频度、接口以及分发对象。 d. 输入说明。系统的输入包括数据的来源、类型、数量、数据的组织以及提供的频度。 e ．处理流程和数据流程。用图表的方式表示出最基本的数据流程和处理流程，并输之以叙述。 f. 在安全与保密方面的要求。 g. 同本系统相连接的其他系统。 h. 完成期限。 2.2 目标 说明所建议系统的主要开发目标，如： a. 人力与设备费用的减少。 b. 处理速度的提高。 c. 控制精度或生产能力的提高。
附录五国家标准《计算机软件产品开发文件编制指南》国家标准《计算机软件产品开发文件编制指南》（GB 8567—88）是一份指导性文件。它建议在软件的开发过程申编下述14个文件：可行性研究报告、项目开发计划、软件需求说明书、数据要求说明书、总体设计说明书、详细设计说明、数据库设计说明书、用户手册、操作手册、模块开发卷、测试计划、测试分析报告、开发进度表、项目开发总结。该指南给出了这14个文件的编制提示，它同时也是这14个文件编写质量的检验准则。下面详细介绍这14种文件的编写目的与内容要求。 l、可行性研究报告 可行性研究报告的目的是：说明该软件开发项目的实现在技术上、经济上和社会条上的可行性，论述为了合理地达到开发目标而可能选择的各种方案，说明并论证所选定的方案。可行性研究报告的编写内容见表l。 表l 可行性研究报告 2、项目开发计划 编制项目开发计划的目的是用文件的形式，并在开发过程中各项工作的
负责人员、开发进度、经费预算、所需软硬件条件等问题做出的安排记录下来，以便根据本计划开展和检查项目的开发工作。编制内容要求如表2所示。 表 2 项目开发计划 3、软件需求说明书 软件需求说明书的编制是为了使用户和软件开发人员双方对该软件的初始规定有一个共同的理解， 使之成为整个软件开发工作的基础。其内容要求见表3。 表3 软件需求说明书 4、数据要求说明书 数据要求说明书的编制目的是为了向整个软件开发时期提供关于被处理数据的描述和数据采集要求的技术信息，其内容要求列于表4中。 表4 数据要求说明书
5、概要设计说明书 概要设计说明书又称为总体设计说明书，编制目的是说明对项目系统的设计考虑，包括基本处理流程、组织结构、模块结构、功能配置、接口设计、运行设计、系统配置、数据结构设计和出错处理设计等，为程序的详细设计提供基础。其内容要求见表5。 表5 概要设计说明书 6、详细设计说明书 详细设计说明书又称为程序设计说明，编制目的是说明一个软件系统各个层次中的每一个程序（模块）的设计考虑。 如果软件系统比较简单，层次少，本文件可以不单独编写，有关内容可并入概要设计说明书。详细设计说明书的内容要求见表6。 表6 详细设计说明书 7、数据库设计说明书
软件设计文档国家标准GB8567-88 一、文档编写标准化 在整个项目开发及使用过程中，应该有完备的文档支持，文档编制要求具有针对性、精确性、清晰性、完整性、灵活性和可追溯性。 完备的文档对软件的开发及使用起了很大的作用。一般要求编写好十三种文档。 1、可行性分析报告 说明该软件开发项目的实现在技术上、经济上和社会因素上的可行性，评述为了合理地达到开发目标可供选择的各种可能实施方案，说明并论证所选定实施方案的理由。 2、项目开发计划 为软件项目实施方案制订出具体计划，应该包括各部分工作的负责人员、开发的进度、开发经费的预算、所需的硬件及软件资源等。 3、软件需求说明书（软件规格说明书） 对所开发软件的功能、性能、用户界面及运行环境等作出详细的说明。它是在用户与开发人员双方对软件需求取得共同理解并达成协议的条件下编写的，也是实施开发工作的基础。该说明书应给出数据逻辑和数据采集的各项要求，为生成和维护系统数据文件做好准备。 4、概要设计说明书 是概要设计阶段的工作总结。主要包括功能分配、模块划分、程序总体结构、输入输出以及接口设计、运行设计、数据结构设计和出错处理等，为详细设计作好准备。 5、详细设计说明书 着重描述每一模块是怎样实现的，包括实现算法、逻辑流程等。 6、用户操作手册 详细描述了该软件的功能、性能和用户界面，使用该软件的具体方法等。 7、测试计划 包括测试内容、进度、条件、人员、测试用例的选取原则、测试结果允许的偏差范围等。8、测试分析报告 测试计划的执行情况，对测试结果的分析，提出测试结论。 9、开发进度月报 按月提交的项目进展情况报告。包括计划与实际执行情况的对比、阶段成果、遇到的问题、解决的方法以及下一步的打算。 10、项目开发总结报告 项目完成以后，总结实际执行情况。如进度、成果、资源利用、成本和投入的人力，对项目开发作出评价，总结经验与教训。 11、软件维护手册 主要包括软件系统说明、程序模块说明、操作环境、支持软件说明、维护过程说明等。12、软件问题报告 记录软件出现问题的日期、发现人、状态、问题所属模块等，为软件修改提供准备文档。13、软件修改报告 软件产品投入使用后，发现了需修改、更正的问题，要将出现的问题、修改意见、修改可能出现影响作出详细描述，提交审批。 二、可行性分析报告的撰写要求 可行性研究报告的编写内容要求如下： 1 引言
word 文档格式规范 类目字体及字符间距段落项目符合 和编号 备注标题二号黑体、加粗居中对齐、3 倍行距、正文文本无无副标题小二号黑体、加粗居中对齐、3 倍行距、正文文本无 目录（二字）三号黑体、加粗 间距 10 磅 居中对齐、单倍行距、正文文本、 段前分页 显示【目 录】二字 无 目录内容五号宋体、不加粗 尽量采用“插入索引和目 录”方式获取目录 如果系统插入索引和目录，则不需 手动设置 无 第一级（章）三号宋体、加粗、标准字 符间距 居中对齐、大纲级别 1 级、3 倍 行距、段前分页、其他保持标准 第Ⅰ章（罗 马字母） 无 第二级（节）四号宋体、加粗、标准字 符间距 两端对齐、悬挂缩进 1 厘米、大 纲级别 2级、单倍行距、与下段同 页、其他保持标准 第Ⅰ节（罗 马字母） 无 第三级（一、）四号宋体、不加粗、标准 字符间距 两端对齐、悬挂缩进 1 厘米、大 纲级别 3级、单倍行距、与下段同 页、其他保持标准 一、无 第四级（1.）四号宋体、不加粗、标准 字符间距 两端对齐、左缩进 0.74 厘米、悬 挂缩进0.74 厘米、大纲级别 4 级、单倍行距、与下段同页、其他 保持标准 4 级以下注 释内容需保 持其该级别 左缩进 无 第五级（自定义项目符合和编号）四号宋体、不加粗、标准 字符间距、清单列表无说 明内容字体用小四号宋体 两端对齐、左缩进 1.48 厘米、悬 挂缩进0.74 厘米、大纲级别 5 级、单倍行距、与下段同页、其他 保持标准 自定义项目 符合和编号 该级注释内 容左缩进 第六级（自定义项目符号和编号）四号宋体、不加粗、标准 字符间距、清单列表无说 明内容，字体用小四宋体 两端对齐、悬挂缩进 2.22 厘米、 大纲级别6 级、单倍行距、与下段 同页、其他保持标准 自定义项目 符合和编号 无 正文四号宋体、不加粗、标准 字符间距、清单列表无说 明内容，字体用小四宋体左对齐、首行缩进 2 字符、大纲 级别正文、单倍行距、其他保持标 准；如果为某级下的正文，其缩进 保持与该级别一致 无无 页眉五号字体默认即可公司名称无 页脚五号字体默认即可公司网址，也可加入当前 日期和页码。页码一般右 对齐页面底部，且首页如 果是封页，就不显示页码 图片标签字体图片及标签段落属性项目符合和编号备注 插图和图片小四号宋体该图片正中下，大纲级别为正文，单倍行距，与该 图片保持同页。图片标签序列1.1.1.1.1..
系统开发规范与文档编写期末复习二 一、单项选择题 1．下列各项中，不是一个软件产品中所必需的是（）。 A．程序C．数据B．算法D．文档 2．非常适合于在软件开发初期很难确定用户需求的情况所采用的软件开发过程模型是（）。 A．瀑布模型C．演化模型B．喷泉模型D．原型模型 3．按照软件的工作方式进行分类，能够对实时发生的事件和数据及时进行处理的软件应分类为（）。 A．交互式软件C．实时处理软件B．分时软件D．并行处理软件 4．结构化分析SA是软件开发需求分析阶段所使用的方法，以下不是SA所使用的工具的是（）。 A．数据流图C．结构化英语B．判定表D．PAD图 5．软件具有和硬件产品不同的特征。下列各项中不属于软件的特征的是（）。 A．软件是一种逻辑实体，主要是人的脑力劳动的产物，软件具有抽象性。 B．软件的维护具有长期性。 C．开发成本高，生产成本低。 D．开发成本低，生产成本高。 6．软件工程的出现是由于（）。 A．程序设计方法的影响B．软件产业化的需要 C．计算机技术的发展D．软件危机的出现 7．在一张DFD图中，任意两个加工之间（）。 A．有且仅有一条数据流 B．至少有一条数据流 C．可以有0条或多条名字不同的数据流 D．可以有0条或多条数据流，但允许其中有若干条名字相同的数据流。8．结构化分析方法的一个重要指导思想是（）。 A．自顶向下，逐步分解C．自顶向下，逐步抽象B．自底向上，逐步抽象D．自底向上，逐步分解 9．软件设计中划分模块的一个准则是（）。
A．高内聚低耦合C．低内聚低耦合B．高内聚高耦合D．低内聚高耦合 10．软件的整体结构和这种结构提供给系统在概念上的整体性的方式是指软件的（）。 A．代码结构C．程序结构B．体系结构D．数据结构 11．程序结构可以按水平方向或垂直方向进行划分。水平划分按主要的程序（）来定义模块结构的各个分支。 A．功能C．层次B．结构D．控制 12．使用基于用例的方法进行需求分析时的第一步是（）。 A．确定用例C．用例之间的关系B．确定参与者 D．确定参与者和用例的通信 13．面向对象的分析过程一般包括：获取用户对系统的需求、标识类和对象以及（）。 A．定义类的结构和层次C．定义方法的结构和层次B．定义对象的结构和层次D．定义消息的结构和层次 14．在面向对象方法中，对象可看成是属性（数据）以及这些属性上的专用操作的封装体。封装是一种（）技术。 A、组装C、固化 B、产品化D、信息屏蔽 15．整体-部分结构体现了面向对象方法的（）。 A．关联（association）B．聚合（aggregation）C．依赖（depending）D．细化（refinement） 16．Jackson设计方法所面向的是（）。 A．对象C．控制结构B．数据流D．数据结构 17．软件开发工作中，必须贯穿于整个过程当中并且不可忽视的工作是（）。 A. 代码编写 B.支持性的，管理性的工作 C. 产品部署 D. 集成 18．编写用户手册时，以下所描述的要求中，不恰当的是（）。 A.充分的描述该软件所具有的功能及基本的使用方法 B.使用户通过本手册能够了解该软件的该软件的用途 C.使用户通过本手册能够了解该软件的该软件的使用 D.使用专门的术语
目录 第一章引言 1 §1.1 目的 1 §1.2 文档约定 1 §1.3 预期读者和阅读建议 1 §1.4 产品的范围 1 §1.5 参考文献 1 第二章综合描叙 1 §2.1 产品的前景 1 §2.2 产品的功能 1 §2.3 用户类和特征 2 §2.4 运行环境 2 §2.5 设计和实现上的限制 2 §2.6 假设和依赖 2 第三章外部接口需求 2 §3.1 用户界面 2 §3.2 硬件接口 3 §3.3 软件接口 3 §3.4 通信接口 3 第四章系统特性 3 §4.1 说明和优先级 3 §4.2 激励响应序列 3 §4.3 功能需求 3 第五章其他非功能需求 3 §5.1 性能需求 3 §5.2 安全设施需求 4 §5.3 安全性需求 4 §5.4 软件质量属性 4 §5.5 业务规则 4 §5.6 用户文档 4 第六章其他需求 4 §6.1 词汇表 4 §6.2 分析模型 4 §6.3 待确定问题列表 5 第1章引言 引言提出了对软件需求规格说明的纵览，这有助于读者理解文档如何编写并且如何阅读和解释。 §1.1 目的 对产品进行定义，在该文档中详尽说明了这个产品的软件需求，包括修正或发行版本号。如果这个软件需求规格说明只与整个系统的一部分有关系，那么就只定义文档中说明的部分或子系统。 §1.2 文档约定
描述编写文档时所采用的标准或排版约定，包括正文风格、提示区或重要符号。例如，说明了高层需求的优先级是否可以被其所有细化的需求所继承，或者每个需求陈述是否都有其自身的优先级。 §1.3 预期读者和阅读建议 列举了软件需求规格说明所针对的不同读者，例如开发人员、项目经理、营销人员、用户、测试人员或文档的编写人员。描述了文档中剩余部分的内容及其组织结构。提出了最适合于每一类型读者阅读文档的建议。 §1.4 产品的范围 提供了对指定的软件及其目的的简短描述，包括利益和目标。把软件与企业目标或业务策略相联系。可以参考项目视图和范围文档而不是将其内容复制到这里。 §1.5 参考文献 列举了编写软件需求规格说明时所参考的资料或其它资源。这可能包括用户界面风格指导、合同、标准、系统需求规格说明、使用实例文档，或相关产品的软件需求规格说明。在这里应该给出详细的信息，包括标题名称、作者、版本号、日期、出版单位或资料来源，以方便读者查阅这些文献。 如： a．本项目的经核准的计划任务书或合同、上级机关的批文； b．属于本项目的其他已发表的文件； c．本文件中各处引用的文件、资料、包括所要用到的软件开发标准。列出这些文件资料的标题、文件编号、发表日期和出版单位，说明能够得到这些文件资料的来源。 第2章综合描叙 这一部分概述了正在定义的产品以及它所运行的环境、使用产品的用户和已知的限制、假设和依赖。 §2.1 产品的前景 描述了软件需求规格说明中所定义的产品的背景和起源。说明了该产品是否是产品系列中的下一成员，是否是成熟产品所改进的下一代产品、是否是现有应用程序的替代品，或者是否是一个新型的、自含型产品。如果软件需求规格说明定义了大系统的一个组成部分，那么就要说明这部分软件是怎样与整个系统相关联的，并且要定义出两者之间的接口。 §2.2 产品的功能 概述了产品所具有的主要功能。其详细内容将在 d 中描述，所以在此只需要概略地总结，例如用列表的方法给出。很好地组织产品的功能，使每个读者都易于理解。用图形表示主要的需求分组以及它们之间的联系，例如数据流程图的顶层图或类图，都是有用的。 §2.3 用户类和特征 确定你觉得可能使用该产品的不同用户类并描述它们相关的特征（见第7 章）。有一些需求可能只与特定的用户类相关。将该产品的重要用户类与那些不太重要的用户类区分开。 §2.4 运行环境 描述了软件的运行环境，包括硬件平台、操作系统和版本，还有其它的软件组件或与其共存的应用程序。
********系统系统设计文档 *****系统设计小组 组长：**** 组员：**** **** **** ****
目录 1 引言 (1) 1.1编写目的 (1) 1.2背景 (1) 1.3定义 (1) 1.4参考资料 (1) 2 系统功能设计 (3) 2.1 功能模块设计 (3) 2.2 ****模块设计 (3) 2.3 ****模块设计 (3) 3 类设计 (4) 4 数据库设计 (6) 5 接口及过程设计 (7) 6 界面设计 (8) 7 其它设计 (12) 8 小结 (13)
说明： ●在进行系统设计时可以任意传统系统设计方法或面向对象系统设计方 法，或者两者相结合，不局限于使用一种方法。 ●文档中每章图都需要配有相应的文字解释。 ●本文档中的图按照章编号，如“1 引言”表示第一章，“1.1 编写目的” 表示第一章第一节。第一章第一个图标号为“图1.1 ****图”，而第二个 图标号为“图1.2 ****图”，写在图的下面，居中。 ●本文档中的表也按照章编号，第一章第一个表标号为“表1.1 ****表”， 而第二个表标号为“表1.2 ****表”，写在表的上面，居中。 ●使用visio画用例时，Actor及用例的图示模具（用例图模具.vss）可以 到BB平台下载。 1 引言 1.1编写目的 说明编写这份系统设计说明书的目的，指出预期的读者。 1.2背景 说明： a．待开发的软件系统的名称； b．列出此项目的任务提出者、开发者、用户以及将运行该软件的计算站（中心）。 1.3定义 列出本文件中用到的专门术语的定义和外文首字母组词的原词组。 1.4参考资料 列出用得着的参考资料，如：
文档格式规范
目录 1 文档格式规范 (1) 1.1文字性文件或规范性文件的编制要求 (1) 1.1.1 文件的整体要求 (1) 1.1.2 文件编制的具体要求 (1) 1.2表格文件的编制要求 (5) 2 文档命名规范 (5)
1 文档格式规范 1.1 文字性文件或规范性文件的编制要求 1.1.1 文件的整体要求 1.1.1.1 文件编制的基本要求 a)文件均采用A4纸幅面。文件的名称应简明准确，一般不超过20个汉字。 b)文件的内容应表达准确、清楚、简明、严谨。 c)同一文件中术语、符号、代号应统一。表达同一术语的概念应前后一致。 采用的术语尚无标准规定时且容易产生不同理解的，应给出定义或说明。 d)文件中的缩略词(语)应采用有关标准或专业委员会认定的缩略词(语)，自 定缩略词(语)应简明、确切，能反映主题。缩略词(语)在文件中首次出现 时应做说明。 e)文件中引用的标准和文件应是现行有效。 f)文件中应采用国务院正式公布、实施的简化汉字。 1.1.1.2 文件封皮的基本要求 a)文件封面的内容分为标题、编制信息和公司名称三部分。 b)文件标题分为“标题”和“副标题”。“标题”描述项目名称，字体：小 初黑体居中；“副标题”描述文件名称，字体：小一黑体居中。“标 题”和“副标题”空一行。 c)文件编制信息包含三个要素，“编制”、“审核”、“批准”：小四宋体加 粗，书写对应人员姓名，姓名中文采用小四宋体，西文采用小四Times New Roman。“版本号”：小四宋体加粗，书写文件版本号，采用小四 Times New Roman；“日期”：小四宋体加粗，书写文件编制日期，采 用小四Times New Roman。 d)公司名称为公司的全称，在文件编制信息后空一行，三号黑体。 e)所有文字性文件或规范性文件中都必须包含文件修改记录，文件修改记 录放在第二页，目录从第三页开始。 f)封面页、文件修改记录页均不插入页脚页码，目录页的页脚中间对齐插
《计算机软件文档编写指南》 一．计算机软件文档由封面、目录、正文、注释和附录组成。 封面格式： 密级：编号： 文档名称： 项目名称： 编制： 审核： 批准： ×××××××××××××研究所 年月日
二．计算机软件文档包括： 1）软件开发计划 2）软件需求规格说明 3）接口需求规格说明 4）接口设计文档 5）软件设计文档 6）软件产品规格说明 7）版本说明文档 8）软件测试计划 9）软件测试说明 10）软件测试报告 11）计算机系统操作员手册 12）软件用户手册 13）软件程序员手册 14）计算机资源综合保障文件 软件开发计划 一．引言 1．编写目的（阐明编写软件计划的目的，指出读者对象。） 2．项目背景（可包括：（1）项目委托单位、开发单位和主管部门；（2）该软件系统与其他系统的关系。） 3．定义（列出本文档中用到的专门术语的定义和缩略词的原文。） 4．参考资料（可包括：（1）项目经核准的计划任务书、合同或上级机关的批文；（2）文档所引用的资料、规范等；列出资料的作者、标题、编号、发表日期、出版单位或资料来源。）二．项目概述 1.工作内容（简要说明项目的各项主要工作,介绍所开发软件的功能性能等. 若不编写可行性 研究报告,则应在本节给出较详细的介绍。) 2.条件与限制（阐明为完成项目应具备的条件开发单位已具备的条件以及尚需创造的条件. 必要时还应说明用户及分合同承包者承担的工作完成期限及其它条件与限制。） 3.产品 （1）程序（列出应交付的程序名称使用的语言及存储形式。） （2）文档（列出应交付的文档。） （3）运行环境（应包括硬件环境软件环境。） 4．服务（阐明开发单位可向用户提供的服务. 如人员培训安装保修维护和其他运行支持。）
SEO牵涉到产品的设计到上线以及上线后维护的整个流程中，涉及到产品、设计、制作（HTML制作）、技术、SEO和IT维护部门，在整个流程中产品经理和SEO项目组人员自始自终都需要参与，但是每个步骤的行为不同，各步骤描述及各步骤的工作如下：步骤主要部门工作协助部门工作 页面UE制定产品部产品经理： 1．确定页面核心内容，确定页面关键字 2．确定页面Title、Keywords、Description 3．在UE中页面关键字需要重复6-8次，在页面内容的开头和结尾都要出现关键字 4．主要关键字以H1的形式出现（有且仅有一次），次要关键字以H2的形式出现（2-3次） 5．指向到站内其他需要优化的页面的链接关键字需要加粗，并加上href title 6．图片的内容需要加alt属性，装饰性图片不需要加alt 7．在底级页、专题页、栏目首页、频道首页放置和本页面主要内容相关的的新闻、搜索、 论坛连接。 8．底级页的搜索引擎文本输入框预置相关关键词 9．书写SEO文档，提交给SEO项目组 SEO项目组： 1．协助产品经理确定页面关键字 2．检查UE是否遵循之前的原则 3．标记需要通过DIV移动位置的片段 页面设计设计部设计部： 按照页面UE及SEO文档制作页面 产品经理： 检查页面设计是否符合UE及SEO文档 页面制作 设计部页面制作组页面制作： 1．注意Title、Keywords、Description是否符合SEO文档 2．注意H1、H2、加粗、href Title、img Alt的使用 3．注意割图时大段与主题有关的文字，不得采用文字；但是参赛说明这种可以采用图片 4．控制页面大小及图片大小，对小图优化，一般页面不超过40k，含图不超过300k 5．页面符合HTML标准，通过验证 6．为频道logo增加alt说明。 产品经理： 检查页面制作是否符合UE及SEO文档 SEO项目组： 1．检查是否符合SEO文档 2．检查关键字重复密度
项目文档命名规则 编制：日期：____/____/____审核：日期：____/____/____ 批准：日期：____/____/____ XXXX公司 二零一五年五月制
历史记录
目录 1 目的 (4) 2 适用范围 (4) 3 术语和缩略词 (4) 4 规程 (4) 4.1 文档命名规则 (4) 4.2 配置项的版本标识 (8) 4.3 标签的命名 (9)
1 目的 本文的目的是定义各项目所有相关文档和CMM要求的过程文件的格式和规则，以及配置管理中对配置项和版本的标识。 2 适用范围 本规则适用于所有需求、设计等文档和过程文件。 3 术语和缩略词 无 4 规程 4.1 文档命名规则 1组织标准软件过程文档编号 (1)过程文件格式：XXX-P-××，初始编号为：XXX-P-01，最大编号为：XXX-P-99。 (2)指南文件编号：XXX-G-××××，前两位××为指南所对应的过程文件编号。 (3)模板文件编号：XXX-T-××××，前两位××为指南所对应的过程文件编号。 2产品命名规范 (1)中文命名规范：中文全称V产品版本号。英文命名规范：首字母大写V产品版本号。3项目文档编号 (1)编号规则分三种： 1)单个文档：首字母大写V产品版本号-阶段英文缩写-文档名称英文缩写。 2)多个子文档：首字母大写V产品版本号-阶段英文缩写-文档名称英文缩写—流 水号。 3)周期性：首字母大写V产品版本号-文档名称/英文名称-八位日期。 (2)项目阶段及文档名称英文缩写，见下表：
4文档版本 (1)格式：V×××.×××，初始版本号为V0.1，最大版本号为：V999.999。其中， 草稿状态的版本均为V0.×××，例如：V0.1，V0.2……V0.999；而经过评审通过
前端开发设计规范 目录 前端开发设计规范 (1) 一、HTML使用规范 (1) 1.1、页面文件命名规范 (1) 1.2、页面head部分书写规范 (1) 1.3、HTML元素开发规范 (2) 1.3.1、HTML元素书写规范 (2) 1.3.2、HTML元素命名规范 (4) 二、WEB页面开发规范 (5) 2.1、错误跳转页面的处理 (5) 2.2、提示信息的处理 (5) 2.3、页面的返回 (5) 2.4、提交前数据的判断验证 (5) 2.5、删除操作 (6) 2.6、页面中java代码的使用 (6) 2.7、网站页面布局规范 (7) 2.7.1、前台页面尺寸 (7)
2.7.2、标准网页广告图标规格（参考） (7) 2.7.3、页面字体 (8) 2.7.4、字体颜色 (8) 三、javaScript开发规范 (9) 3.1、javaScript文件命名规范： (9) 3.2、javaScript开发规范 (9) 3.2.1、javaScript书写规范 (9) 3.2.2、javaScript命名规范 (10) 四、css样式规范 (12) 4.1、css样式文件命名规范 (12) 4.1.1、通用样式文件命名规范： (12) 4.1.2、业务类样式文件命名规范 (13) 4.1.3、css样式文件命名须知 (13) 4.2、css样式文件存放目录规范 (13) 4.3、css样式定义规范 (14) 4.3.1、css样式内容顶部注释规范 (14) 4.3.2、css样式内容注释规范 (14) 4.3.3、css样式定义规范 (15) 4.3.4、css样式常用id的命名 (17) 4.3.5、css样式常用class的命名 (18)
总体设计说明书 一、引言 1、编写目的根据课程设计的要求，结合校园实际情况，我们计划利用GIS 的功能和方法做一个关于校园的高效、易用的导航系统，本系统初步目的是为那些对大学校园还很陌生的人提供就一些服务，让他们通过此系统能快速知道目的地在哪，去目的地怎么走，从而节省他们宝贵的时间；以及为在校大学生提供基本的生活信息，学习信息和活动信息等。 2、背景说明软件名称： “理工之窗”导航系统项目提出者： 毛超荣项目开发者： 毛超荣、王世远、杨克明、彭冠峰、宋红见用户： 3、系统设计意义随着互联网技术的发展，GIS已经深入应用到生活的方方面面，给人们的生产生活带来了很大的便利。 导航系统的出现使人们的出行变得十分便捷，了解的GIS的强大功能后，为此我们试想用所学到的理论知识结合校园实际需求做一GIS导航系统，方便广大以学生为主体的群体的工作、生活和学习，在地理信息系统快速发展的今天，大部分系统是介于大公司、大项目的设计，很少是关于一个像大学校园等小小范围的导航系统，在此背景下，本系统的设计为广大师生及所有的系统访问者提供一个实用的平台，为他们带来便利。 同时也是一个窗口，通过它可以让更多的人了解我们的学校。 4、参考资料 二、用户需求分析成果 1、系统功能需求“理工之窗”学生服务系统围绕着网站的使用情况在用户、信息、服务、数据等方面进行管理。
从系统运行环境来看，系统建设功能大致可分为两大部分： 对外服务网站、内部信息处理系统。 本部分从内部使用者的角度，对系统功能需求进行了分析和描述。 1. 1、系统总体功能需求业务系统是以GIS系统为基础，反映学生服务特点，是集导航和查询功能于一体的的信息系统，其中包括学习信息服务系统、生活信息服务系统、系统维护管理信息系统和人员管理信息系统。 系统各功能模块情况如下图： 1. 2、功能模块的具体内容和需求明细“理工之窗”学生服务系统空闲教室查询学术活动查询最佳路径查询位置服务社团活动查询网络维护数据库维护数据维护普通用户管理员管理学习信息服务生活信息服务系统维护管理人员信息管理 1.2. 1、学习信息服务系统模块描述： 该部分主要是为同学们的学习服务的，为同学们提供实时的与学习方面有关的各种信息。 ①空闲教室查询功能描述： 点击空闲教室查询按钮，出现查询目的地选择框和查询时间段输入框，在两个框中输入相应的文字，点击查询按钮，即可查询三个教学楼及各个学院没有课的教室。 所需输入数据： 目的地名称和时间②学术活动查询功能描述：
软件文档管理指南 范围 本标准为那些对软件或基于软件的产品的开发负有职责的管理者提供软件文档的管理指南。本标准的目的在于协助管理者在他们的机构中产生有效的文档。 本标准涉及策略、标准、规程、资源和计划，管理者必须关注这些内容，以便有效地管理软件文档。 本标准期望应用于各种类型的软件，从简单的程序到复杂的软件系统。并期望覆盖各种类型的软件文档，作用于软件生存期的各个阶段。 不论项目的大小，软件文档管理的原则是一致的。对于小项目，可以不采用本标准中规定的有关细节。管理者可剪裁这些内容以满足他们的特殊需要。 本标准是针对文档编制管理而提出的，不涉及软件文档的内容和编排。 引用标准 下列标准所包含的条文，通过在本标准中引用而构成为本标准的条文。本标准出版时，所示版本均为有效，所有标准都会被修订，使用本标准的各方应探讨使用下列标准最新版本的可能性。 计算机软件开发规范 计算机软件产品开发文件编制指南 软件工程术语 定义 本标准采用下列定义，其他定义见。 文档 一种数据媒体和其上所记录的数据。它具有永久性并可以由人或机器阅读。通常仅用于描述人工可读的内容。例如，技术文件、设计文件、版本说明文件。 文档（集）；文档编制 一个或多个相关文档的集合。 文档计划 一个描述文档编制工作方法的管理用文档。该计划主要描述要编制什么类型的文档，这些文档的内容是什么，何时编写，由谁编写，如何编写，以及什么是影响期望结果的可用资源和外界因素。 文档等级 对所需文档的一个说明，它指出文档的范围、内容、格式及质量，可以根据项目、费用、预期用途、作用范围或其他因素选择文档等级。 软件产品 软件开发过程的结果，并推出供用户使用的软件实体。 软件文档的作用 ) 管理依据； ) 任务之间联系的凭证； ) 质量保证； ) 培训与参考；