文档规范说明书

文档规范说明书
文档规范说明书

保密等级:内部公开文档规范说明书

XXX信息技术有限公司

XXX Information Technology Co.,LTD.

2020年3月

文档修订历史

目录

1文档规范背景 (1)

1.1文档规范目的 (1)

1.2使用范围 (1)

2文档内容 (2)

3文档命名规范 (3)

3.1命名规范意义 (3)

3.2命名原则 (3)

3.3文档命名结构 (3)

3.3.1项目名称 (3)

3.3.2文档名 (4)

3.3.3部分名 (6)

3.3.4日期 (6)

3.3.5版本号 (7)

3.3.6文档后缀 (7)

3.4文档名举例 (8)

4文档结构规范 (9)

4.1页面设置 (9)

4.2封面 (9)

4.2.1文档标题 (9)

4.2.2公司名 (10)

4.2.3日期 (11)

4.2.4保密等级 (11)

4.3文档修订历史 (12)

4.4目录 (13)

4.5页眉页脚 (13)

4.6标题样式 (13)

4.7正文 (13)

4.8文档属性 (13)

5文档正文规范(建议) (14)

5.1字体规范 (14)

5.1.1正文 (14)

5.1.2数字规范 (14)

5.1.3英文规范 (14)

5.2标题编号 (14)

5.3段落 (15)

5.4编号 (15)

5.5图片格式 (16)

5.6表格格式 (16)

1文档规范背景

1.1文档规范目的

规范公司产品及技术文档体系,加强文档的标准化管理。

加强公司项目文档管理,便于项目人员阅读、修改和跟踪,采用标准化规范对文档进行统一命名,文档格式及要求标准化。

文档命名规范确保公司产品及技术部重要文档具有唯一编号,便于文档的有效识别、追溯和控制,保证部门文档体系有效运转。

对文档格式和内容制定规范,指导各部门各种文档编制工作,规范和统一文档风格有利于文档保持一致性,提高文档质量。

1.2使用范围

本规范主要适用于项目的立项书、规划设计方案、建设方案、投标文件及需求分析文档、使用手册、技术开发文档等。

文档命名规范、文档结构规范强制执行,对于段落标题、文档正文规范本规范说明书只是建议。对于招标文件或者客户对文档格式有规定的,文档格式按照要求撰写。

2文档内容

文档规范包括文档命名规范、文档结构规范、文档正文规范。

文档命名规范包括文档命名的意义、原则和结构。

文档结构规范包括文档页面设置、封面、修订历史、目录、页眉页脚、标题编号、文档属性等规范。

文档正文规范包括文档正文、段落、编号、图表格式的建议。

3文档命名规范

3.1命名规范意义

1)让接收方一眼明白文档的主题。

2)方便快速检索到所需要的文档。

3)区分版本并随时回溯以前的版本。

3.2命名原则

1)命名要有助于文档的排序,便于查找和管理。

2)命名要能看出文档的内容。

3)文档命名使用中文、英文字母和阿拉伯数字的组合

4)文档名组合一般用“_”下划线、“()”圆括号、“.”点、“[]”六角括号这

几种字符,其他字符一般不要使用。

3.3文档命名结构

文档命名的结构:

[客户名称]项目名称[子系统名称] + 文档名+(部分名)_日期_V版本号.文档后缀

对于投标文件、招标文件、评审文件或者方案最后提交版后者发布版,可以去掉版本号,改为终稿、发布版或者打印稿

[客户名称]项目名称[子系统名称] + 文档名+(部分名)_日期_终稿.文档后缀

3.3.1项目名称

如果同一项目有多个客户的或者项目名比较简单的,可以把客户名称(缩写)加在项目名称之前。

如果一个项目有多个子系统文档,可以加上子系统名称或者直接用子系统名称代替项目名称,或者项目名称用一个缩写代替。

如果是投标文件或者正式申报文件,把“项目”或者“建设项目”也补齐或者根据招标文件的项目全称来命名。

如果每年都有同样的项目,可以在项目名称上加上年份。

总之,项目名称不能太长,也不能太短,要能体现客户,项目内容,文档内容。

比如:

1)电信电话会议系统扩容

2)商贸公司第三方支付平台预付卡系统

3)智慧校园统一消息推送应用平台服务项目

4)信息终端技术迭代更新优化实施项目

3.3.2文档名

工程项目全周期包括了立项阶段、计划阶段、实施阶段和完成阶段。产品及售前部门主要负责项目立项阶段的立项报告、需求调研、方案建议书。计划阶段的招投标文档。实施阶段的的需求分析文档、使用手册等。技术研发部门主要负责技术设计、开发及测试文档的编写。

以下所列是工程项目全周期各阶段的文档名。

3.3.3部分名

可选。部分名用一对英文符号()标注(不要用中文的括号),主要是一个项目有几个文档组成的时候,对各部分组成进行标注。比如投标文件,在项目名称及文档名称之后用部分名,部分名可以是:报价部分、技术部分、商务部分、商务技术标、开标一览表等标注不同的文档。如果一个大型项目的科研报告分成几个文档也可以把背景资料、总体规划、详细设计、实施计划等内容分成几部分,在每个文档后面用部分名进行区分。有些项目会重点突出项目的特殊性质及阶段性,也可以用部分名进行标注,比如试点、省立项、预审文件、第一次谈判等等。

3.3.4日期

日期:yyyymmdd,yyyy:用四位数字表示公元年份,如2018表示公元2018年。mm:用两位数字表示月份,不足两位时,第一位用零补齐,如03表示3月。dd: 用两位数字表示日期,不足两位时,第一位用零补齐,如15表示第15号。例如:20180901 表示2018年09月01日。

日期一般是提交文档的日期。

3.3.5版本号

版本号以V(大写)开头,版本号为两位数字,包括主版本号和副版本号,中间用点隔开,如V1.0,V1.2,V2.0等。

对于没有重大修改的文档则每次修改在副版本号数字加1;当有多人同时提交同一版本的文档时,可以在版本标识的后面加入人名或缩写来区分。比如V1.0(wax),V1.0(wj)等。

3.3.6文档后缀

新建文档,建议使用Microsoft Office 2013及以上版本的办公软件。没有特殊要求不要使用兼容模式。兼容模式会损失一些格式。

3.4文档名举例

XXX学校治安视频监控系统项目建设方案_20120706_v1.0.docx

XXX大学城校区云时代智慧校园规划设计方案_20170404_V1.3.docx

XXX地铁运营施工调度管理系统项目投标文件(商务部分)_20170711_V1.2.docx

XXX增值业务平台综合服务系统总体设计_20170601_V1.4.docx

XXX国际贸易“单一窗口”项目建设方案_20170302_V1.3.docx

XXX轨道交通运营施工管理系统采购项目投标文件(商务技术标)_20170426_V1.0.docx XXX地铁施工调度系统项目投标文件(技术部分)_20170528_打印版.docx

XXX建筑环境及能效监控系统结构体系研究申报文件_20151225_终稿.docx

XXX企业信息化办公系统改造招标文件_发布版.docx

4文档结构规范

4.1页面设置

所有文档除个别表格和图纸使用A3页面大小外,其余一律用A4页面大小。页面一般为纵向,如需要可将部分正文设为横向。

Word页面原则上使用软件默认设置,即:上2.54cm,下2.54cm,页眉1.5cm,页脚1.75cm,左右为3.17cm,页码统一在下方居中。为避免最后一页只是几行占一页的现象,可适当收缩行距,使文档大部分内容成为整页,但收缩行距不宜小于20磅。

4.2封面

封面内容主要包括文档标题,公司名、日期三项内容

封面没有页眉和页脚

对于投标文件还包括正副本及技术商务标识、招标编号等,具体按照招标文件要求。

4.2.1文档标题

文档标题:字体黑体、小初、居中

文档规范说明书

4.2.2 公司名

公司名:人工输入公司名+LOGO ,或者直接美工图片,如有必要也可以带上公司地址。

方案一(推荐):

XXX 信息技术有限公司

XXX Information Technology Co.,

LTD.

方案三:

XXX 信息技术有限公司

XXX

4.2.3日期

日期:中文及阿拉伯数字都可以,宋体小三、居中。如果是中文就全部使用中文,比如二〇一六年七月十日

2018年7

方案二:

方案三:

4.2.4保密等级

保密等级:对于内部文档加上保密等级。

需要保密的文档密级从高到低分为“绝密”、“机密”、“秘密”“内部公开”和“公开”五级,具体定义如下:

●绝密:涉及公司与客户或供应商,分销商所签订相关的文档资料。仅限于公

司最高管理层及各资料所涉及的经过相应管理人员授权的相关人员查阅。

●机密:公司内部所相关的规章制度及技术规范,开发手册等;还有各项目开

发文档、管理文档及产品等仅供相关部门高级领导以及经过授权后相关人员查阅。

●秘密:需交付用户或与客户进行交流的文档与产品,可供相关项目客户查阅。

●内部公开:内部不限制,公司内部可以以任何形式获得文档的信息并阅读、

保存、修改后自用等等,但是不允许向外传播的文件。

●公开:可以对外公开或发布的文件。

4.3文档修订历史

文档修订历史内容建议包括:序号、版本号、修改内容、修改日期、作者(修改人)、审核人等,如下表所示,可以根据实际情况添加内容。修订页中的版本和作者要与封面的版本和编制一致。

关于版本号说明:

●文档审核之后,正式发布的第一个文档版本号为1.0;之后所有审核之后的

版本按顺序(全部取整,如2.0、3.0)编排版本号。

●对于没有审核的文档,从原有文档副版本号 + 0.1开始按顺序编号,可以由

作者自行编号。

●如果只是修改一些错误,内容没有实质性变化,版本号可以不变,只是修改

日期。

4.4目录

首页单独成页,不设置页码。

修订历史与目录单独成页,页码单独设置为罗马数字I,II,III,目录采用超链接直接生成(或者选中模板目录内容,点右键选“更新域”),采用宋体、小四号字。一般采用三级目录,动态更新目录,任何编号栏目修改都要及时更新。

对于大型技术方案或者投标文件有根据需要也可以采用四级目录。

4.5页眉页脚

页眉左边为项目名称,右边为文档名称

页脚居中添加页码,页码可以是普通数字,也可以是第n页共N页,页脚字体Times New Roman,小五号字体。

4.6标题样式

文档中的同级标题样式要一致,一般情况下最少有三级标题,多的可以有六级标题。

4.7正文

正文一般采用宋体,小四,对于篇幅比较长的技术方案,可以调整为宋体、五号。

正文行距一般情况下1.5倍行距。段前、段后均为0行。

具体公式、图表根据需要排版。

4.8文档属性

文档属性包括标题、主题、作者、上次修改者,单位。一般情况下这些属性可以不修改,如果特殊文档,需要隐藏这些信息的,建议修改这些信息,作者统一修改成Admin,标题修改成文档名。单位修改成科技公司。

5文档正文规范(建议)

5.1字体规范

5.1.1正文

正文:宋体,小四号字体,内容较多情况下可以为五号字体。

字形:除特殊说明之处,字形一般为常规。

字体颜色:黑色。需要特别强调或区分的内容可采用其他颜色,但建议一篇文档中不使用超过三种字体颜色。

5.1.2数字规范

阿拉伯数字用“Times New Roman”字体显示。

5.1.3英文规范

英文用“Times New Roman”字体显示。

5.2标题编号

标题编号字体及格式建议如下,左对齐

标题具有项目编号:整个标题及编号撑起了整篇文档的栏目构架,在视图->导航窗格中应可以看清这个脉络,并且没有空行,标题连续。

所有标题段落段前段后都是0.5行,行距1.5倍行距。

以下缩进建议:

一级标题悬挂缩进 0.76厘米 - 0.90厘米

二级标题悬挂缩进 1.02厘米– 1.20厘米或者 2字符

三级标题悬挂缩进 1.27厘米– 1.80厘米

四级标题悬挂缩进 1.50厘米– 2.00厘米

5.3段落

正文中的段落一般是1.5倍行距,段前段后0行距,是否空行,紧密程度应当十分注意,不要影响整体美观。

段落一般首行缩进0.74厘米或者2个字符。第2行起顶格。

段落对齐方式:两端对齐

5.4编号

正文内容如果有需要编码序号时,可以是手工或者自动序号编码,切勿一部分自动序号,一部分手动序号,造成排版格式的不一致。

编号包括两类,一类是项目符号。项目符号原则上与当前段落的首行缩进一致。文字大小和段落与正文一样。

●第一点,悬挂缩进0.76厘米,项目编号之后,字体格式和正文一样,段

落格式也是段前段后都是0行,段落行距1.5倍。段落文字左对齐。

●第二点

●第三点

?第一项

?第二项

?第三项

第二类是数字编号,一般在阿拉伯数字、中文数字之后采用顿号、单括号进行编号。悬挂缩进合适,从数字开始与当前段落首行缩进一致,段落文字对齐。

1、第一个问题

2、第二个问题

3、第三个问题

1)编号第一

2)编号第二

3)编号第三

(一)论点一,这里悬挂缩进1.01厘米,字体与正文一样,从标题开始左侧

距离与当前段落或者标题对齐。段落内容的第二行字与第一行对齐。

(二)论点二

(三)论点三

5.5图片格式

如果是围绕图片,根据图片大小及文字内容排版,如果是嵌入式图片,一般图片居中,多图片的文档必须被引用,放在段落的前面,例如:“如下图所示”,“如图5 所示”

图片必须添加必要的题注和编号。题注和编号位置居中,采用小四或者五号宋体加粗,图释置于图的正下方;(题注图2-1中的2表示章,1表示本章的第1个图,表格与此相同);

图2-1 规范性文字内容

图与段的行间距为1.5倍。

5.6表格格式

表格按实际情况摆放,一般情况下是居中摆放。列表中的字体大小为宋体五号字。列表段落行距一般是1.5倍,如果内容比较多也可以是单倍行距。

公文格式排版规则

公文格式排版规则 一、版面要求 公文用纸统一采用A4型纸。页边距——上3.7厘米,下3.5厘米,左2.8厘米,右2.6厘米,版式——页眉1.5厘米,页脚2.8厘米。页眉页脚奇偶页不同。 为了文件整体美观,在特殊情况下,页边距、行距、字间距可进行微调。 注:在电子公文系统中,正文执行默认的页面设置,不需调整。置于附件箱中的文件根据上述要求进行设置。 二、文件格式公文各要素编排规则 版心内的公文格式各要素划分为版头、主体、版记三部分。公文首页红色分隔线以上的部分称为版头;公文首页红色分隔线(不含)以下、公文末页首条分隔线(不含)以上的部分称为主体;公文末页首条分隔线以下、末条分隔线以上的部分称为版记。页码位于版心外。 (一)版头 1.密级和保密期限。指公文的秘密等级和保密期限,应根据文件内容据实标注。一般用3号方正黑体字,顶格编排在版心左上角第二行;保密期限中的数字用阿拉伯数字标注。 2.份号。指公文印制份数的顺序号。涉密公文应标注份号,一般用3~6位3号阿拉伯数字顶格编排在版心左上角第一行,编虚位补齐,即第一份公文份号可以编为“001”、“0001”等。 3.紧急程度。指公文送达和办理的时限要求。根据紧急程度,可分别标注“加急”或“特急”,用3号方正黑体字,顶格编排在版心左上角。如需同时标注份号、密级和保密期限、紧急程度,则份号标在第一行,密级和保密期限标在第二行,紧急程度标在第三行。

4.发文单位标志。由发文单位全称或规范化简称加“文件”二字组成。联合行文时,发文单位标志可以同时标注联署发文单位名称,也可以单独使用主办单位名称,如需同时标注联署发文单位名称,一般应当将主办单位名称排列在前,“文件”二字置于发文单位名称右侧,以联署发文单位名称为准上下居中排列。 发文单位标志居中排布,上边缘至版心上边缘为35毫米,使用方正小标宋体字,颜色为红色,以醒目、美观、庄重为原则,字号不应大于上级单位。 5.发文字号。由发文单位代字、年份、发文顺序号组成。联合行文时,使用主办单位的发文字号。年份、发文顺序号用阿拉伯数字标注;年份应标全称,用六角括号“〔〕”括入。 发文字号编排在发文单位标志下空二行、红色分隔线之上的位置,其中,下行文居中排布,上行文居左空一字编排,与最后一个签发人姓名处在同一行。 公司本部印发的各类公文,其发文代字由总经理办公室统一拟定。各单位报送公司本部的正式上行文件(函件)发文代字由总经理办公室拟定,其他类型公文的发文代字由各单位自行确定。 6.签发人。上行文应当标注签发人姓名。用3号方正仿宋体字标识“签发人”三字,其后加全角冒号和签发人姓名,签发人姓名用3号方正楷体字,编排在发文机关标志下空二行位置。 如有多个签发人,签发人姓名按照发文机关的排列顺序从左到右、自上而下依次均匀编排,一般每行排两个姓名,回行时与上一行第一个签发人姓名对齐。 (二)主体 1.公文标题。 由关于+发文单位名称+事由+文种组成。用2号方正小标宋简体字,编排于红色分隔线下空两行位置。标题左右不能顶到红色分隔线边缘。如在空白页上起草正文,版心下空一行编排标题。

需求规格说明书规范

需求规格说明书规范 1.引言 1.1 编写目的 ? 阐明开发本软件的目的 ? 说明编写本软件说明书的目的 ? 指明软件需求说明书所预期的读者 1.2 项目背景 ? 标识待开发软件产品的名称、代码 ? 列出本项目的任务提出者、项目负责人、系统分析员、系统设计员、程序设计员、程序员、资料员以及与本项目开展工作直接有关的人员和用户。 ? 说明该软件产品与其他有关软件产品的相互关系。 1.3 术语说明 列出本文档中所用到的专门术语的定义和英文缩写词的原文。 1.4 参考资料 列举编写软件需求规格说明时参考的资料,包含项目经核准的计划任务书、合同、引用的标准和规范、项目开发计划、需求规格说明、使用实例文档,以及相关产品的软件需求规格说明。 在这里应该给出详细的信息,包括标题、作者、版本号、发表日期、出版单位或资金来源。 2.项目概述 1.1 待开发软件的一般描述 描述待开发软件的背景,所应达到的目标,以及市场前景等。 1.2 待开发软件的功能 简述待开发软件所具有的主要功能。为了帮助每个读者理解,可以使用列表或图形的方法进行描述。使用图形表示,可以采用: ? 顶层数据流图; ? UseCase图; ? 系统流程图; ? 层次方框图。 1.3 用户特征 描述最终用户应具有的受教育水平,工作经验及技术专长。 1.4 运行环境 描述软件的运行环境,包括硬件平台、硬件要求、操作系统和版本,以及其他的软件或其共存的应用程序等。 1.5 条件与限制 给出影响开发人员在设计软件时的约束条款,例如: ? 必须使用或避免使用特定的技术、工具、编程语言和数据库; ? 硬件限制; ? 所要求的开发规范或标准。 3.功能需求

产品说明书格式规范

XXXXX(机型,居中,宋体二号) 产品说明书 机型实物图 XXXXXXXXX公司 1 首页格式要求: 说明书首页规范格式应该无页眉和页脚。 首页内容应该包含说明书的名称、适用设备型号范围、公司LOGO等其他信息。 产品名称和产品类型必须分两行单独列出,使用相同大小的字体。首页字体:居中,宋体二号

2 目录格式 2.1 页眉页脚 目录部分的页眉、页脚的页码应该使用1、2、3类型的符号页码。其中页眉应该包含公司LOGO,产品型号,如下: 页脚部分,如下: 2.2 目录格式 1 安全事项 (6) 1.1 必须遵守的条款 (6) 1.2 须禁止的条款 (6) 1.3 XXX防范措施 (7) 一级标题:宋体,小四,加粗,左对齐,无缩进,单倍行距。 二级标题:宋体,小四,左对齐,首行缩进1字符,单倍行距。 三级标题:宋体,五号,左对齐,首行缩进2字符,单倍行距。 3 正文格式示例: 1 安全事项 1.1 安全装置 1.1.1紧急停止按钮 紧急停止按钮作用时,整个成型机注意和警告信息 正文文本:宋体,小四,两端对齐,左对齐,首行缩进2字符,1.5倍行距。

正文表格、图片:居中,行距1.5倍行距。 表格、图片题注格式:宋体10号,居中,单倍行距,编号格式“图\表+所在章节的阿拉伯数字+.+图片序号”,右对齐。 正文页眉页脚: 目录部分的页眉、页脚的页码应该使用1、2、3的符号页码。其中页眉应该包含公司LOGO,公司名称; 正文部分的页脚页码显示从正文第一页开始起始页码为1。 3.2 正文内容顺序 第一章:安全事项 第二章:主要技术参数 第三章:概述设备型号、规格、主要性能、结构示意图等内容。第四章:保养与维护 第五章:设备安装 第六章:设备调试 第七章:常见故障处理 第八章:附件 附录: 注:说明书各章节的内容应根据实际情况可调整,但是总体信息必须包含安装、调试、操作、使用、维护、保养的基本信息。

产品说明书和用户文档集撰写要求概论

附件4:产品说明的提交要求 说明:红字条款可根据软件产品实际情况进行剪裁,黑字条款为标准要求必须说明的项目。斜体字是对国家标准条款的解读或举例,仅供使用者参考。 一、产品说明: 【定义】 陈述软件各种性质的文档,目的是帮助潜在的需方在采购前对该软件进行适用性评价。 解读:产品说明为供方在进行产品销售时对产品性质的宣传资料,目的是让采购方获得产品概况,判断该产品是否能够满足自己的需求,进而决定是否采购该产品。 【要求】 产品说明对于需求方是可用的,包含潜在需方所需的信息,信息内容应排除内部的不一致,且与用户文档集和软件实际情况一致,产品说明的内容应该是可以验证或测试的,产品说明应有唯一性标识,当产品说明内容超出一页文档时,要有封面和目录,方便使用者进行内容查找。 【内容】 1、软件产品应以其名称、版本和日期指称; 解读:软件产品要用名称+版本或名称+日期命名。 例如:城市水资源管理系统软件V1.0或城市水资源管理系统软件2011。 2、产品说明应显示唯一的标识; 解读:产品说明在封面或卡片的显著位置显示唯一的产品标识。 例如:城市水资源管理系统软件V1.0产品说明。 3、产品说明应包含供方和至少一家销售商(当适用时)电子商务销售商或分销商的名称和地址(邮政的或网络的)。 解读:产品说明在封面或卡片的显著位置显示供方和销售商信息一般包括名称和地址,且供方和销售商可以为同一企业或个人。 4、产品说明应标识该软件能够完成的预期的工作任务和服务; 解读:此项描述软件的销售方向,适用的行业,潜在的客户群,概要介绍软件的用途。

例如:本软件为水务行业管理软件,适用于各供水公司、净水厂、水污染处理企业、政府水资源行业管理部门,可完成水资源相关业务的管理及实施对水资源处理装置的动态监控和实时处理。 5、供方想要声称软件产品符合由法律或行政机构界定的要求时,产品说明应标识出这些法律或行政机构界定的要求的需求文档; 解读:供方为加大产品的宣传力度,增强产品竞争力,更好的销售其软件产品,可表明其产品符合法律或行政机构界定的要求。但必须将符合的内容在产品说明中进行详细说明。 例如:本软件符合中华人民共和国水利行业标准SL475-2010水利信息公用数据元标准,该标准的详细信息参见附录一 6、产品说明应以适当的引用文档指名产品在何处依赖于特定软件和(或)硬件;解读:当产品在某些情况下需要依赖于特定的软件和(或)硬件才能实现其生成的产品性质时,要对这些特定的软件和(或)硬件进行描述,以便采购方在采购产品时能够合理评价采购成本。 例如:本软件在对水资源处理装置进行远程动态监控及实时处理时如传输距离超过50米需要信号放大器或无线信号发射器与无线信号接收器 7、产品说明引证已知的对其他软件的用户可调用的接口时,应标识出这些接口或软件; 解读:如果软件再使用过程中需要调用其他软件许可的接口时,应说明这些接口或软件从而使采购方在选择该产品时,明确还需购买其他接口许可或软件。 例如:本软件运行时需要调用水资源信息实时处理业务系统V1.0 8、产品说明应指明产品期望在单一系统上供多个并发最终用户使用或供一个最终用户使用,并且应说明在所要求的系统的所陈述的性能级别上可行的最大并发最终用户数; 例如:当软件支持并发时,此处可进行如下类似描述:本软件在单一系统上可供多个并发最终用户使用,在服务器主频大于3.0GHZ、内存大于2GB、响应时间小于5秒的情况下最大100并发最终用户。 当软件不支持并发时,此处可进行如下类似描述:本软件在单一系统上只供一个最终用户使用,不支持并发操作。

政府公文格式规范

附件1 上报公文参考格式 一、公文用纸幅面尺寸及版面要求 (一)幅面尺寸 公文用纸采用GB/T148中规定的A4型纸。 (二)版面 1. 页边与版心尺寸。公文用纸天头(上白边)为37mm,下白边为35mm,公文用纸订口(左白边)为28mm,右白边为26mm,版心尺寸为156mm×225mm。发文机关上边缘至用纸上边缘约72mm,至版心上边缘为35mm。 2. 字体和字号。标题采用2号方正小标宋简体(方正小标宋_GBK),“签发人”三字使用3号方正仿宋(方正仿宋_GBK),签发人姓名使用3号方正楷体(方正楷体_GBK),正文使用3号方正仿宋(方正仿宋_GBK),版记中的要素使用4号方正仿宋(方正仿宋_GBK)。 3. 行数和字数。每页排22行,每行排28个字,并撑满版心,即行距固定值28磅。特定情况可作适当调整。 4. 文字的颜色。公文中除了发文机关标志、版头中的分隔线、发文机关印章和签发人签名章为红色外,其余文字部分均为黑色。 二、公文的版头

(一)发文机关标志 1. 由发文机关全称或者规范化简称加“文件”二字组成,也可以使用发文机关全称或者规范化简称。 2. 发文机关居中排布,用小标宋体字(方正小标宋简体),颜色为红色。 (二)发文字号 1. 由发文机关代字、年份、发文顺序号组成。联合行文时,使用主办机关的发文字号。 2. 发文字号编排在发文机关下空二行位置,居中排布。年份、发文顺序号用阿拉伯数字标注;年份应标全称,用六角括号“〔〕”括入,不得使用“[ ]”方括号或“()”圆括号;发文顺序号不加“第”字,不编虚位(即1不编为01),在阿拉伯数字后加“号”字。 3. 如果是平行文,居中排布;如果是上行文,则居左空一字编排,与最后一个签发人姓名同处一行。 (三)签发人 1. 请示报告类上行文应当标注签发人姓名。 2. 由“签发人”三字加全角冒号和签发人姓名组成,居右空一字,编排在发文机关标志下空二行位置。“签发人”三字用3号方正仿宋(方正仿宋_GBK),签发人姓名用3号方正楷体(方正楷体_GBK)。

需求规格说明书规范

案 智能家居安防系统 需求规格说明书 牛耳公司 版权所有侵权必究 文档信息

修订记录 文档审核/审批 此文档需如下审核。签署过的审批表将作为附件归入PCB的质量控制章节。 文档分发 此文档将分发至如下各人 - 1 -

目录 1引言 (4) 1.1编写目的 (4) 1.2读者对象........................................................................... 错误!未定义书签。 1.3背景................................................................................... 错误!未定义书签。 1.4定义................................................................................... 错误!未定义书签。 1.5约定 (5) 1.6参考文档 (5) 2产品任务 .............................................................................................................. 6是2.1目标 (6) 2.2定位 (6) 2.3前景 (6) 2.4用户角色分析 (7) 2.5假定和约束 (7) 3用户需求 (8) 3.1系统组成 (8) 3.2子系统组成....................................................................... 错误!未定义书签。4需求细节描述 ......................................................................... 错误!未定义书签。 4.1门、窗、阳台的监控和报警........................................... 错误!未定义书签。 4.2火灾的报警....................................................................... 错误!未定义书签。 4.3煤气泄漏告警 ................................................................. 错误!未定义书签。 4.4实时监控和查询............................................................... 错误!未定义书签。 4.5安防模式切换................................................................... 错误!未定义书签。5非功能性需求 (11) 5.1软硬件环境需求(NF-非功能性需求编号) 5.2产品质量需求........................................................................................................

Word文档格式规范标准[详]

Word文档格式规 (2018) 封 面 编制单位:12346789 编制时间:2018年7月7日

目录 一、文档设置 (3) (一)页面设置 (3) (二)封面、标识、目录 (3) (三)文本标题 (3) (四)正文格式 (4) (五)字体、字号 (4) (六)段落 (4) (七)页码设置 (4) (八)打印 (4) (九)装订 (5) 二、以表格为主的文档设置 (5) (一)页面设置 (5) (二)标题字体、字号 (5) (三)容字体、字号 (5) (四)表单的设置 (5) 三、各类文件、电子文档格式要求 (5) (一)、工作简报 (5) (二)、会议纪要 (6) (三)、新闻稿 (6) (四)、工作总结 (6) (五)、办公室通报 (7)

一、文档设置 (一)页面设置 一般情况下页边距:上2.54厘米;下2.54厘米;左3.18厘米;右3.18厘米。(如一页篇幅仅有一两行文字,适当缩减整体文字页边距,将此页篇幅文字调至上一页。)文字材料有明确模板要求的,按要求设置页面。 (二)封面、标识、目录 封面:活动指南、专业性方案、报告等文字材料,在有明确要求的情况下,可带封面。一般情况下,文字材料不带封面,看个人喜好, 标识:有明确要求的,在封面或材料首页的左上角添加标识。一般情况下,文字材料不带标识。 目录:两端对齐,美观大方,目录后在加页码。 (三)文本标题 1.当文档标题级别较多时,一级、二级、三级, .. 标题依次使用“一、(一)、1、(1)、①”,若文档标题级别较少,可直接使用“一、1、”。 2.主标题:方正小标宋简体,二号,不加粗,段落行距固定值为36磅。 3.一级标题:黑体,三号,不加粗,顶格对齐,段前段后0.5字符,段落行距固定值为28磅,序号为大写数字后加顿号。 4.二级标题:楷体_GB2312,三号,加粗,顶格对齐,段前

文档编写规范-模板

XXX有限公司文档编写规范

*变化状态:A——增加,M——修改,D——删除

目录 前言................................................................................................................................................................ - 4 -第1章(居中/二号/宋体/TIMES NEW ROMAN/加粗/另起一页)................................................... - 5 - 1.1 (偏左/三号/黑体/Arial/加粗) ............................................................................................ - 5 - 1.1.1 (偏左/三号/宋体/Times New Roman/加粗)........................................................... - 5 - 1.1.1.1 (偏左/四号/黑体/Arial/加粗) ...................................................................... - 5 -

前言【本部分可以有,也可以没有,根据实际情况自定】时间:2010-12-15

第1章(居中/二号/宋体/Times New Roman/ 加粗/另起一页) 1.1 (偏左/三号/黑体/Arial/加粗) 【具体内容】 1.1.1 (偏左/三号/宋体/Times New Roman/加粗) 【具体内容】 1.1.1.1 (偏左/四号/黑体/Arial/加粗) 【具体内容】 贴图格式(居中) 序号格式 1. ● ● ● 2. 3.

最新国家标准公文格式

最新国家标准公文格式 标题(2号小标宋体) 发文对象:(标题下一行顶格,3号仿宋) X X X X X X X X X X(正文3号仿宋体字) 一、X X X(黑体) X X X X X X X X X X(正文3号仿宋体字) (一)X X X(楷体) X X X X X X X X X X(正文3号仿宋体字) X X仿宋 X X X X X X X X X X(正文3号仿宋体字) (1)X X X仿宋 X X X X X X X X X X X(正文3号仿宋体字) 附件: X X(正文下一行右空两字) X X 单位名称(附件下两行居成文日期中) 成文日期(右空四字,用阿拉伯数字)(联系人:……;联系电话:……)(如有附注,居左空二字加圆括号编 排在成文日期下一行。) (说明)1.标题:一般用2号小标宋体字,分一行或多行居中排布;回行时,要做到词意完整,排列对称,长短适宜,间距恰当,标题排列应当使用梯形或菱形。 2.正文:一般用3号仿宋体字,每个自然段左空二字,回行顶格。文中结构层次序数依次可以用“一、”“(一)”“1.”“(1)”标注;一般第一层用黑体字、第二层用楷体字、第三层和第四层用 仿宋体字标注。 3.附件:如有附件,在正文下空一行左空二字编排“附件”二字,后标全角冒号和附件名称。如有多个附件,使用阿拉伯数字标注附件顺序号(如“附件:1. XXXXX”);附件名称后不加标点符号。附件名称较长需回行时,应当与上一行附件名称的首字对齐。 附件应当另面编排,并在版记之前,与公文正文一起装订。“附件”二字及附件顺序号用3号黑

体字顶格编排在版心左上角第一行。附件标题居中编排在版心第三行。 4.发文机关署名:单一机关行文时,在正文(或附件说明)下空一行右空二字编排发文机关署名,在发文机关署名下一行编排成文日期,首字比发文机关署名首字右移二字,如成文日期长于发文机关署名,应当使成文日期右空二字编排,并相应增加发文机关署名右空字数。 5.成文日期中的数字:用阿拉伯数字将年、月、日标全,年份应标全称,月、日不编虚位(即 1不编为01)。 6.页码:一般用4号半角宋体阿拉伯数字,编排在公文版心下边缘之下,数字左右各放一条一字线;一字线上距版心下边缘7 mm。单页码居右空一字,双页码居左空一字。公文的版记页前有空白页的,空白页和版记页均不编排页码。公文的附件与正文一起装订时,页码应当连续编排。 此样式根据2012《党政机关公文格式国家标准》编写而成,标准中未提及具体行距,一般公文中标题行距28磅。正文及其他单倍行距。如有不当请指正。 函的写作格式 函的类别较多,从制作格式到内容表述均有一定灵活机动性。主要介绍规范性公函的结构、内容和写法。公函由首部、正文和尾部三部分组成。其各部分的格式、内容和写法要求如下: (一)首部。主要包括标题、主送机关两个项目内容。 1、标题。 2、主送机关。 (二)正文。其结构一般由开头、主体、结尾、结语等部分组成。 (三)结尾。一般用礼貌性语言向对方提出希望。或请对方协助解决某一问题,或请对方及时 复函,或请对方提出意见或请主管部门批准等。 (四)结语。通常应根据函询、函告、函或函复的事项,选择运用不同的结束语。如“特此函询()”、“请即复函”、“特此函告”、“特此函复”等。有的函也可以不用结束语,如属便函,可以 像普通信件一样,使用“此致”、“敬礼”。 (五)结尾落款。一般包括署名和成文时间两项内容。 署名机关单位名称,写明成文时间年、月、日;并加盖公章。 XXX关于XXX的函(2号小标宋体) 主送机关:(标题下一行顶格,3号仿宋) X X X X X X X X X X(正文3号仿宋体字) 特此函达,恳请批复。(结语灵活变动) 附件: X X(正文下一行右空两字) X X 单位名称(附件下两行居成文日期中) 成文日期(右空四字用阿拉伯数字)

需求规格说明书

文件编号: 受控状态:■受控□非受控 保密级别:■公司级□部门级□项目级□普通级 记录编号: 分发编号: xxx公司云平台 需求规格说明书 Version 1.0 2014.07.23

需求规格说明书模板

目录 1前言 (4) 1.1编写目的 (4) 1.2文档约定 (4) 1.3读者对象 (4) 1.4术语和缩略词 (5) 1.5参考文档 (5) 2项目概述 (5) 2.1项目背景 (5) 2.2项目目标 (5) 2.3需求范围 (6) 2.4总体框架 (6) 2.5组织机构 (6) 2.6用户特点 (6) 2.7设计约束 (6) 3功能性需求 (6) 3.1总体流程 (6) 3.2角色定义 (7) 3.3系统功能 (7) 3.4功能描述 (7) 4非功能性需求 (11) 4.1软件需求 (11) 4.2硬件需求 (12) 5外围系统和接口 (13) 5.1系统A (13) 5.2系统B (13) 6其他需求 (14) 7数据字典 (14) 8附件 (14)

1 前言 1.1 编写目的 [说明编写这份需求规格说明书的目的,指出预期的读者(一般包括评审人员、软件设计人员、软件开发人员,针对具体情况,还可能包括客户),它是软件开发的基础。] 1.2 文档约定 [描述编写文档时所采用的字体标准或排版约定,包括标题和正文的字体和字号约定。完成文档编写后,文档编写完成后本部分须裁剪] 字体大小约定: 标题1 宋体三号加粗 标题2 宋体小三号加粗 标题3 宋体四号加粗 标题4 宋体小四号加粗 标题5 宋体小四号 正文宋体五号 段落约定:文章中每段落需抬头,即段落开头需有两字元的缩排,单倍行距。 表与图编号约定:文中所有表、图须按章节编号,如:第四章节第二个表,编号为:表4-2。裁剪约定:如标注可裁剪提示信息,表示该部分内容可以裁剪或删除。 1.3 读者对象 [描述本需求规格说明书的主要读者。建议将不同读者的阅读重点与建议以列表方式表现,]

规划设计3文本及说明书编排的格式要求

封面:自行设计(可以是PS设计的) (封面上必须要有姓名、学号、指导老师等信息)

任务分工表 XXX XXX 任务清单任务清单

第一部分:文本第二部分:图纸第三部分:说明书

第一部分:文本

目录 第一章 总则 .............................................................. 错误!未定义书签。 第一节 XXXX ............................................................. 错误!未定义书签。 黑体小三号,居中,两字之间不空格。“目录”上、下各空一行。 一级标题宋体、四号字、加粗;二级标题和内容宋体,四号字;目录可编至二级标题,每一级标题与相应内容之间空一格;目录表述与正文应一致。 从目录开始编页码:目录起始页码为大写的罗 马数字

永胜县城市总体规划(2012-2030)文本 第一章 总则 第一节 XXXX 第一条 XXXX XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX 大纲级别1级,黑体小三号字,居中、加粗,1.5倍行距,上、下各空一行。 每一章另起一页 页眉:宋体,五号,右对齐 正文:宋体四号字,1.5倍行距,首行缩进2字符。 条目名目:宋体四号字,1.5倍行距,左对齐。其中条标号“第几条”加粗。 大纲级别2级,黑体小三号字,居中,1.5倍行距,下空一行。(可以有,也可以没有) 注意正文:起始页码为1

文件编写规范

密级:内部公开 文档编号: 版本号:V1.0 分册名称:第1册/共1册 文件编写规范 xxx科技有限公司 编制:生效日期: 审核:批准:

文件更改摘要 日期版本号修订说明修订人审核人批准人

目录 1.目的和范围 (4) 2.目标 (4) 3.术语表 (4) 4.文档编号规则 (5) 5.文档命名规范 (5) 6.文件结构规定 (6) 7.封面 (7) 8.修订页 (8) 9.正文内容格式 (8) 10.文件版本号和文件命名规定 (9) 10.1.文件版本号规定 (9) 10.2.文件命名规定 (9)

1.目的和范围 ●背景说明:本文件作为公司内部文档管理文件,所有公司内编写的文档,均应遵 守本规定,作为公司的所有文档编写统一要求。 ●范围:所有的CMMI执行过程中产生的文档,均应当执行本文件要求作为基础的要 求,如果该部分的体系文件存在明确的要求的,按照体系文件要求执行,没有的则按照本文件执行。 2.目标 规范和统一公司管理体系中所有相关文件的风格和样式,指导公司程序文件、模版文件以及各种记录文件的编写。 3.术语表 ●文件标识:文件的属性标志,包括文件名称、文件编号、版本、生效日期、 审批状态、密级等。 ●程序文件:描述为完成管理体系中所有主要活动提供方法和指导,分配具体的职责 和任务而定义的文件。 ●模版文件:为了使管理体系有效运行,组织统一设计的一些实用的表格和给出活动 结果的报告,规范记录组织的管理体系运行情况。 ●记录文件:简称记录,是组织根据设计的模版和体系要求,填写的表格或者给出活 动结果的报告,作为管理体系运行的证据。 ●修订页:记录文件的修订历史,所有程序文件、除了表格以外的模版和记录都需要 有变更履历,一般位于程序文件的第二页。 ●文档密级:指本文档的保密程度,共分绝密、机密、秘密、内部公开、公开五级制 度。 ●绝密:涉及公司与客户或上游供应商,下游分销商所签订相关的文档资料。仅 限于公司最高管理层及各资料所涉及的经过相应管理人员授权的相关人员查 阅。 ●机密:公司内部所相关的规章制度及技术规范,开发手册等;还有各项目开发 文档、管理文档及软件产品等仅供相关部门高级领导以及经过授权后相关人员 查阅。 ●秘密:需交付用户或与客户进行交流的文档与产品,可供相关项目客户查阅。 ●内部公开:内部不限制,公司内部任何可以任何形式获得文档的信息并阅读、 保存、修改后自用等等,但是不允许向外传播的文件。 ●公开:项目组开发过程中的自用文档或面向售前工作的部分项目介绍材料等。 ●版本标识:作为文档的版本区分。所有发布版本之前不得大于1.0,发布版本作为 1.0,而其后只有重大修改可以调整小数点前的版本号,局部修改调整小数点后版

公文格式规范文字说明

附件1: 公文格式规范文字说明 一、公文必须用A4型纸,页面设置为页边距上3cm、下3cm、左2.8cm、右2.6cm。 二、发文单位标识由发文单位全称加“文件”组成,平行文或者下行文距上页边空2行,上行文空8行。 三、发文字号由代字、年份和序号组成。发文字号位于发文单位标识下空1行,用3号仿宋体字,居中排列于红线上(红线与字号之间行距为28磅);年份、序号用阿拉伯数码标识;年份应标全称,用六角括号“…?”括入;序号不编虚位(即1不编为001),不加“第”字。发文字号之间不留空格。 四、上报的公文,发文字号居左空1字,签发人姓名居右空1字;签发人用3号仿宋体字,签发人后标全角冒号。 五、公文标题:红色反线下空2行,用宋体2号加粗,可分一行或多行居中排布、回行时要做到词意完整,排列对称,间距恰当,标题中一般不用标点符号。 六、主送机关:标题下空1行,左侧顶格。用3号仿宋字标识,多个主送机关间用顿号分开,最后一个主送机关名称后标全角冒号。 七、公文正文:主送机关名称下1行。每自然段左空2字,回行顶格;数字、年份不能回行;正文用3号仿宋GB2312字体,行间距为固定值28磅,每页居中注明页码。 八、附件:公文如有附件,在正文下空1行,左空2字,用

3号仿宋字标识“附件”,后标全角冒号和名称,附件如有序号使用阿拉伯数码,附件名称后不加标点符号(如附件:1、x x x x)。如附件标题过长回行时应与附件名称首字符对齐。 九、成文日期及印章:正文后空3行标识日期,成文日期右空4字。必须使用插入日期。单一机关制发的公文在落款处不署发文机关名称。 十、主题词:“主题词”用3号黑体字,居左顶格标识,后标全角冒号,词目用3号黑体字;词目之间空1字。 十一、抄送机关:公文如有抄送机关,在主题词下1行,左空1字,用3号仿宋体字标识“抄送”。后标全角冒号;抄送机关之间用逗号隔开,回行时与冒号后的抄送机关对齐,在最后一个抄送机关后标句号。 十二、印发机关和印刷日期:位于抄送机关之下(无抄送机关在主题词之下)占1行位置,用3号仿宋体字。印发机关左空1字,印刷日期右空1字。用阿拉伯数码标识。 十三、印刷数量:位于印发机关之下,占一行位置,用3号仿宋体字,阿拉伯数码标识,右空1字。 十四、上报文件数量:上报市政府必须一式三份。

需求规格说明书

模板名称:需求规格说明书 秘级:仅供内部使用 模板版本:V1.0 本模板最后修订日期:2014-04-24 XX项目 需求规格说明书

历史记录

目录 1引言 (4) 1.1编写目的 (4) 1.2背景 (4) 1.3定义 (4) 1.4参考资料 (4) 2任务概述 (4) 2.1目标 (4) 2.2用户的特点 (4) 2.3假定和约束 (5) 3需求规定 (5) 3.1对功能的规定 (6) 3.2对性能的规定 (7) 3.2.1 精度 (7) 3.2.2时间特性要求 (7) 3.2.3 灵活性 (7) 3.3输入输出要求 (8) 3.4数据管理能力要求 (8) 3.5故障处理要求 (8) 3.6其他专门要求 (8) 4运行环境规定 (8) 4.1设备 (8) 4.2支持软件 (8) 4.3 接口 (9) 4.4控制 (9)

1引言 1.1编写目的 [说明编写这份需求说明书的目的,指出预期的读者。] 1.2背景 a.待开发的系统的名称; b.本项目的任务提出者、开发者、用户; c.该系统同其他系统或其他机构的基本的相互来往关系。 1.3定义 [列出本文件中用到的专门术语的定义和外文首字母组词的原词组。] 1.4参考资料 [列出用得着的参考资料。] 2任务概述 2.1 目标 [叙述该系统开发的意图、应用目标、作用范围以及其他应向读者说明的有关该系统开发的背景材料。解释被开发系统与其他有关系统之间的关系。] 2.2 用户的特点 [列出本系统的最终用户的特点,充分说明操作人员、维护人员的教育水平和技术专长, 以及本系统的预期使用频度。] 2.3 假定和约束

使用说明书格式规范

首页格式要求: 说明书首页规范格式应该无页眉和页脚。 首页内容应该包含说明书的名称、适用设备型号范围、适用的软件版本、版本信息、公司LOGO、发行日期等其他信息。 产品名称和产品类型必须分两行单独列出,建议使用相同大小的字体。 目录 目录部分的页眉、页脚的页码应该使用Ⅰ、Ⅱ、Ⅲ类型的符号页码。 其中页眉应该包含公司LOGO,公司名称,说明书的名称,如下: 页脚部分,如下: 目录格式 目录仅显示前3级标题。 一级标题: 宋体+Arial,小四,加粗,左对齐,段前6磅,段后6磅,单倍行距。 二级标题: 宋体+Arial,小四,左对齐,左缩进0.37厘米,段前0行,段后0行,单倍行距。 三级标题: 宋体+Arial,五号,左对齐,左缩进0.74厘米,段前0行,段后0行,单倍行距。 标题格式 一级标题: 黑体+Arial,加粗,三号,两端对齐,大纲级别1级,悬挂缩进0.76厘米,段前0行,段后0行,行距多倍行距,设置值2.41,非正规编号格式“第*章”,编号位置左对齐,对齐位置0厘米,制表位位置0.76厘米,缩进位置0.76厘米。二级标题:

宋体+Arial,加粗,四号,两端对齐,大纲级别2级,悬挂缩进1.02厘米,段前0行,段后0行,1.5倍行距,正规编号,起始编号阿拉伯数字“1”,编号位置左对齐,对齐位置0厘米,制表位位置1.02厘米,缩进位置1.02厘米。 三级标题: 宋体+Arial,加粗,小四,两端对齐,大纲级别3级,悬挂缩进1.27厘米,段前0行,段后0行,1.5倍行距,正规编号,起始编号阿拉伯数字“1”,编号位置左对齐,对齐位置0厘米,制表位位置1.27厘米,缩进位置1.27厘米。 四级标题: 宋体+Arial,加粗,五号,两端对齐,大纲级别2级,悬挂缩进1.52厘米,段前0行,段后0行,1.5倍行距,正规编号,起始编号阿拉伯数字“1”,编号位置左对齐,对齐位置0厘米,制表位位置1.52厘米,缩进位置1.52厘米。 正文文本: 宋体+Times New Roman,五号,两端对齐,左缩进1.48厘米,首行缩进2字符,段前0行,段后0行,行距1.5倍行距。 正文表格、图片: 居中,行距1.5倍行距。 表格、图片题注格式: 宋体+Arial,10号,居中,首行缩进0.86厘米,段前0行,段后0行,单倍行距,编号格式“图\表+所在章节的阿拉伯数字+.+图片序号”,右对齐,对齐位置0.86厘米,制表位位置0.9厘米。 正文页眉页脚: 目录部分的页眉、页脚的页码应该使用1、2、3的符号页码。 其中页眉应该包含公司LOGO,公司名称,说明书的名称,如下: 正文部分的页脚如下,页码显示从正文第一页开始起始页码为1。 页面设置 页边距上、下1.5厘米,左、右2.5厘米,纸张大小,A4纸宽度21厘米,

需求分析规范——附加说明1用例描述文档编写规范

百度文库 - 让每个人平等地提升自我 需求分析规范 用例描述文档编写规范(精要) 版本 <> 文档编号:001-0002-2

版本历史 日期版本描述作者2006-07-01 <> 初稿整理吕春秋

目录 1.前言5 1.1目的5 1.2范围5 1.3本文档说明5 2.基本要求6 3.用例事件流的描述6 3.1基本事件流的要求7 3.2子事件流的要求7 3.3备选事件流的要求8 3.4事件流中的序号标号9 3.5事件流中“确认”与“执行”操作描述的建议9 4.业务规则的描述9 4.1业务规则的种类9 4.1.1业务规则的抽取及编号10 4.1.2公共业务规则的抽取及编号10 4.2业务规则描述结构10 4.2.1要点说明式10 4.2.2顺序结构11 4.2.3分支结构11 4.2.4循环结构12 4.2.5混合结构13 4.2.6注意事项13 4.3业务规则描述中的缩进规则13 4.4业务规则描述中的标号13 5.子用例的定义与描述13 5.1子用例的设计方法13 5.2子用例中判断上级调用用例的方法13 6.用例描述中的其它规范14 6.1类、属性、参数、值的书写规则14 6.1.1类名的书写规则14 6.1.2属性名的书写规则14 6.1.3参数名的书写规则14 6.1.4各种值的书写规则14 6.2用例描述中的注释信息15 6.2.1注释要求15 6.2.2注释信息的描述15 6.3描述一致性15 7.接口15 8.新一代ERP系统中的几个公共机制15

8.1删除完整性检查15 8.2消息机制16 8.3编号管理16 9.用例描述中用词规范16 9.1范围值的描述16

公文格式规范

间距35mm 公文格式规范 XX字〔2015〕XX号 间距4mm (抬头空两行) 标题(方正小标宋简体2号居中) (下空一行3号字) XXXXXXXXXXX (顶格,一排不够时第二排也顶格) XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX XXXXXXXXXX:(全角冒号) 一、正文 正文为三号仿宋,编排于主送机关名称下一行,每个自

然段左空二字,回行顶格。行间距28,页边距:上3.7cm,下3.5cm,左2.8cm,右2.6cm),一般每页22行,每行28字。 二、标点及段落层次的规范 一级标题:黑体三号,例:一、 二级标题:楷体简体三号,例:(一) 三级标题:仿宋简体三号,例:1. 四级标题:仿宋简体三号,例:(1) 标题独占行,末尾不加标点 三、附件 在正文下空一行左空二字编排“附件”二字,后标全角冒号和附件名称。如有多个附件,使用阿拉伯数字标注附件顺序号(如“附件:1.XXXXX”);附件名称后不加标点符号。附件名称较长需回行时,应当与上一行附件名称的首字对齐。 四、落款 单一发文机关印章居中下压发文机关署名和成文日期,使发文机关署名和成文日期居印章中偏下,印章顶端上距正文或附件说明一行以内。成文日期一律用阿拉伯数字,年份写全,月、日不虚位,例:2015年9月9日 (一)需要加盖公章的文件落款

发文单位与正文空三行 (与日期相对居中)X X市X X区X X X X 2015年11月17日(空四字) (二)不需要加盖公章的文件落款 发文单位与正文空一行 1.如单位名称长于日期,则单位名称右空两格,日期左边与单位名称第三个字对齐 例: XX市XX县XXXX(空两字) 2017年10月16日 2.如果单位名称短于日期,则日期右空两格,日期左边与单位名称第三个字对齐 例: X X市X X局 2015年12月11日(空两字) 五、附件内容

软件需求规格说明书

XXX项目 软件需求规格说明书 ---------------------------------------------------------------------合肥安慧软件有限公司对本文件资料享受著作权及其它专属权利,未经书面许可,不得将该等文件资料(其全部或任何部分)披露予任何第三方,或进行修改后使用。

1.引言.................................................... 错误!未定义书签。 . 项目背景............................................. 错误!未定义书签。. 编写目标............................................. 错误!未定义书签。. 建设目标(可选)..................................... 错误!未定义书签。. 系统范围............................................. 错误!未定义书签。. 定义/术语/缩写....................................... 错误!未定义书签。. 参考资料............................................. 错误!未定义书签。. 文档阅读指南(可选)................................. 错误!未定义书签。 2.总体说明................................................ 错误!未定义书签。 . 产品介绍............................................. 错误!未定义书签。. 假设和依赖(可选)................................... 错误!未定义书签。. 局限性和排斥性(可选)............................... 错误!未定义书签。 3.功能描述................................................ 错误!未定义书签。 . 业务描述............................................. 错误!未定义书签。. 用户说明............................................. 错误!未定义书签。. 基本配置及运行环境................................... 错误!未定义书签。. 用户场景............................................. 错误!未定义书签。 用例总览......................................... 错误!未定义书签。 详细用例说明..................................... 错误!未定义书签。 4.非功能性需求............................................ 错误!未定义书签。 . 性能要求............................................. 错误!未定义书签。. 可靠性(可选)....................................... 错误!未定义书签。. 安全性(可选)....................................... 错误!未定义书签。. 可移植性(可选)..................................... 错误!未定义书签。. 设计限制(可选)..................................... 错误!未定义书签。. .电源、工艺结构要求(可选).......................... 错误!未定义书签。. 逻辑数据库需求(可选)............................... 错误!未定义书签。. 其他需求............................................. 错误!未定义书签。 5.接口说明................................................ 错误!未定义书签。 . 用户界面............................................. 错误!未定义书签。. 硬件接口............................................. 错误!未定义书签。. 软件接口............................................. 错误!未定义书签。. 通信接口............................................. 错误!未定义书签。 6.需求变更流程............................................ 错误!未定义书签。 7.设计描述(可选) ........................................ 错误!未定义书签。

相关文档
最新文档