计算机文档编制规范

'计算机文档编制规范　　篇一：软件开发文档编制规范　　详细设计说明书　　中国移动通信集团河南有限公司　　文档修订历史记录　　目录　　1.引言.............................................................................................................................4　　目的........................................................................................................................4　　背景........................................................................................................................4　　定义........................................................................................................................4 　　参考资料.................................................................................................................4　　2.程序系统的结构.........................................................................................................5　　3.程序1（标识符）设计说明.....................................................................................5　　程序描述.................................................................................................................5　　功能........................................................................................................................5　　性能 ........................................................................................................................5　　输入项....................................................................................................................6　　输出项....................................................................................................................6　　主要算法说明..........................................................................................................6　　流程逻辑.................................................................................................................6　　接口........................................................................................................................6　　限制条 件.................................................................................................................6　　尚未解决的问题.....................................................................................................6　　4.程序2（标识符）设计说明.....................................................................................7　　1.引言　　目的　　说明编写这份详细设计说明书的目的，指出预期的读者范围。例如：　　本文档是在需求分析和概要设计文档的基础上，考虑系统易用性、健壮性和可扩展性的要求，对系统进行的功能模块细化设计，并且做为后续编码和测试的依据。　　本文档适合的读者包括：项目方案的规划人员和评审人员、系统的详细设计技术人员、系统的开发人员、项目管理相关人员。　　背景　　说明：　　（1）待开发软件系统的名称； 　　（2）列出此项目的任务提出者、开发者、用户以及将运行该软件的单位。　　定义　　列出本文档中用到的专门术语的定义和缩写词的原词组。　　参考资料　　列出要用到的参考资料，如：　　1、本项目的经核准的计划任务书或合同、上级机关的批文；　　2、属于本项目的其他已发表的文档；　　3、本文档中各处引用的文档、资料，包括所要用到的软件开发标准。　　列出这些文档的标题、文档编号、发表日期和出版单位，说明能够得到这些文档资料的来源。格式如下：　　[文档编号]作者，文献名称，出版单位（或归属单位），日期　　2.程序系统的结构　　用一系列图表列出本程序系统内的每个程序（包括每个模块和子程序）的名称、标识符和它们之间的层次结构关系。　　3.程序1（标识符）设计说明 　　从本章开始，逐个地给出各个层次中的每个程序的设计考虑。以下给出的提纲是针对一般情况的。对于一个具体的模块，尤其是层次比较低的模块或子程序，其很多条目的内容往往与它所隶属的上一层模块的对应条目的内容相同，在这种情况下，只要简单地说明这一点即可。　　程序描述　　给出对该程序的简要描述，主要说明安排设计本程序的目的意义和特点。　　功能　　说明该程序应具有的功能，可采用图的形式进行展现。　　性能　　说明对该程序的全部性能要求，包括对精度、灵活性和时间特性的要求。　　篇二：软件文档编写规定　　无锡航天长峰电子技术研究所企业标准QQ/CFDZ210—XX　　软件文档编写规定　　XX—5—8发布XX—5—8实施　　无锡航天长峰电子技术研究所批准　　拟制：　　审核：　　会签：　　标准化： 　　批准：　　无锡航天长峰电子技术研究所企业标准　　软件文档编写规定　　QQ/CFDZ210-XX　　1范围　　本标准规定了软件文档的组成、标识和编制要求等。　　本标准适用于软件文档的编制。　　2引用文件　　下列文件中的有关条款通过引用而成为本标准的条款。凡注日期或版次的引用文件，其后的任何修改单（不包括勘误的内容）或修订版本都不适用于本标准，但提倡使用本标准的各方探讨使用其最新版本的可能性。凡不注日期或版次的引用文件，其最新版本适用于本标准。　　QQ/CFDZ111软件工程化管理程序　　QQ/CFDZ201技术文件归档签署规定　　3术语和定义　　计算机软件文档　　技术数据或信息，包括计算机的列表和打印输出。计算机软件文档可记录计算机软件的要求、设计或细节，解释软件的能力和限制条件，或提供在软件运行期中使用或保障计算机软件的操作指令。　　4职责 　　产品标准化总师负责确定产品软件文档的齐套性要求；　　软件室产品软件负责人负责组织软件文档的编制。　　5规定　　软件文档的组成　　在软件开发过程中可能产生的文档按《技术文件归档签署规定》中的　　软件文档完整性表。　　软件文档的标识　　标识的组成　　标识由产品代号、软件标识、文档简号、版本号和密级代号组成。　　标识的填写规定　　a)产品代号由科研部下发；　　b)软件标识按各产品设计与试验规范的规定填写；　　c)文档简号见表1；　　d)版本号按软件入库时定义的版本号；　　e)密级代号按保密有关规定填写。　　软件文档的编制方法　　软件文档的格式　　a)纸质软件文档的格式按硬件产品技术文件；　　b)可执行文件可使用光盘（或软盘）作为复制载体。　　软件文档的编写 　　a)软件文档内容编写，参照GJB438A-1997规定，制定了各个文档的编　　写提示见附录A；　　b)为使各文档章节的信息更加清晰可读，可采用图、表、矩阵或其它　　形式的表示方式进行说明；　　c)合同有要求时，按顾客规定的要求编制软件文档。　　标准文档的剪裁　　除另有规定外，本标准规定的各种软件文档可根据各产品的性质、特点等具体情况进行剪裁，并应在产品的软件设计与编码规范中明确。如：产品规模较小时，可将“软件需求规格说明”和“接口需求规格说明”合并拟制，接口的需求可插入“软件需求规格说明”文档中；“计算机系统操作员手册”、“软件用户手册”和“软件程序员手册”可将有关章节合并至“软件用户手册”中；对于无人机界面的软件，其有关操作、使用方法和注意事项等可写入系统的技术说明书和使用说明书中。　　程序汇总表的编写　　程序汇总表是对电子设备中所有程序（包括可编程器件配置文件）在设备中配置情况的具体描述，供组织和管理生产使用。程序汇总表的填写，有以下规定：　　a) “软件标识或编号”栏填写程序的标识（包括产品代号、版本号和　　密级代号）或可编程器件的S整件的编号（包括版本号和密级代号）。当多个CSCI或CSC或CSU合装在一个固件中时，除在首栏填写组合程　　序的标识外，还需在其下栏填写每个CSCI或CSC或CSU的标识；　　b)“名称”栏填写各程序的功能名称；　　c)“编号”栏填写各程序装入的固件所在的SP整件编号（所有装有程　　序的硬件需编制SP整件）；　　d)“位置代号”栏填写SP整件所在系统中的位置；　　e)“种类代号”栏填写固件所在电路中的种类代号；若一个程序分开　　装入二个以上固件时，应在相应栏内填写各固件所在电路中的种类　　代号；　　f)“整机工作令号”填写整机产品的工作令号和台（套）号，如第二　　批960产品共十套，其第一套的整机工作令号填写960-023-10-1：。 如果本程序汇总表中包括其它软件产品、且该软件产品有单独的汇总表时，则该软件产品汇总表中的程序不再汇入本汇总表，需在本汇总表末尾加以引述，如：“成套软件产品的程序汇总表见”。　　单元或分系统的程序汇总表可以将可编程逻辑器件的S整件汇总表和软件的程序汇总表分别汇总提交给总体，也可以合并汇总在一份汇总表中。　　提交归档的程序汇总表应包括可编程逻辑器件的S整件和软件的程序。　　篇三：软件测试文档编制规范　　文档编制规范　　目录　　文档编制规范...................................................................................................................................1　　一、文档的分类.......................................................................................................................2　　二、文档的编号.......................................................................................................................2　　三、 文档编写的格式要求.......................................................................................................3　　、页面布局...................................................................................................................3　　、页边距...............................................................................................................3　　、页眉页脚...........................................................................................................3　　、首页标题及公司基本信息.......................................................................................3　　、目录...........................................................................................................................4 　　、正文...........................................................................................................................4　　、正文内容...........................................................................................................4　　、小标题级别.......................................................................................................4　　、图片与表格.......................................................................................................5　　、功能点与列表...................................................................................................8　　、附件 ...........................................................................................................................8　　一、文档的分类　　将文档分成如下几类：　　1、规章制度类（编号：GZZD）：公司、部门的各项规章制度；　　2、工作规范类（编号：GZGF）：各部门的工作规范；　　3、项目管理规范类（编号：XMGL）：项目管理规范、药监项目管理规范、招投标系统开　　发与实施指南等；　　4、项目类文档（编号：XM）：包括项目各个过程的产出物，如合同（HT）、建设方案（FA）、　　需求文档（XQ）、设计文档（SJ）、操作手册（CZSC）、测试报告（CSBG）等；　　5、体系类（ISO9001、ISO27001、CMMI3）；　　6、知识类（编号：ZS）：各类技术经验总结等；　　7、产品类（编号：产品名称缩写）：如OA、Mis平台、电子招投标产品的介绍资料/操作手　　册等　　8、其他类（不需要编号）：上述7个类别之外的其它文档。　　二、文档的编号 　　文档的编号是文档唯一标识，主要用于文档的检索和版本控制。　　文档编号规则如下：　　文档编号=文档所属部门代码+文档类别代码+文档流水号+版本号　　示例如下：　　例如：QYGL－GZZD－001　　企业管理部　　说明：　　1.部门代码为各部门的拼音首字母（公司的部门代码为GTXD）。　　部门编码示例：　　企业管理部－QYGL、人力资源部－RLZY、行政部－XZ、开发部－KF（子部门为KF1、KF2类推）、实施部－SS（子部门SS1、SS3类推）、测试部－CS等；　　2.版本号使用2位数字进行声明，数字间使用英文标点“.”隔开。首位数字表示第几个　　版本，末尾数字表示版本内的第几次修改。例如：表示第一次正式发布的版本；，表示在第一次发布后进行第二次修改后的文档。　　3.其它类的文档（各种表单、ppt等），无需编号、页眉页脚，如《培训记录表》等。　　4.EXCEL类文档按WORD文档编号方式编号。 　　5.其他各类外来文件，包括各法律法规、技术标准和顾客资料等，均按各自的原本编号，　　也不需要另外修改。　　三、文档编写的格式要求　　、页面布局　　、页边距　　上下页边距：厘米，左右页边距：厘米（默认）。　　、页眉页脚　　页眉：加入公司logo图片左对齐；后面加上文档名称，用小五号宋体字（TimesnewRoman）；文件编号和版本号，如“GTXD-GZZD-001”右对齐；页眉顶端距离厘米。　　页脚：加入公司名称及联系方式居中；加入页码/总页数右对齐页面底部；用小五号宋体字（TimesnewRoman），页脚底端距离厘米。　　首页如果是封页，则不显示页眉页脚。　　、首页标题及公司基本信息　　公司基本信息：顶格、两端对齐，以图片形式放置公司logo及公司基本信息。　　标题：用一号加粗黑体字（数字或英文字体用TimesnewRoman），可分一行或多行居中对齐，4倍行距，正文文本，分行时，要做到词意完整，排列对称，间距恰当。　　、目录 　　目录（二字）：三号加粗宋体字，字符间距10磅，居中对齐，倍行距，大纲级别正文文本，左右无缩进，段前段后无间距。　　目录内容：五号宋体（TimesnewRoman），单倍行距，不加粗，不倾斜，采用“引用自动目录”方式获取目录。　　在目录下方插入分页符。　　、正文　　、正文内容　　五号宋体（TimesnewRoman），不加粗，标准字符间距，左对齐，首行缩进2字符，倍行距，左右无缩进，段前段后无间距，其他保持标准。　　、小标题级别　　、第一级　　三号宋体，加粗，标准字符间距，两端对齐，大纲级别1级，倍行距，段前段后6磅，左右无缩进，项目符号和编号：一、二、??。　　、第二级　　小三号宋体（TimesnewRoman），加粗，标准字符间距，两端对齐，大纲级别2级，倍行距，段前段后6磅，左右无缩进，项目符号和编号：、，、，??。　　、第三级　　四号宋体（Timesnew Roman），加粗，标准字符间距，两端对齐，大纲级别3级，倍行距，段前段后6磅，左右无缩进，项目符号和编号：、，、，??。　　'