当前位置:文档之家› 统计表编制规范 用户手册编制规范

统计表编制规范 用户手册编制规范

统计表编制规范 用户手册编制规范
统计表编制规范 用户手册编制规范

统计表编制规范用户手册编制规范

用户手册编制规范沈阳东大阿尔派软件股份有限公司2000.2 版权声明《用户手册编制规范》的版权归沈阳东大阿尔派软件股份有限公司所有。未经沈阳东大阿尔派软件股份有限公司的书面准许,不得将本规范的任何部分以任何形式、采用任何手段(电子的或机械的,包括照相复制或录制)、或为任何目的,进行复制或扩散。

(c)Copyright 2000 沈阳东大阿尔派软件股份有限公司。版权所有,翻制必究。

是沈阳东大阿尔派软件股份有限公司的注册商标。

Microsoft、word是Microsoft Corporation的注册商标。

Windows是Microsoft Corporation的商标。

前言用户手册对于任何产品都是不可缺少的组成部分。一个好的产品没有一份完备的用户手册,也不能算作一个完备的产品。对于软件产品来说更是如此,没有用户手册的软件不能算产品,没有好的用户手册,就不可能算好产品。也就是说,一个好的软件产品除了具备与市场对路的思想、良好的用户界面、完备的测试之外,还必须有一本适合用户使用的用户手册。

本规范手册不仅指明了软件用户手册的内容,而且规定了沈阳东大阿尔派软件股份有限公司软件用户手册的统一版面、格式。本规范手册就是按本规定编写的,但由于本规范手册内容的局限性,很难以样本的形式表现软件用户手册中可能出现的各种情况,所以请大家认真阅读本规范手册的内容。

我们希望沈阳东大阿尔派软件股份有限公司的相关人员,能够按照本规范手册编写自己的软件用户手册,做好我们的软件产品化工作。由于时间仓促,编者水平有限,希望大家能够提出宝贵意见,以逐步完善本规范手册的内容。

阅读指南〖手册目标〗本手册主要对沈阳东大阿尔派软件股份有限公司软件产品的用户手册所应包含的内容及版面格式作一个初步的统一规定。由于实际情况千变万化,本规定很难一次做到面面俱到,需要逐渐完善。

〖阅读对象〗本手册是为沈阳东大阿尔派软件股份有限公司的所有软件开发人员和软件用户手册编写人员所编写的。由于本手册中的格式规定部分是根据Microsoft Windows 下的Word 的功能而编写的,所以沈阳东大阿尔派软件股份有限公司的软件用户手册应该使用MicroSoft Word排版。

〖手册构成〗本手册基本上由两部分组成:

1. 第1章,“关于用户手册排版格式的规定”,规定了用户手册标题及编号的格式。

2. 第2章,“用户手册的内容”,规定了用户手册所应包含内容较为详细的清单。

另外,本手册基本上是按“用户手册格式的统一规定”编写的一个样本。

〖手册约定〗本手册遵循以下约定:

1. 所有标题均使用黑体字。

2. 如果标题后跟有“〖条件〗”字样,说明该标题下正文所要求的内容是在一定条件下必须的。

【注意】的意思是请读者注意那些需要注意的事项。

【警告】的意思是请读者千万注意某些事项,否则将造成严重错误。

目录第1章用户手册格式规定1-1 §1.1 标题及编号1-1 §1.1.1 章标题的设置1-1 §1.1.2 节标题的设置1-1 §1.1.3 小节标题的设置1-1 §1.1.4项目符号和编号的设置1-2 §1.1.5 其它编号的设置1-3 §1.2 正文及页眉页脚的排版1-4 §1.2.1 正文排版1-5 §1.2.2 版面设置1-5 §1.2.2.1 版面设置1-5 §1.2.2.2 关于页眉、页脚的设置1-5 §1.2.2.3 注意与警告1-5 第2章用户手册的内容2-1 §2.1 用户手册的目标2-4 §2.2 用户手册的内容2-4 §2.2.1 封面2-4 §2.2.2 二封2-4 §2.2.3 版权声明2-4 §2.2.4 前言2-4 §2.2.5 阅读指南2-5 §2.2.6目录2-5 §2.2.7基础知识介绍〖条件〗2-5 §2.2.8 系统安装及启动2-6 §2.2.9 系统操作说明2-7 §2.2.9 1 CAD软件2-7 §2.2.9 2 其它软件2-9 §2.2.10 系统及数据维护2-9 §2.2.11 例题〖条件〗2-10 §2.2.12 各种附录2-10 §2.3 用户手册的风格2-11 第1章用户手册格式的规定§1.1 标题及编号一般情况下,用户手册用章、节来划分其内容,必要时还可引入小节、小小节的概念。

§1.1.1 章标题的设置每章的编号用阿拉伯数字表示,采用“第1章”、“第2章”、……的形式表示章的编号,章的编号后面空一个半角的格,然后是这一章的标题。

1. 章必须另起一页开始打印。

2. 章的编号和标题采用左对齐的格式放在行的左边,左缩进为0。

3. 章的编号和标题中汉字采用黑体小三号字,章的编号和标题总长度不能超过一行。

4. 章的编号和标题行距取最小值、12磅,段前、段后分别取24磅。

§1.1.2 节标题的设置节的编号格式为“§x.y”。其中,x为章的号码,y为节的号码,用阿拉伯数字表示。节的编号后面空一个半角的格,然后是这一节的标题。

1. 原则上每一节另起一页开始打印,但对于每章的第一节,如果章标题下无说明文字,可以将其与章标题放于一页之中。

2. 节的编号和标题采用左对齐的格式放在行的左边,左缩进为0。

3. 节的编号和标题中汉字采用黑体四号字,节的编号和标题总长度不能超过一行。

4. 节的编号和标题行距取最小值、12磅,对于与章标题处于同页的要将其段前、段后均取12磅,否则段前取24磅、段后取12磅。

§1.1.3 小节标题的设置小节的编号格式为“§x.y.z”。其中x为章的号码,y为节的号码,z 为小节号码,用阿拉伯数字表示。小节的编号后面空一个半角的格,然后是这一小节的标题。

1. 小节不必另起一页开始打印。

2. 小节的编号和标题采用左对齐的格式放在行的左边,左缩进0.74CM。

3. 小节的编号和标题中汉字采用黑体小四号字,小节的编号和标题总长度不能超过一行。

4. 小节的编号和标题行距取最小值、12磅,段前取12磅。

【注意】 1. 如果有必要,还可以在小节下面划分更小的节,我们暂且称之为小小节。

2. 对于小小节的各种规定与小节一致,为保持版面清晰,小小节不再相对于小节向右缩进。

3. 在用户手册中,系统提示信息采用幼圆五号字,其余所有的数字及字母采用Arial字体,字号与相应的汉字相同。在本规范中提到的字体如无特殊注明,均指汉字字体。

4. 用户手册中,行距均取最小值、12磅。

§1.1.4 项目符号和编号的设置在章、节、小节、小小节里面均可以含有项目符号和编号。

1. 编号1) 编号序列相对于与之对应的标题向右缩进0.74CM。

2) 编号的格式是“n.”,其中n为阿拉伯数字。

3) 对于有名编号序列名称采用五号黑体汉字,其后面的内容采用五号宋体汉字;

对于无名编号序列中的内容字体同有名编号序列。

4) 编号序列里还允许采用二级编号序列,其格式规定如下:“n)”,其中n为阿拉伯数字。

5) 二级编号相对于与之对应的一级编号向右缩进0.74CM。

6) 其它规定和一级编号序列一致。

7) 编号及二级编号的行间距取最小值,12磅。一级编号的第一项段前取12磅,其余各项及二级编号段前均取6磅。

2. 项目符号1) 项目符号相对于与之对应的标题或编号序列向右缩进0.74CM。

2) 项目符号的格式是“ ”,其中“ ”字体为Wingdings,五号字。

3) 对于有名项目符号序列,名称采用五号黑体汉字,其后面的正文采用宋体五号字,对于无名项目符号序列中的内容字体同有名编号序列。

4) 如果项目符号序列处于编号序列的下级,则各项各项段前均取6磅;

否则首项段前取12磅,其余各项段前取6磅。

【注意】项目符号和编号下的叙述文字相对于与之对应的项目符号或编号向右缩进0.74CM,首行缩进0.74CM,段前取6磅。汉字字体取宋体五号。

§1.1.5 其它编号的设置 1. 页编号:用户手册中的正文按章进行编号,其格式为“章-页”。如,第2章的第3页,编号为“2-3”。页编号放在页脚中,具体设置方法详见“页眉、页脚设置”。

2. 图、表编号:

用户手册中的图、表均按章分别进行编号,其格式分别为“图x-y”、“表x-y”。如,第2章的第3幅图的编号是“图2-3”;

第2章的第3张表格的编号是“表2-3”。在图表编号的后面空一个半角的格,然后是这一图表的名称。另外,还规定:

1) 表的编号与名称放在表的顶部。

2) 表的编号与名称和表左对齐,而整个表则居中放置。

3) 表的编号与名称段后取6磅。

4) 图的编号与名称放在图的底部。

5) 图的编号与名称和图均居中放置。

6) 图的编号与名称段前取6磅。

7) 图前面的正文段后取12磅。

8) 图、表的编号与名称中汉字采用黑体五号字。

§1.2 正文及页眉、页脚的排版§1.2.1 正文排版正文排版包括字符排版、段落排版、图形排版和版权声明、目录等的排版,本节就这几方面的格式要求加以详细阐述。

1. 字符排版:

1) 用户手册的正文,系统提示采用幼圆五号字体,其余采用宋体五号字。

2) 对于界面中的按钮名称,应把按钮名称用“〈〉”括起来,按钮名称用黑体五号字书写。对于下拉菜单选项的名称,应用“”引起来,选项名称用宋体五号字书写。对于热点,应用“”引起来,热点名称用黑体五号字书写。

3) 正文均采用常规字体、标准位置、标准间距。

2. 段落排版:

1) 正文段落的首行相对于与之对应的标题或编号序列向右缩进0.74CM。

2) 行距采用最小值,12磅,除项目符号及编号以及图形前面正文按前面所述的特殊要求进行排版外,其余段前均取12磅。

3) 采取两端对齐方式。

3. 图形的排版:

1) 屏幕截图时,应使所截图片的尺寸为最大。

2) 对于尺寸较大的图片,可使图片的高度和宽度按同比例适当缩小。

3) 必要时可适当缩小或将图片移到下一页,以保证图片与图号及图名在同页。

4) 当正文中对图标进行说明时,应使图标同与之对应的标题对齐。

5) 为保证页面清晰,可适当调整图标右侧说明文字的行间距以及段前、段后。

6) 在屏幕截图时,图片中输入的数据不能包含本公司员工的真实姓名。

4. 版权声明、目录等的排版:

版权声明、前言、阅读指南、目录的标题为段前取36磅,段后取24磅,采用黑体小三号字;

内容排版与手册正文排版相同。

§1.2.2 版面设置§1.2.2.1 版面设置对于版面设置作如下规定:

1. 纸张大小:用户手册用纸统一规定为16开。

2. 页边距:上:30mm;

下:20mm;

内侧:21mm;

外侧:16mm。另外采用“对称页边距”;

对于版面设置页眉、页脚应选用“首页不同”和“奇偶页不同”。

3. 对于新项目或新产品可根据具体情况对版面设置适当做一些修改。

§1.2.2.2 关于页眉、页脚的设置 1. 页眉的设置:

1) 版权声明、前言、阅读指南、目录均无篇眉。

2) 章编号和名称所在页的篇眉为一行有50%填充的边框。

3) 对于单号页,页眉的内容是当前章的标题名,要求打印在纸的右上角。

4) 对于双号页,页眉的内容是用户手册的名称,要求打印在纸的左上角。

5) 纸的顶边与页眉的距离是23mm。

6) 页眉中汉字采用幼圆小五号字。

2. 页脚的设置:

1) 页脚的内容是当前页的页编号,如第2章第2页为2-2。

2) 页编号的字体采用Arial五号字。

3) 纸的底边与页脚的距离是13mm。

4) 版权声明、前言、阅读指南、目录的页脚为ⅰ,ⅱ等,居中放置,不带边框。

§1.2.2.3 注意与警告在用户手册中,对于那些需要用户特别注意的事项,应该用“【注意】”作为标志给用户以特别的提示。关于注意标志和注意事项的格式有如下规定:

1. 注意标志同与之对应的标题对齐。

2. 注意标志采用黑体小四号汉字。

3. 注意标志段前取12磅。

4. 如果注意事项只有一条,其内容应该紧跟在注意标志的后面书写;

否则,应该在注意标志的下一行开始,采用编号序列的形式分别给出。

在用户手册中,对于那些会给用户造成重大损失的行为,应该用“【警告】”作为标志给用户以警告性的提示。

【注意】关于警告标志和警告事项的格式规定与关于注意标志和注意事项的格式规定一致。

第2章用户手册的内容本章主要讨论编写用户手册所要达到的目标、软件用户手册所应包含的内容、以及在用户手册编写过程中所应保持的风格。

如果标有“〖条件〗”字样,说明该部分内容是在一定条件下所必须的。

§2.1 用户手册的目标某软件评测中心把软件产品评测测试分为两个阶段——初评安装测试和复评测试。只有通过初评安装测试的软件才能进入复评测试,初评安装测试的内容包括:

1. 按照软件用户手册中的安装说明测试软件能否顺利安装成功。

2. 对照软件用户手册测试软件功能是否与手册描述一致。

3. 评价产品包装及用户手册是否符合商品化要求。

4. 通过以上三方面测试且无严重死机情况的软件可进入复评测试。

由此,我们可以看到软件用户手册是一个软件产品的基础,没有合格的软件用户手册就根本谈不上合格的软件产品。另一方面,良好的安装说明及软件功能与手册描述的一致性是对软件用户手册的两个基本要求。

我们编写的用户手册要达到两个目的:

1. 让用户手册成为用户学习使用我们产品的最好教材。用户通过阅读用户手册,应该对我们产品的功能、操作有一定的认识;

按照用户手册上的说明,通过实际操作,用户应该能够掌握我们产品的操作过程。

2. 让用户手册能够起到降低销售费用的作用。用户手册不仅应该包括我们的产品操作说明,而且还应该包括系统(软件和必要的硬件)安装、数据维护、出错处理等。通过用户手册,就可以让用户掌握在使用我们软件的过程中出现各种情况的处理方法。

为达到这两个目标,在一般情况下,用户手册应该包含如下几个方面的内容:

1. 封面

2. 二封

3. 版权

4. 声明

5. 前言

6. 阅读指南

7. 目录

8. 基础知识介绍〖条件〗

9. 系统安装(包括必要的硬件安装)及启动10. 系统操作说明11. 系统及数据维护12. 例题〖条件〗13. 各种附录【注意】如果本系统软件是一个大系统,其系统安装、操作说明、系统及数据维护都相当复杂,则可以把这三个部分分别编写为一本甚至几本用户手册,每本手册都有自己的封面、版权声明、前言、阅读指南、目录以及相应的基础知识介绍和附录。

§2.2 用户手册的内容§2.2.1 封面封面内容应包括公司的ICON、软件名称及版本号、公司名称及手册印刷时间。

§2.2.2 二封二封正面为软件名称及版本号、公司名称、手册印刷时间、公司地址及服务电话等。以EDD4.0手册为例,其形式如下:

EDD/AutoCAD R14 V4.0用户手册沈阳东大阿尔派软件股份有限公司地址:沈阳市和平区三好街84-2号电话:(024)23841748 (024)23783000 传真:(024)23890817 (024)23782266 客户服务热线:800-890-8000 Email:Service@neu-alpine §2.2.3 版权声明版权声明是保护我们所开发软件的产权、不使我们公司利益受到损害的一种方式。在版权声明中应该包括以下内容:

1. 对我们所提供的软件及用户手册的保护声明。

2. 对我们的软件及商标所有权的声明。

3. 对我们的用户手册中所提到的各种商标的版权声明〖条件〗。

4. 我们不对用户因为使用我们的软件所造成的损失负责的声明。

具体请参考本规范的版权声明。

§2.2.4 前言对于前言所应包含的内容经常根据用户手册编写人员的习惯不同而不同,有时仅仅包含了系统的开发背景和目的,有时还包含了系统简介,有时甚至还包含了用户手册的阅读指南。

为了统一起见,在这里我们规定前言主要包括以下内容:

1. 系统的开发背景和目的。

2. 系统所能应用的领域和使用对象。

3. 系统的功能及特性简介。

4. 如果本手册不是该系统的第一个版本,还应该简介较上一版本的改进部分。

§2.2.5 阅读指南阅读指南是每本(套)用户手册必不可少的组成部分,用户通过它可以了解到用户手册的基本内容;

了解到应该如何、从哪儿开始阅读该用户手册。用户手册的阅读指南应该包含如下几部分:

1. 手册目标:通过阅读该用户手册,用户应该或能够达到什么目标。

2. 阅读对象:指明什么人员应该阅读该手册,或什么人员应该阅读本手册的哪些部分;

阅读对象在阅读本手册之前应该掌握哪些知识,必要时应给出资料清单,以便用户查阅。3. 手册构成:如果本系统的用户手册(包括管理员手册、参考手册)由几本组成,首先应该分别简要介绍这些手册的情况。最根本的是应该介绍本手册在哪一章或哪几章讲解了什么内容,对于较大系统,如Universal Office 3.5,分别介绍每一章内容比较繁琐,则可概括性地介绍。

4. 手册约定:这一部分应该包括字体的约定、特殊符号的约定以及【注意】、【警告】、【说明】等的含义。必要时,应该给出某些基本术语的定义。也可以把基本术语、概念的定义作为基础知识来介绍。

具体请参考本规范的阅读指南。

§2.2.6 目录目录的编写要尽量详尽。如果用户手册的内容用到小节,则目录就应该编写到小节;

如果用户手册的内容用到小小节,则目录就应该编写到小小节。编写用户手册目录的目的就是为了让用户能够根据它很快地找到想要的内容。

有关格式请参考本规范目录的编写。

§2.2.7 基础知识介绍〖条件〗这一部分内容是在一定条件下必需的,用户手册编写人员应该根据实际情况确定是否需要这一部分。如果包括基础知识介绍,应将其放在第1章。在一般情况下,使用我们的软件系统需要一定的基础知识。这些知识可以从有关书籍上得到,但是用户从这些资料得到这些知识需要花费相当的时间。在某些情况下,我们只需要用户掌握用户手册中使用的那些概念,那么我们就有必要编写一章“基础知识介绍”来进行专门介绍。

比如说,在工厂管道设计系统用户手册中,经常用到按下鼠标“数据键”、“捕捉键”、“复位键”的概念,用户虽然可以从《Microstation的用户手册》中得到这些概念,但是比较不方便。由于我们编写用户手册的主要目标就是方便用户,所以有必要在用户手册的一开始就介绍这些概念。

§2.2.8 系统安装及启动如果手册中包括基础知识介绍,应把系统安装及启动作为第2章,否则,将其作为第1章首先向读者予以介绍。

系统安装及启动部分应该包括如下内容:

1. 系统的运行环境? 硬件环境要求说明:系统运行时所需硬件环境描述。包括机型、内存大小、硬盘空间等。如果必要,还应包括输入/输出设备、通讯环境等。

? 软件环境要求说明:系统运行时所需软件支持环境的描述。包括所需任何其它软件的名称及版本号等。

? 其它环境要求说明〖条件〗:应该说明要求的任何其它环境。

2. 系统的安装对于不同的系统其安装应有所区别,一般来说,应给出最终用户能够据此把软件安装到其操作系统并配置完成,且能成功运行的任何信息和操作。系统的安装包括软件的安装过程及系统环境的配置〖条件〗,必要时还应给出硬件的安装〖条件〗。

? 硬件安装〖条件〗:如果必要,应该详细说明系统所需硬件环境的安装过程,其中包括软件加密锁的安装。

? 软件安装:

应该用图示方法详细介绍软件的安装过程。对于网络版软件,应对服务器端及客户端的安装分别予以介绍(可参考文档管理系统SEAS2000-AMS 5.0)。如果二者安装过程相似,可以详细介绍一种,另一种参考前一种即可。如果软件由多个模块构成,且其中部分模块需单独安装,如Universal Office 3.5,则应分别给出安装步骤。

所有产品的安装包括以下界面:安装快闪界面〖条件〗、安装初始窗口(欢迎)、版权声明界面、选择安装路径界面、选择程序文件夹(程序组)界面〖条件〗、安装进程界面〖条件〗及安装完成界面。

? 系统配置〖条件〗:应给出系统配置的详细过程,以便用户能够顺利操作系统。对于网络版软件,应分别讲述服务器和客户端的配置过程。

3. 系统的启动:应给出系统启动的方法。如果系统由多个模块组成,则不必单列出一节讲述系统的启动方法,只须在介绍各个模块的操作时给出模块的启动方法即可。

对于系统的安装及启动的结构总结如下,供编写用户手册时参考:

|------系统的运行环境|----硬件环境| |----软件环境| 系统的安装及启动| |----硬件安装|------系统的安装|----软件安装| |----系统的配置| |------系统的启动§2.2.9 系统操作说明系统操作说明是所有用户手册的主体,它所包含的内容相当广泛。主要包括:输入的命令和数据、软件的功能、输出结果、出错信息及其矫正和恢复方法。

对于不同的软件,其操作说明也应有所不同,下面就几种情况分别予以介绍。

§2.2.9.1 CAD软件CAD软件的操作说明应包括文件管理、图纸尺寸设置、图形绘制、图形编辑、尺寸标注、图层管理、图库调用〖条件〗、图库维护〖条件〗及附录〖条件〗等内容。

在用户手册中应按操作顺序或界面中菜单顺序分别对上述内容中的每一项操作予以介绍。要求详细给出操作过程及命令格式与功能,具体规定如下:

1. 各种操作、命令和语言:软件系统的使用过程都是使用软件系统提供的各种操作、命令和语言的过程。所以,我们必须做到:

1) 操作和命令:在用户手册中详细给出各种操作的过程和功能、命令的格式和功能;

应当描述在使用上的各种限制,如,操作状态、操作条件、操作序列等。另外,必要时可以通过适当地举例讲述各种操作和命令的使用方法,以帮助用户理解。

2) 输出信息:应该详细列出与操作、命令相关的各种输出信息。如果输出信息的意思本身不是很明显,应当给予解释。另外还应当说明对于这些信息所采取的操作。

3) 程序设计语言〖条件〗:如果我们的软件系统提供了某种语言,对其语言规则应当给予说明。

2. 各种数据:在软件的使用过程中,用户必须与各种数据和信息打交道。为了让用户能够操作我们的软件,我们必须为用户提供各种结构以及每个数据元素的含义有些数据适合在系统操作说明中给出,有些适合在后面的附录中给出,甚至有些除了在操作说明的同时给出外,还要在附录中给予归纳,这些都由用户手册编写人员根据实际情况来决定。这些数据包括:

1) 输入数据〖条件〗:应该给出数据的内容、逻辑结构、格式以及每一个数据元素的意思。如果输入数据依赖于某特定数据介质,则应当给予说明。

2) 输出数据:应当给出软件以何种形式输出的数据的内容和格式,并要求以例样的形式给予说明。

3) 中间数据〖条件〗:如果我们告诉用户在软件的运行过程中所产生的中间数据的内容和格式,有助于用户理解软件的使用,则应当给予说明4) 数据限制〖条件〗:如果对数据有限制,如数据的大小限制,则应当给予说明。

5) 数据文件〖条件〗:如果要告诉用户我们的软件所使用的某些数据文件的结构有助于用户理解我们软件的使用,则应给予说明,但应该注意技术保密。如果对数据文件有所限制,例如每个文件的最大记录数、每个磁盘的最大文件数等,应当给予说明。

3. 处理过程〖条件〗:如果我们简要地给用户描述我们软件对用户的操作、输入的命令和

输入数据的处理过程,有助于用户了解我们软件的使用,则应给予说明。

4. 截图内容:目前,多数软件已不再采用命令行输入方式,而是采用对话框输入方式。在此情况下,应该以图示方式对软件的操作过程予以介绍。采用图示方式讲述软件操作过程应注意以下几点:

? 所截图形的输入、输出信息中不应包含本公司人员的真实姓名,且各种输入、输出信息以不泄漏公司机密为原则。

? 截图是为使叙述更加明确、简洁,所以应尽量避免不必要的截图。一般来说,在用户手册中应该包括系统的主界面、各种操作的初始界面(点取命令后弹出的第一个界面,一般需要输入信息)、操作中间过程界面、操作结果界面以及其它一些必要的界面。没有必要为下拉菜单、快捷菜单等内容截图,因为这些操作都比较简单,只要用语言叙述用户即可明确其操作方法。另外,在同一本手册中,应避免重复截图,对于不同输入或输出信息的同一界面在手册中不应重复(例题除外)。

5. 出错处理:应当给出各种出错情况以及相应的处理措施。

6. 现对系统操作说明的步骤总结如下,供编写用户手册时参考:

1) 进入相关界面。

2) 调用命令(选择菜单、键入命令或点击工具按钮)。

3) 弹出相应的操作初始界面(或提示行)。

4) 对输入信息给予说明。

5) 继续操作(点击按钮或选择参数及键入按键等)。

6) 结果界面(或结果提示行)。

7) 对输出信息给予说明。

【警告】在编写软件用户手册的系统操作说明时,我们在决定是否提供某种数据的格式时,应以不泄漏公司的技术而且有利于用户使用为准则。

§2.2.9.2 其它软件对于一些比较复杂的软件,一般包括多个模块。对于此类系统,要求按照操作顺序对各个模块分别介绍。一般按模块分成若干章,在各章中对相关模块的操作予以介绍。对于此类软件的操作步骤总结如下:

1. 启动某一模块,进入该模块的主界面。

2. 执行某一功能(选择菜单或工具按钮)。

3. 弹出相关界面。

4. 对输入信息予以说明。

5. 继续操作(点击按钮)。

6. 结果界面。

7. 对输出信息予以说明。

有些软件的操作可能需要一定的技术和经验才能获得满意的结果,那么应该在用户手册上尽量给出这些技术和经验的描述,或告诉用户如何才能获得这些技术和经验。例如,在操作SEAS系统作图纸净化处理时,如何选择适当的阀值就需要一定的技术和经验。

一些比较简单的系统,如NetEye、OpenVideo等其系统操作比较简单,操作说明内容比较少。对于此类软件,手册中可以将操作说明归纳为一章,再按操作顺序予以介绍。

另外,对于各种操作、命令、语言、数据及截图内容的规定同CAD软件。

§2.2.10 系统及数据维护应该给出用户数据的备份、恢复、删除、整理的详细过程。如果必要,应该给出系统数据、系统磁盘空间维护的详细过程。

§2.2.11 例题〖条件〗有些软件系统可以通过一个较为完整的例题演示系统部分功能的使用方法,在这个例题中,用户应该详细地描述每一步的操作过程,用户可以通过这个例题对系统的操作有一个初步的了解。

§2.2.12 各种附录在用户手册中,有些知识和信息可以通过附录的形式提供给用户,以便于用户查阅,这些内容是:

1. 错误提示信息:通常可以以表的形式按照一定的顺序,例如按出错提示信息编号顺序、或按出错提示信息的字母顺序,给出出错提示信息的编号、提示信息、相应的解释、出错原因和解决办法

2. 命令速查表〖条件〗:通常可以以表的形式按照一定的顺序给出各种命令的概要(包括命令名称、各种参数、及相应的功能介绍),以帮助有一定经验的用户进行快速查找所需信息

3. 数据文件格式〖条件〗:可以通过附录介绍用户必须了解或可以了解的各种输入数据文件、输出结果文件、中间数据文件的格式、限制范围、适当的解释等

4. 其它信息〖条件〗:任何其它有利于用户使用我们的软件、方便用户的信息都可以以附录的形式提供给用户【注意】虽然附录所提供的信息可能均可以在系统操作说明中查到,但提供附录的目的就是为了方便用户使用,这种重复还是必要的。

§2.3 用户手册的风格用户手册应具有自己的风格。有的人喜欢用比较深奥的概念和语言来说明问题,有的人喜欢用比较长的句子来表达思想,在编制用户手册的过程中这些都是不可取的。用户手册应该具备如下特点:

1. 用户手册的句子尽量简洁:如果用一个句子表达起来比较复杂,定语多,则可以分成两个甚至几个句子来说明,这样用户在阅读用户手册时会轻松些。

2. 每节、段的内容明确:每节的内容必须明确,这样用户可以通过目录很方便地查到自己所需要的内容;

注意段的划分,每段不要太长,突出重点,否则用户不容易获得其中的精华。

3. 用户手册的用词要前后一致:在用户手册中使用的概念、术语的用词要前后一致,否则用户将不容易读懂此手册。

4. 用户不一定是计算机专家:用户手册编写人员应该牢牢记住这一点,我们的大多数用户都不是学计算机的,手册中应该尽量不使用较深奥的计算机术语。如果不可避免,我们应该给予适当的解释和说明。另外,不要以为我们的用户什么都懂,所以在编写用户手册的时候,应该详细地描述操作过程中的每一步。

5. 用户手册各部分风格应该统一:一些较大的系统可能由多人开发和测试,如Universal Office 3.5,从而造成用户手册各部分风格各异,这就要求用户手册编排人员最终将各部分统一成风格相同的一本手册。

6.

感谢您的阅读!

软件开发软件需求说明书编写规范

1 具体需求 功能需求 功能需求1 对于每一类功能或者有时对于每一个功能,需要具体描述其输入、加工和输出的需求。由四个部分组成: a.引言 描述的是功能要达到的目标、所彩的方法和技术,还应清楚说明功能意图的由来 和背景。 b.输入 1)详细描述该功能的所有输入数据,如:输入源、数量、度量单位、时间设定、 有效输入范围(包括精度和公差); 2)操作员控制细节的需求。其中有名字、操作员活动的描述、控制台或操作员的 位置。例如:当打印检查时,要求操作员进行格式调整; 3)指明引用接口说明或接口控制文件的参考资料。 c.加工 定义输入数据、中间参数,以获得预期输出结果的全部操作。它包括如下的说明: 1)输入数据的有效性检查; 2)操作的顺序,包括事件的时间设定; 3)响应,例如,溢出、通信故障、错误处理等; 4)受操作影响的参数; 5)降级运行的要求; 6)用于把系统输入变换成相应输出的任何方法(方程式、数学算法、逻辑操作等); 7)输出数据的有效性检查。 d.输出 1)详细描述该功能所有输出数据,例如:输出目的地、数量、度量单位、时间关

系、有效输出的范围(包括精度和公差)、非法值的处理、出错信息; 2)有关接口说明或接口控制文件的参考资料。 此外,对着重于输入输出行为的系统来说,需求说明应指定所有有意义的输入、 输出对及其序列。当一个系统要求记忆它的状态时,需要这个序列,使得它可以 根据本次输入和以前的状态作出响应。也就是说,这种情况犹如有限状态机。 功能需求2 ...... 功能需求n 外部接口需求 用户接口 提供用户使用软件产品时的接口需求。例如,如果系统的用户通过显示终端进行操作,就必须指定如下要求: a.对屏幕格式的要求; b.报表或菜单的页面打印格式和内容; c.输入输出的相对时间; d.程序功能键的可用性。 硬件接口 要指出软件产品和系统硬部件之间每一个接口的逻辑特点。还可能包括如下事宜:支撑什么样的设备,如何支撑这些设备,有何约定。

用户操作手册编写规范

编号: 版本号: 发放号: 文件名称:用户操作手册编写规范

变更记录 注:对该文件内容增加、删除或修改均需填写此变更记录,详细记载变更信息,以保证其可追溯性。

用户操作手册编写规范 用户操作手册旨在告诉软件的使用者在使用本软件时所应采用的方法与程序,并提供有关的信息,如系统结构、软件功能、操作流程等,以协助软件的使用。 用户操作手册的重点章节是‘第四章功能概述与操作说明’。操作说明必须尽量地详尽,以便使用者易于掌握。

目录 用户操作手册编写规范模板 (1) 第一章简介 (4) 1、手册目的 (4) 2、手册范围 (4) 3、名词定义 (4) 4、参考文件 (4) 第二章系统概述 (6) 1、系统目标 (6) 2、系统范围 (6) 3、系统结构 (6) 4、软件环境 (6) 第三章公共操作 (7) 1、开机/关机 (7) 2、注册 (7) 3、主菜单操作 (7) 4、退出 (8) 5、屏幕画面的布局 (8) 6、公共画面属性 (8) 7、提示窗 (8) 8、按钮定义 (8) 9、键盘定义 (8) 第四章功能概述与操作说明 (9) 1、功能概述 (9) 2、操作规程 (9) 3、操作说明 (9)

第一章简介 本章将简要地说明用户操作手册(以下简称本手册)的目的、范围、名词定义和参考文件。 1、手册目的 本手册的目的在于告诉某某系统软件的使用者,本系统软件提供了哪些功能,以及如何正确地、有效地来使用这些功能。 2、手册范围 ?本手册首先简要地介绍本系统软件的结构以及软件环境,然后说明本系统软件为使用者提供的各项功能及其详细的操作步骤。 ?本手册的使用者包括: {在此罗列使用者……} ?本手册各章节内容安排如下: ?第一章简介:简单说明本手册的目的、范围、名词定义和参考文件。 ?第二章系统概述:简单说明本系统的结构及其执行环境。 ?第三章公共操作:介绍开机、系统注册与退出、关机等公共操作,并指明为系统中各项操作所共有的屏幕属性、按钮定义及键盘定义。 ?第四章功能概述与操作说明:逐一说明各项功能及其详细的操作步骤。 其中“第四章功能概述与操作说明”为本手册之重点, 希望使用者能深入了解。 3、名词定义 这里定义为了准确地解释本手册所需要的字头词和缩写词。这些信息也可以由手册的附录提供,或引用别的文档。 4、参考文件 ?参考文件清单。

用户手册编写规范

<项目名称> 用户手册 作者: 完成日期: 签收人: 签收日期: 修改情况记录:

目录 1 引言 (1) 1.1 编写目的 (1) 1.2 背景 (1) 1.3 定义 (1) 1.4 参考资料 (1) 2 用途 (1) 2.1 功能 (1) 2.2 性能 (2) 2.2.1 精度 (2) 2.2.2 时间特性 (2) 2.2.3 灵活性 (2) 2.3 安全保密 (2) 3 运行环境 (2) 3.1 硬设备 (2) 3.2 支持软件 (3) 3.3 数据结构 (3) 4 使用过程 (3) 4.1 安装与初始化 (3) 4.2 输入 (3) 4.2.1 输入数据的现实背景 (3) 4.2.2 输入格式 (4) 4.2.3 输入举例 (4) 4.3 输出 (5) 4.3.1 输出数据的现实背景 (5) 4.3.2 输出格式 (5) 4.2.3 输出举例 (5) 4.4 文卷查询 (5) 4.5 出错处理和恢复 (6) 4.6 终端操作 (6)

1 引言 1.1 编写目的 说明编写这份用户手册的目的,指出预期的读者范围。 1.2 背景 说明: a.这份用户手册所描述的软件系统的名称; b.列出本项目的任务提出者、开发者、用户(或首批用户)以及安装该软件的单位。 1.3 定义 列出本文件中用到的专门术语的定义和缩写词的原词组。 1.4 参考资料 列出要用到的参考资料,如: a.本项目的经核准的计划任务书或合同、上级机关的批文; b.属于本项目的其他已发表的文件; c.本文件中各处引用的文件、资料,包括所要用到的软件开发标准。 列出这些文件的标题、文件编号、发表日期和出版单位,说明能够得到这些文件资料的来源。 2 用途 2.1 功能 结合本软件的开发目的逐项地说明本软件所具有各项功能以及它们的极限范围。

员工的日常行为规范(1)

员工的日常行为规范 1 进入公司必须着装整洁。 2 进入公司自觉讲普通话,禁止喧哗、说笑、打闹,说粗话、脏话。 3 爱护公司的各项设施,随时保持办公室干净、整洁,营造一个良好的工作环境。 4 上班时间要坚守工作岗位,无事不得串岗。 5 上班时间不能玩电脑游戏、打瞌睡、或做与工作无关的事情。 6 办公室应保持整洁,并注意办公室安静。 7 不得在上班时间利用电脑发个人邮件或上网聊天。 8 不得迟到和早退,否则本月全勤奖取消。 9 职员在每天的工作时间前和工作时间结束后做好个人工作区内的卫生保洁、保持物品整齐。 10 不得利用办公室会客、聚会,更不允许吸烟(请到规定范围内吸烟) 11 在月末统计考勤时,办公室对任何空白考勤不予补签。 12 所有员工要勤俭节约,杜绝浪费,努力降低消耗办公用品。 13 工作必须热情、礼貌、认真。 14 在接待公司内外人员时,微笑应答,切不可冒犯对方,热情接待。 15 请假须提前一天请总经理批准、备案,如不及时,扣减当天工资,取消当月全勤奖。 16 不准私自动用办公物品,如需要应向办公室登记并做好领取记录。 17 员工工作时间为早上9:00至下午18:00,午餐时间为中午12:00-14:00,因季节变化需调整工作时间时由总经理办公室另行通知。. 18 遵守电话的使用规范,工作时间应避免私人电话。如确时需要,应以重要事项陈述为主,禁止利用办公电话闲聊。 19 公共卫生间内,请节约用水,自觉注意卫生。 20、员工在办公期间或开会时,手机调为振动或静音,避免影响他人工作。如要接电话请到规定地点接听电话。 员工必须维护公司纪律,对任何违反公司章程和各项规章制度的行为都要予以追究。 第一章员工守则 第一条员工守则: 1.忠于职守,尊重领导、服从工作安排,不得有阳奉阴违或敷衍搪塞的行为。 2.爱护集体、关心集体,讲求职业道德。上班时间不得做与工作无关的事及处理私人事务。 3.廉洁奉公、严于律己,不得假借职权贪污舞弊或以公司名义在外招摇撞骗、索贿受贿等。 4.不得携带违禁品、危险品或无关的物品及人员进入办公场所,注意防火、防毒、防盗。 5.经手公司财产(包括货款)必须按规定上交公司,不得私留挪用,经手的财务单据凭证须真实、准确,不得伪造、篡改。 6.严格保守公司商业秘密,不得将公司有关财务经营状况、技术资料、经营销售、客户资料、公司机构等,在未经批准的情况下向外传播、提供或交给无关人员,违者公司有权追究法律责任。 7.严格执行个人薪资保密工作,员工之间不得相互打听询问,对工资计算或发放如有异议,可直接向财务查询。 8.不得超越职权向客户做业务上和利益上的承诺,包括奖励、补贴、损耗等。 9.服务要细心、周到,对客户的合理要求要尽力满足,对不能满足的要作出解释;耐心

生产统计报表的编制

生产统计报表的编制 统计员的工作汇报就是及时、准确、完善的向相关部门呈递《生产统计报表》。尽量让我们高层管理人员对所管辖的下属部门的工作情况了如指掌,及时地发现问题作出决策,并使管理工作得以顺利进行。通过我们详细的汇报中了解生产计划的执行情况,了解生产进度、材料供应、计划执行状况,机器设备的运转状况等,可以及时掌握生产动态和异常情况,可以了解人员的思想变化等。可以及时发现工作中存在的困难和问题,生产中不可避免会出现这样或那样的问题,通过定期或不定期的工作汇报,可以及时了解这些困难或问题,并及时加以研究和解决,并把可能造成的各种损失降低到最小的程度。统计一般是交叉统计为最佳,例如生产的数据,由仓库监督统计;报表上的统计,审核必须是对口的人员。即生产上的数据是由仓库进行监督统计的,就是反应了交叉统计。 没有统计软件的情况下,最简单的理解就是输入与输出平行,例如总输入的用料单与总产成的进仓单,进仓不单是产品的数量进仓,还要重量进仓(因为重量是要和你的输入材料做对比的),还有废品进仓(也是数量与重量登记)。有入必有出。 统计的人员首先要明白数据怎么来的,要学会利用数据,而不是为数据打工。 二、工作汇报的内容,工作汇报的内容很多 ,现只就生产、质量、物料方面的内容做一个简单的介绍。 1、生产方面的汇报 (1)各类生产计划的完成情况 (2)各项工作的落实与执行情况 (3)生产进度状况与工时投入,生产跟踪情况。 (4)现场作业状况 (5)各类生产异动情况:包括进度异动、工艺异动、其它异动。 (6)生产人员工作情况 (7)各订单完成情况 (8)产品交货状况 2、质量方面的汇报 (1)各道工序、各车间(班组)的产品质量情况 (2)质量问题及质量异动 (3)各种产品的不合格率机造成因素 (4)内部质量事故的调查处理及质量问题的追溯 (5)质量问题的处理汇报 (6)质量目标达成情况 (7潜在的质量隐患 3、物料方面的汇报 (1)物料供应计划的完成情况

行为规范教育月总结

行为规范教育月总结开学以来,根据教育局和学校工作安排,德育处组织开展了行为规范教育月的同时继续开展五个教育。在两个月的时间里,各年级按照学校德育处总体安排,有计划分阶段扎实开展了系列教育活动,收到了良好效果,涌现出一批优秀的人和事。通过活动规范了同学们的行为,让同学们切实从思想、语言、行为上得到规范和提高。本次教育月活动,始终得到了学校领导的高度重视,得到了全体师生的积极参与,收到了良好效果,主要表现在一、积极营造开展行为规范教育月活动氛围教育月开展以来,我们注重营造良好的教育氛围,德育处组织召开了班主任会议,启动静海五中行为规范教育月和五个教育,全校师生明确了开展行为规范月活动的重要意义,并通过国旗下讲话、主题班会、班级黑板报等宣传阵地,加大宣传力度,营造良好的舆论氛围。组织学生认真学习背诵《守则》《规范》、五尊、五不、五远离和静海五中学生德育管理手册,营造了校风正、校纪严、讲文明、讲礼貌、讲卫生的良好氛围。规范了学生座右铭,五个教育学生格言和五个教育活动台账,利用学校电子大屏幕,播放文明用语,温馨提示,强化对行为教育月和五个教育的宣传,使校园洋溢文明气息,让学生在良好的环境中陶冶情操。二、细化过程,把行为规范教育月活动和五个教育落到实处一是组织全体学生重新学习了守则、规范,做到人人会背,人人会讲,并能按照守则、规范严格要求自己。二是纠正学生迟到问题,建立学生到校报告制度,由班长填写学生到校情况统计表,班主任签字,每天放学前上交德育处。三是纠

正了学生课上不遵守课堂常规,乱说、乱讲、随意性强的不良表现,形成了规范有序的课堂秩序。四是通过开展教育月,加强学生不文明现象的治理,强化学生的文明礼仪,杜绝说脏话,讲假话的现象,创造校园文明氛围。真正让学生在楼道静下来,让学生在教室坐下来,让学生真正学起来。五是组织学生仪容仪表检查,学生中午早到校检查和班风班貌评比等活动,共纠正违规违纪行为人52次。六是开展了学生守则规范考试,将各班学生成绩纳入考核。七是为深化五个教育组织学生开展了为家人做一件有意义的事,让学生感受感恩教育和责任教育的内涵。三、活动开展有实效在教育月中,我们积极组织教育活动,正面引领,正面教育。一是各年级分别以争做优秀中学生为主题,召开了行为规范教育月主题班会。二是为推动教育月的开展,召开三位年级组长和各年级部分学生座谈会,根据反馈,有针对性地搞好推动工作,三是组织学生开展了行为规范回头看活动,不少同学写出了行为教育月以来自身的变化,四是围绕五个教育设计了学生《修身本》,《值周班长记录册》,每天利用第八节课放学前的五分钟,总结一天来班级管理中的优缺点,有力地促进了晚总结的进行,我们在早宣誓前要求各班唱班歌,其目的是促进积极、团结、向上的良好班风的形成。五是为了保证各项工作落到实处,学校延长了教育月活动时间的同时,建立了课间教学楼的巡查制度,班级学生违规违纪通报机制,班主任工作失误报告制度,校园行为抓拍制度,所有检查结果,班主任例会上进行了检查情况得通报。四、存在的问题。在

操作手册编写规范

<项目名称〉 操作手册 作者: ____________________________________________ 完成日期: _________________________________________ 签收人: ___________________________________________ 签收日期: _________________________________________

目录 引言 ................................................................... 错误!未定义书签。 编写目的 .............................................................. 错误!未定义书签。 背景 .................................................................. 错课!未定义书签。 定义 .................................................................. 错误!未定义书签。 参考资料 .............................................................. 错误!未定义书签。 软件概述 ................................................. 错误!未定义书签。 软件的结构 ............................................................ 错误!未定义书签。 程序衣 ................................................................ 错课!未定义书签。 文卷衣 ................................................................ 错误!未定义书签。 错误!未定义书签。 运行说明 ......... 运行表 ............... 运行步骤 ............. 运行1 (标识符)说明 运行控制 操作信息 .......... 输入一输出文卷..... 输出文段 错误!未定义书签。错误!未定义书签, ...错课!未定义书签 ???错误!未定义书签 ???错误!未定义书签 ???错误!未定义书签 ???错误!未定义书签 ???错课!未定义 书签 ???错误!未输出文段的复制 .................................................. 错误!未定义书签。 恢复过程 ......................................................... 错误!未定义书签。 运行?2 (标识符)说明 错误!未定义书签。 非常规过程. ............................................ 错误!未定义书签。 安装与初始化 远程操作

生产统计报表编制规范(含表格)

生产统计报表编制规范 统计员的工作汇报就是及时、准确、完善的向相关部门呈递《生产统计报表》。尽量让我们高层管理人员对所管辖的下属部门的工作情况了如指掌,及时地发现问题作出决策,并使管理工作得以顺利进行。通过我们详细的汇报中了解生产计划的执行情况,了解生产进度、材料供应、计划执行状况,机器设备的运转状况等,可以及时掌握生产动态和异常情况,可以了解人员的思想变化等。可以及时发现工作中存在的困难和问题,生产中不可避免会出现这样或那样的问题,通过定期或不定期的工作汇报,可以及时了解这些困难或问题,并及时加以研究和解决,并把可能造成的各种损失降低到最小的程度。统计一般是交叉统计为最佳,例如生产的数据,由仓库监督统计;报表上的统计,审核必须是对口的人员。即生产上的数据是由仓库进行监督统计的,就是反应了交叉统计。 没有统计软件的情况下,最简单的理解就是输入与输出平行,例如总输入的用料单与总产成的进仓单,进仓不单是产品的数量进仓,还要重量进仓(因为重量是要和你的输入材料做对比的),还有废品进仓(也是数量与重量登记)。有入必有出。 统计的人员首先要明白数据怎么来的,要学会利用数据,而不是为数据打工。 一、工作汇报的内容,工作汇报的内容很多,现只就生产、质量、物料方面的内容做一个简单的介绍。 1、生产方面的汇报

(1)各类生产计划的完成情况 (2)各项工作的落实与执行情况 (3)生产进度状况与工时投入,生产跟踪情况。 (4)现场作业状况 (5)各类生产异动情况:包括进度异动、工艺异动、其它异动。(6)生产人员工作情况 (7)各订单完成情况 (8)产品交货状况 2、质量方面的汇报 (1)各道工序、各车间(班组)的产品质量情况 (2)质量问题及质量异动 (3)各种产品的不合格率机造成因素 (4)内部质量事故的调查处理及质量问题的追溯 (5)质量问题的处理汇报 (6)质量目标达成情况 (7)潜在的质量隐患 3、物料方面的汇报

用户手册编写规范

用户手册编写规范 密级:机密用户手册编制规范 V 1.01999 年10 月20 日浪潮集团山东通用软件有限公司浪潮通软公司用户手册编写规范1 目录文档类别使用对象 .21.引言 .31.1 目的31.2 范围31.3 术语定义31.4 参考资料31.5 版序控制记录31.6 版本更新记录4 2.编制大纲 .52.1 编写要求52.2 文档分类62.3 用户使用手册编制大纲62. 3.1 前 言 .72.3.2 功能 .72.3.3 附录 .82.4 用户安装手册编制大纲82.4.1 前言 .92.4.2 单机版的安装及配制 .92.4.3 网络版的安装及配制 .92.4.3 附录 .102.5 系统管理员手册编制大纲103.编写原则 .114.审核鉴定 .11 浪潮通软公司用户手册编写规范2 文档类别使用对象文档类别该文档是为浪潮通用软件公司的产品提供一个用户手册编写规范。 使用对象该文档使用对象为浪潮通用软件公司参与文档编制工作的人员,包括设计人员.编程人员.文档编制人员以及其他参与文档工作的成员。 浪潮通软公司用户手册编写规范31.引言1.1 目的本文档是为公司产品的文档编写提供规范说明,其目的是:1.为用户提供各种类型的文档,以供用户参阅和培训之用。 2.提供相应的配套资料,辅助软件推向市场。

1.2 范围本文档提供公司产品用户手册的编制类型.编制大纲.编制风格.编制顺序以及用于编制人员最后进行的审核。 1.3 术语定义1.4 参考资料国强财务软件6.0 产品用户手册编写指南 V 1.31.5 版序控制记录版序状态拟稿审核批准发布日期1.0 管理过程改善部浪潮通软公司用户手册编写规范41.6 版本更新记录 *A 修改 Dmail 地址;2)目录用 WORD97 自动生成,采用正式格式,显示三级标题,页码右对齐,字体用小四号宋体;目录起始页第一行正中为“目录”二字,字体为四号加黑宋体。 3)正文的章.节格式用 MS WORD*的标题格式,段内的字体应保持字体统一,用小四号宋体。但特殊强调的需引起读者注意的条目,可用其它字体。 4)正文的页眉用五号宋体,格式如下:章节名称正文页码设置:位置为页面底端(页脚),对齐方式为外侧。 浪潮通软公司用户手册编写规范62.2 文档分类名称说明用户使用手册1.目的:用户认真阅读本手册,可以快速.方便的使用本系统的功能。 2.作用:培训和参考的作用。 3.使用对象:使用本产品的用户以及培训本产品的市场.服 务人员。 安装手册1.目的:用户能正确地安装软件。

软件开发技术文档编写规范

软件开发技术文档编写规范 在项目开发过程中,应该按要求编写好十三种文档,文档编制要求具有针对性、精确性、清晰性、完整性、灵活性、可追溯性。 ◇可行性分析报告:说明该软件开发项目的实现在技术上、经济上和社会因素上的可行性,评述为了合理地达到开发目标可供选择的各种可能实施方案,说明并论证所选定实施方案的理由。 ◇项目开发计划:为软件项目实施方案制订出具体计划,应该包括各部分工作的负责人员、开发的进度、开发经费的预算、所需的硬件及软件资源等。 ◇软件需求说明书(软件规格说明书):对所开发软件的功能、性能、用户界面及运行环境等作出详细的说明。它是在用户与开发人员双方对软件需求取得共同理解并达成协议的条件下编写的,也是实施开发工作的基础。该说明书应给出数据逻辑和数据采集的各项要求,为生成和维护系统数据文件做好准备。 ◇概要设计说明书:该说明书是概要实际阶段的工作成果,它应说明功能分配、模块划分、程序的总体结构、输入输出以及接口设计、运行设计、数据结构设计和出错处理设计等,为详细设计提供基础。 ◇详细设计说明书:着重描述每一模块是怎样实现的,包括实现算法、逻辑流程等。 ◇用户操作手册:本手册详细描述软件的功能、性能和用户界面,使用户对如何使用该软件得到具体的了解,为操作人员提供该软件各种运行情况的有关知识,特别是操作方法的具体细节。 ◇测试计划:为做好集成测试和验收测试,需为如何组织测试制订实施计划。计划应包括测试的内容、进度、条件、人员、测试用例的选取原则、测试结果允许的偏差范围等。 ◇测试分析报告:测试工作完成以后,应提交测试计划执行情况的说明,对测试结果加以分析,并提出测试的结论意见。 ◇开发进度月报:该月报系软件人员按月向管理部门提交的项目进展情况报告,报告应包括进度计划与实际执行情况的比较、阶段成果、遇到的问题和解决的办法以及下个月的打算等。 ◇项目开发总结报告:软件项目开发完成以后,应与项目实施计划对照,总结实际执行的情况,如进度、成果、资源利用、成本和投入的人力,此外,还需对开发工作做出评价,总结出经验和教训。 ◇软件维护手册:主要包括软件系统说明、程序模块说明、操作环境、支持软件的说明、维护过程的说明,便于软件的维护。 ◇软件问题报告:指出软件问题的登记情况,如日期、发现人、状态、问题所属模块等,为软件修改提供准备文档。 ◇软件修改报告:软件产品投入运行以后,发现了需对其进行修正、更改等问题,应将存在的问题、修改的考虑以及修改的影响作出详细的描述,提交审批。 1可行性分析报告 1 引言 1.1 编写目的:阐明编写可行性研究报告的目的,提出读者对象。

医院基本数字及财务分析统计表编制说明

《基本数字及财务分析指标表》编制说明 一、基本数字部分 (一)人员 1、编制人数:根据编制管理部门核定的人员编制数填列。 2、期末在职职工人数:指当年期末支付工资的在岗职工人数,包括合同聘用制人员,不包括临时工、离退休人员、离开本单位仍保留劳动关系的人员和返聘人员。 “合同聘用制人员”指单位在职的全员聘用合同制人员。 “卫生技术人员”指年末单位在职的执业(助理)医师、护师、注册护士、药剂人员、检验和影像人员等卫生专业人员。不包括专职从事管理工作的卫生技术人员。 3、平均在职职工人数:指每月在职职工人数的加权平均数。 4、期末离休人数:按单位期末实有离休人数填列。 5、期末退休人数:按单位期末实有退休人数填列。 6、平均离退休人数:指每月离退休人数的加权平均数。 7、期末返聘人数:按单位期末实有返聘人数填列。 8、期末临时工人数:指单位全年聘用临时工的期末数,不含终点工。 (二)床位 1、编制床位:指卫生主管部门核定的编制床位数。 2、平均开放床位:填列每日开放床位的加权平均数。 3、期末实际开放床位:指期末实际开放的床位数。(三)房屋及建筑物面积 单位全部房屋及建筑物面积,含医疗用房、管理用房、生活用房、住宅、停车场、商业用房等。 (四)资产 1、总资产:按资产负债表中资产总计的期初数和期末数填列。 2、流动资产:按资产负债表中的期末流动资产合计数

填列。 其中:速动资产=流动资产-存货 3、固定资产总值:按资产负债表中的固定资产原值期初数和期末数填列,不包含在建工程和待处理固定资产净损失。 其中:专用设备按固定资产明细账专用设备期末余额填列。 4、固定资产净值:按资产负债表中的期末固定资产原值减去累计折旧后的差额数填列。 5、平均存货:按资产负债表中的存货期初数和期末数之和除以2填列。 6药品平均占用额:指库存物资中期初药品账面价值和期末药品账面价值的平均金额。 7、卫生材料平均占用额:指库存物资中期初卫生材料账面价值和期末卫生材料账面价值的平均金额。 (五)负债 负债、流动负债与非流动负债按资产负债表中的期末负债合计数、流动负债合计数与非流动负债合计数填列。(六)净资产 按资产负债表中的净资产期初数和期末数填列。 其中:本期结余按资产负债表中的本期结余期末数填列。 (七)诊疗人次 诊疗人次:指所有诊疗工作的总人次数。包括病人来院就诊的门诊、急诊人次,出诊、赴家庭病床、下地段等外出诊疗人次,本院职工的诊疗人次数,外出进行的单项健康体检及健康咨询指导人次,局部的单项健康检查人数等。 其中:门急诊人次为病人来院就诊的门诊、急诊人次。(八)住院床日 1、实际开放总床日数:指年内医院各科每日夜晚12点钟开放病床数之总和,不论该床是否被病人占用,都应计算在内,包括因故(如消毒、小修理等)暂时停用的病床,不包括因医院病房扩建、大修理或粉刷而停用的病床

日常行为规范考核方案

三坪小学日常行为规范考核方案 一、指导思想:为了进一步提高我校常规管理水平,倡导良好的校风、班风、学风,美化校园环境,强化学校常规管理,规范学生行为,不断提高我校学生的整体素质。根据《小学生日常行为规范》、《小学生守则》和我校的实际情况,现制定《三坪小学生日常行为规范考核细则》。 二、评分细则: 1.出勤(10分)学生迟到或早退一次扣1分;事假一次扣2分;旷课一次扣3分;病假可不扣分。 2.纪律、安全(30分) ①课堂纪律不好,每次扣1分 ②严禁爬围墙、大门,违者每次扣2分。在楼梯上故意推搡他人,或趴扶手下滑每次扣2分。 ③在校期间不得随意进出校门,有事必须向学校或班主任请假,违者一次扣2分。 ④经查实,在校内外有偷窃行为,进出网吧、游戏机厅等场所,及参与其它校外不良活动,给学校造成不良影响的,每次扣3分。 ⑤校会、汇演、比赛等学校集体活动,不能遵守活动纪律,影响秩序的,扣该生3分。 ⑥不得携带铁棍、刀具、火种、鞭炮、玩具枪或其它危险物品进入校园,违者每次扣1分。 ⑦不经老师同意擅自到别的班级拿东西或扰乱其他班级学生正

常学习或活动的,每次扣2分。 ⑧穿着不整齐或穿奇装异服,佩戴首饰,奢侈化妆的每次扣1分。 3.两操(10分) ①课间操有迟到的,每次扣1分;做操不认真的,每次扣1分;无故不出操的,每次扣2分。 ②做眼保健操不认真的,每次扣1分。 4.卫生(20分) ①每天吃完营养餐后至放学前发现各自清洁区内有果皮,纸屑,塑料片,明显垃圾,卫生死角等,一处扣1分。 ②在校园内乱扔乱倒垃圾的,每次扣2分。 5.爱护公物(10分) ①定期检查班上公物使用情况,人为损坏、遗失或被盗一件次视情况分别扣1—5分,并追究责任,负责修理、赔偿。 ②在桌椅、门窗、墙壁、立柱上乱刻乱画或粘贴纸,一次扣2分。并追究责任,负责清理。 ③爱护学校的花草树木,不踏进花坛半步,不乱折损花草,不乱摇摆树枝,违者每次扣1分。 ④爱护校园内宣传标语、板报、橱窗,擅自抹擦损坏的,每次扣2分,并负责赔偿。 ⑤节约水电,随手关水、关电,违者每次扣2分。 6.路队(10分) 每天不站路队离校的每次扣1分。不听从值周领导、老师指挥的,

用户手册编写规范

用户手册编写规范 文件编号:YF-09 版本号:V1.0 受控状态:受控 发放编号: 编制人:编制日期:审核人:审核日期:批准人:批准日期:

变更记录 注:对该文件内容增加、删除或修改均需填写此变更记录,详细记载变更信息,以保证其可追溯性。写手册时将此变更记录删除。

手册格式 ?手册第二页插入目录 ?标题及字号 标题一黑体二号字 标题二黑体三号 标题三黑体小四 正文宋体五号 小标题宋体五号粗体 ?每章标题下加段下划线,可以复制粘贴过去 ?文中所有需要重点提醒的地方,使用备注方式,即文中的注意部分,使用文中现有的格式“注意” ?每章标题(即标题一)前,插入分节符 ?文字行距为1.5倍 ?插入的图片加黑色边框,居中显示,大小不能超过页面边界 ?尽量使图片中文字显示清楚,必要时可以撑满页面宽度 ?页眉中插入域“styleref”,标题1,页脚插入“北京清华北方思路信息技术有限公司” 和页码,右对齐 手册封面 *******系统 1.0 版 使用手册 北京清华北方思路信息技术有限公司 2004年11月23日

系统概述 概述本文档所适用的软件和系统的用途。 系统目标 概述本文档的用途和内容。 系统特点 概述本系统突出特点。 运行环境 明确用户安装运行该软件必须的软、硬件环境以及其它相关资源。必要时还应包括: ①必须列出的计算机设备,包括所需处理能力、内外存储器,以及其它存储设备和外部设备; ②必需的支撑软件,如操作系统、数据库、数据文件和其它支持软件; ③通讯设备; ④其它工具、设备和资源。

安装过程 对初次使用该软件的用户,提供足够详细的资料以便用户在学习软件的详细功能之前能够放心地使用该软件。描述用户必须履行的一些程序如用户如何安装软件、配置软件、删除和覆盖原来的文件或数据、输入软件操作所需的参数。 卸载程序 描述卸载程序的方法及过程。

生产统计报表的编制

统计员的工作汇报就是及时、准确、完善的向相关部门呈递《生产统计报表》。尽量让我们高层管理人员对所管辖的下属部门的工作情况了如指掌,及时地发现问题作出决策,并使管理工作得以顺利进行。 通过我们详细的汇报中了解生产计划的执行情况,了解生产进度、材料供应、计划执行状况,机器设备的运转状况等,可以及时掌握生产动态和异常情况,可以了解人员的思想变化等。可以及时发现工作中存在的困难和问题,生产中不可避免会出现这样或那样的问题,通过定期或不定期的工作汇报,可以及时了解这些困难或问题,并及时加以研究和解决,并把可能造成的各种损失降低到最小的程度。统计一般是交叉统计为最佳,例如生产的数据,由仓库监督统计;报表上的统计,审核必须是对口的人员。即生产上的数据是由仓库进行监督统计的,就是反应了交叉统计。 没有统计软件的情况下,最简单的理解就是输入与输出平行,例如总输入的用料单与总产成的进仓单,进仓不单是产品的数量进仓,还要重量进仓(因为重量是要和你的输入材料做对比的),还有废品进仓(也是数量与重量登记)。有入必有出。 统计的人员首先要明白数据怎么来的,要学会利用数据,而不是为数据打工。 二、工作汇报的内容,工作汇报的内容很多 ,现只就生产、质量、物料方面的内容做一个简单的介绍。 1、生产方面的汇报 (1)各类生产计划的完成情况 (2)各项工作的落实与执行情况 (3)生产进度状况与工时投入,生产跟踪情况。 (4)现场作业状况 (5)各类生产异动情况:

包括进度异动、工艺异动、其它异动。 (6)生产人员工作情况 (7)各订单完成情况 (8)产品交货状况 2、质量方面的汇报 (1)各道工序、各车间(班组)的产品质量情况(2)质量问题及质量异动 (3)各种产品的不合格率机造成因素 (4)内部质量事故的调查处理及质量问题的追溯(5)质量问题的处理汇报 (6)质量目标达成情况 (7潜在的质量隐患 3、物料方面的汇报 (4)物料耗用情况及日消耗量 (5)剩料、缺料解决办法 (6)余料、呆料、废料、遗留旧货及零部件的处理(7)再生物料跟踪情况 (8)物料异常情况 三、工作汇报的形式 生产作业管理中常见的汇报方式如下: 1、口头报告

编制统计表的注意事项

编制统计表的注意事项 1、统计表的表式一般分为表头、表体和表脚三部分。表头包括统计表的名称和填报单位、日期、数值单位、表号等内容,在表的上部;表体是统计表的主要部分,包括表的项目、内容、数值等,表体首行(定义各列内容)加粗标蓝,规范醒目;表脚列明填表人、复核人、负责人,便于明确责任及查询。 2、统计表的名称应简明、确切,概括地反映出表的基本内容,所属的空间和时间范围。格式上应合并单元格并居中,字号根据表的宽度选择,通常选择16号字,并加粗。 3、统计表的形式应设计为纵横线条交叉的长方形表格,长宽保持适当比例,外框或分栏框用粗线,其他线条以细线绘制。 4、统计表的主词(统计表要说明的对象)和宾词(为说明主词的特征而采用的指标)必须相互对应,准确地表明任一指标数值的性质。按照习惯,主词在表的左方竖排,宾词在右侧横排,主词各行和宾词各项目,应按先局部后总体的原则排列,即先列各组,后列总计。如没有必要列出所有项目,则先列总计,后列出一部分重要项目。 5、统计表中单元格对齐方式一般水平及垂直均居中,但数值以右对齐为宜,以便直观看出数据大小。个数或人数用整数表示,金额单位一般为带千分符,并保留两位小数。文字部分用宋体字,数字部分用Times New Roman。统计表数据部分不应留空

白,当数字为零时要写出来,不应有数字时要用小横线填充,避免漏填及方便筛选。合计栏应加粗,不进行合计的单元格用灰色填充。日期格式采用四位年、两位月、两位日格式,如“2013-01-18”。 6、统计表中数值的计量单位应按以下方法表示:当表中数值都以同一单位计量时,将计量单位写在统计表的右上角;当同栏数值以同一单位计量,而各栏单位不同时,则应将单位写在各纵栏标题的下方;当同行单位相同,而各行单位不同时,可在横行标题后添列一个计量单位栏,用以标明各行的计量单位。 7、如果统计表栏数较多,通常加以编号。如各栏之间数据有计算关系,可在备注中标明。如,(3)=(2)+(1),表示该表中第3栏为第2栏与第1栏数字之和。 8、统计表需要加注说明或注解时,注在表的下端。

(完整版)计算机软件文档编制规范

《计算机软件文档编写指南》 一.计算机软件文档由封面、目录、正文、注释和附录组成。 封面格式: 密级:编号: 文档名称: 项目名称: 编制: 审核: 批准: ×××××××××××××研究所 年月日

二.计算机软件文档包括: 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.服务(阐明开发单位可向用户提供的服务. 如人员培训安装保修维护和其他运行支持。)

软件功能规格说明书编写规范

软件功能规格说明书 编写规范

目录 1. 目的 2. 适用范围 3. 术语及缩略语 4. 编写规范 4.1排版规范 4.2模板使用 5. 引用文件 5.1NW503101《需求分析报告编写规范》 6. 附录

1.目的 本文件是为了指导开发人员编写软件功能规格说明书。 2.适用范围 适用于本公司软件项目的软件功能规格说明书的编写。 3.术语及缩略语 本程序采用NQ402100《质量手册》中的术语和缩略语及其定义。 4.编写规范 4.1排版规范 1)整个规范由2节构成,模板单独一节。 2)正文样式采用“规范正文”。 3)标题编号采用每节独立编号。 4.2模板使用 1)拷贝规范。 2)删除第一节(软件功能规格说明书封面前的所有页)。 3)在修改完内容后,更新目录域和相关的页数域。 5.引用文件 5.1 NW503101《需求分析报告编写规范》 6.附录 以下部分为软件功能规格说明书的模板。

密级:机密 文档编号:第版分册名称:XX系统(或子系统)功能规格说明书 修改记录编号:第册/共册 项目名称(项目编号) 需求分析报告 (部门名称)

目录 1. 引言 (3) 1.1目标 (3) 1.2用户的特点 (3) 2. 假定和约束 (3) 3. 功能规定 (3) 3.1功能分解表 (3) 3.2数据描述表 (4) 3.3对性能等其他专门要求 (4) 4. 运行环境规定 (4) 5. 程序接口 (4) 6. 程序运行方式 (4) 7. 开发成本和进度估算 (4) 8. 尚需解决的问题 (4) 9. 附录 (5)

1.引言 1.1目标 说明子系统的定义等。 1.2用户的特点 列出本功能的最终用户的应用水平属需求分析报告中的哪一类。此外,本功能用户还有一些什么其它特点,如用户会使用SQL语言等。 1.3术语 列出本报告中用到的专门术语的定义。 2.假定和约束 列出进行本功能开发工作所需的一些假定条件和必须满足的约束,例如本功能开发假定用户会熟练使用SQL语言,本功能应在某功能实现前开发完成等。 3.功能规定 3.1功能分解表 本节以表的形式按被管理的用户数据列出所有子功能。编写格式见附录的《软件功能规格表》。 软件功能规格表填表说明: 1)序号:由项目软件经理PSM根据本系统各功能分解关系统一编号; 2)数据序号:子功能使用的软件数据表中数据的序号; 3)制表:填写编写本表责任人的名字; 4)审核:由项目软件经理PSM签字; 5)日期:填报日期; 6)处理方法名:如财务系统的记帐、帐簿打印等; 7)类型: 类型分为共享或私有,如果该处理方法仅针对本类型数据,则它是私有的,如果该处理方法还适用于其它类型数据则为共享的; 8)处理说明(对应两行); 9)第一行用于简单说明该处理方法的内容; 10)第二行列出本方法有关的资料参考如算法详细描述书籍、相关的业务流程规范等。

基本单位统计报表调查表式

可编辑
基本单位统计报表调查表式
精品

可编辑
综合报表
综合机关名称:
单位 序号 甲
登记机 关代码
1
部门登 记证号
2
变更组织机构代码和剔除单位一览表
原组织机 构代码
3
新组织机 构代码
4
20 年 单位名称 5
法定代 表人
6
详细地址 7
行政区 划代码
8

号:J 401 表
制表机关:国家统计局
文 号:国统字(2009)85 号
有效期至:2010
联系电话 9
单位类别 代码 10
年1 月
更新类型 代码 11
单位负责人:
填表人:
报出日期:20 年 月 日
说明:1.本表统计范围是辖区内所有组织机构代码变更的单位,以及在机构编制、民政、税务和工商等部门进行注销登记的或通过各项统计
调查查到需剔除的法人单位和产业活动单位。
2.本表报告期别为半年报;2009 年定期报表各设区市上报时间为 11 月 16 日前。
3.登记机关代码:B-机构编制部门;M-民政部门;S1-国税部门;S2-地税部门;G-工商部门;Q-其他。
4.单位类别代码:
法人单位填写:10-企业法人;20-事业法人;30-机关法人;40-社团法人;51-民办非企业法人;52-基金会;53-居委会;54-村委会;90-其他
法人;
多产业法人所属的产业活动单位或分支机构填写: 01-生产经营性的产业活动单位;02-非生产经营性的产业活动单位。
5.更新类型代码:1-变更组织机构代码;2-剔除。
精品

浪潮集团山东通用软件有限公司用户手册编制规范模板

浪潮集团山东通用软件有限公司用户手册编制规范 1

密级: 机密 用户手册编制规范 V1.0

1999年10月20日 浪潮集团山东通用软件有限公司 1

目录 文档类别使用对象 .......................................................... 错误!未定义书签。1.引言............................................................................. 错误!未定义书签。 1.1目的.......................................................................... 错误!未定义书签。 1.2范围.......................................................................... 错误!未定义书签。 1.3术语定义.................................................................. 错误!未定义书签。 1.4参考资料.................................................................. 错误!未定义书签。 1.5版序控制记录.......................................................... 错误!未定义书签。 1.6版本更新记录.......................................................... 错误!未定义书签。2.编制大纲..................................................................... 错误!未定义书签。 2.1编写要求............................................................... 错误!未定义书签。 2.2文档分类............................................................... 错误!未定义书签。 2.3用户使用手册编制大纲...................................... 错误!未定义书签。 2.3.1 前言.............................................................. 错误!未定义书签。 2.3.2 功能............................................................. 错误!未定义书签。 2.3.3 附录.............................................................. 错误!未定义书签。 2.4用户安装手册编制大纲....................................... 错误!未定义书签。 2.4.1 前言.............................................................. 错误!未定义书签。 2.4.2 单机版的安装及配制.................................. 错误!未定义书签。 2.4.3 网络版的安装及配制.................................. 错误!未定义书签。 2.4.3 附录.............................................................. 错误!未定义书签。 2

相关主题
文本预览
相关文档 最新文档