下面的内容仅代表个人观点,是在工作中总结出来的,如果有错误之处,还请指教。

转载请注明来自博客园---”邦邦酱好“:

http://www.cnblogs.com/bangbangjiang/p/3673382.html

用户手册是详细描述软件的功能、性能和用户界面,使用户了解如何使用该软件。

一.  格式

下面列举几个在编写文档中需要注意的地方(博客园---”邦邦酱好“)

  1. 页眉:注意增加公司的资料,如果是内部资料,可以写上:内部资料,保密。

  2. 页脚:非正文部分使用I,II,III,IV等作为页码,从第一章的正文开始使用1,2,3,4.....等页码,页码号居中。

  3. 大小标题都要统一格式,最好使用word自带的“样式集“来进行编写,避免后面重复修改的麻烦,使用小四字体。

  4. 功能类似的部分,要统一表述方式,不要相差太多。

  5. 正文统一使用5号字体,宋体,英文使用Times New Roman字体,行的前后行距要一样,比如1.25倍行距,不要有些地方间距很大,有些地方又很小。

  6. 日期的格式要一致,比如统一为:2014-04-16或者2014.04.16或者2014年4月16日,在整个文档中,应该只出现其中一种日期格式。

  7. 分级描述时要使用word的编号库,而且不同分级之间要注意缩进量。使用编号库的目的在于避免这个文档在其他人的电脑上出现不同大小的缩进量,导致文档看着混乱。

  一级标题:标题序号为”一‘

  二级标题:标题序号为“(一)”

  三级标题:标题序号为“1.”

  四级标题:标题序号为"(1)"

  五级标题:标题序号为“1”(圆圈里有个1)

  8. 分级描述时,注意统一使用分号或句号进行结尾。

  9. 如果是注意事项,要统一加粗,加亮。

  10. 图表编号要连续,如图1,图2等,表1,表2等,图的编号要放图的正下方,表的编号要放表的上方。

  11. 功能大致相同的地方,可以说明操作步骤一样以及其中稍微不同的地方,请用户参考某个章节使用,避免重复而累赘的说明。

  12. 如果在某个版本软件的功能发生了改变,应该注明:***软件版本开始增加(或删除)**功能/***以前的版本可能会存在**差异,如此一来,用户就算拿着不同版本的软件都可以参考此使用手册。

二. 内容

下面描述用户手册的内容(博客园---”邦邦酱好“

第 I 页:

  大大的字体写明是本文档是什么软件的用户手册,并注明当前文档的版本号。

第 II 页:

  1. 修订历史记录:

    分别要说明以下几项:版本号,修订日期,修订内容,修订人(最好使用表格,统一表述方式)

  2. 关于版本号:一般文档的初始版本为1.0,如果下次软件有修改,需要同时在用户手册中增加相关的说明,那版本号依次变为1.1,1.2,1.3.....如果软件有重大的改变,那就将文档版本升级为2.0。

第 III 页:

  目录,使用word自带功能插入此目录,使用超链接,注意每次文档修改完毕,更新一次目录,避免标题内容或者页码与正文的不一致。

第 1 页:

  正文开始~

第一章:引言或简介

(一)编写目的:说明编写本手册的目的,指明读者对象。

如: 1.告知**软件的使用者,**软件所提供的功能;

  2.如何正确地使用这些功能来完成***工作;

(二)项目背景:说明项目的来源,委托单位,开发单位及主管部门。

(三)手册的范围:说明软件的使用范围,使用者范围,软件的版本,简要介绍手册各章节的内容。

(四)名词定义:列举出手册中用到的专门术语的定义及缩写词的原意。

(五)参考资料:包括项目的计划任务书,合同或批文;项目开发计划;需求规格说明书;概要设计说明书;详细设计说明书;测试计划;手册中引用的其他资料、采用的软件工程标准或软件工程规范。列出这些资料的作者,标题,编号,发表日期,出版单位或资料来源。

第二章:软件概述

(一)软件说明:

  软件的功能描述,使用过程中要注意的问题,包括数据的精确度(包括输入输出及处理数据的精度),时间特性(如响应时间,处理时间,数据传输时间等),灵活性(在操作方式,运行环境需要做某些变更时软件的适应能力)。

(二)运行环境:

  1. 硬件:软件运行时所需的硬件最小配置,如主存容量,输入输出设备等。

  2. 支持软件:操作系统全称及版本号,语言编译系统的名称及版本号,数据库管理系统的名称及版本号,其他必要支持。

(三)使用说明:

  1. 安装及初始化:表明安装完成的测试实例及安装所需的软件开发工具等等。

  2. 运行步骤:按顺序说明每种运行的步骤,应包括运行控制;操作信息(运行目的,操作要求,启动方法,预计运行时间,操作命令格式及说明,其他事项);输入输出文件,启动或回复过程。

  3. 常规过程:提供应急或非常规操作的必要信息及操作步骤,如出错处理操作、向后备系统切换操作以及维护人员须知的操作和注意事项。

  4. 操作命令一览表:按字母顺序逐个列出全部操作命令的格式、功能及参数说明。

  5. 程序文件(或命令文件)和数据文件一览表:按文件名字母顺序或按功能与模块分类顺序逐个列出文件名称、标识符及说明。

  6. 用户操作举例。

(四)软件界面布局  

  介绍软件启动时的界面,进入某个功能后的界面。截图并标出各个部分的序号,并在下面简要说明各个部分的用途。

第三章:基本操作及功能介绍

分点,详细地介绍软件的各个功能,内容包括:

功能点简述:

  1. 软件截图(要介绍的那个部分);

  2. 软件使用步骤:操作步骤,输入,输出;

  3. 软件使用注意(加粗加亮表示);

  

  注意做到有条理,顺序地说明,不要让用户看得一头雾水,本来简简单单的软件如果被说得复杂难懂,这样的用户手册是不过关的。

用户手册User Guide的写法的更多相关文章

  1. Linux Kernel - Debug Guide (Linux内核调试指南 )

    http://blog.csdn.net/blizmax6/article/details/6747601 linux内核调试指南 一些前言 作者前言 知识从哪里来 为什么撰写本文档 为什么需要汇编级 ...

  2. Beennan的内嵌汇编指导(译)Brennan's Guide to Inline Assembly

    注:写在前面,这是一篇翻译文章,本人的英文水平很有限,但内嵌汇编是学习操作系统不可少的知识,本人也常去查看这方面的内容,本文是在做mit的jos实验中的一篇关于内嵌汇编的介绍.关于常用的内嵌汇编(AT ...

  3. 九十分钟极速入门Linux——Linux Guide for Developments 学习笔记

    系统信息:CentOS 64位. 一张图了解命令提示符和命令行 一些实用小命令 mkdir(make directory,创建目录).ls(list,列出当前目录下的内容).rm(remove,删除文 ...

  4. Google C++ Style Guide

    Background C++ is one of the main development languages used by many of Google's open-source project ...

  5. SQL Server中参数化SQL写法遇到parameter sniff ,导致不合理执行计划重用的一种解决方案

    parameter sniff问题是重用其他参数生成的执行计划,导致当前参数采用该执行计划非最优化的现象.想必熟悉数据的同学都应该知道,产生parameter sniff最典型的问题就是使用了参数化的 ...

  6. scheme 宏macro写法

    scheme里的宏不同的实现有不同的写法: 1.mzscheme的define-macro (mzscheme也就是pltschme,也就是drracket,没有define-macro这个关键字) ...

  7. Sqoop-1.4.5用户手册

    本文以Sqoop User Guide (v1.4.5)为主,对Sqoop-1.4.5的用户手册进行翻译,同时会结合一些实际操作中的注意事项一并写入.由于原文档很长,本文首先会以实际使用到的部分为主, ...

  8. Django REST Framework API Guide 01

    之前按照REST Framework官方文档提供的简介写了一系列的简单的介绍博客,说白了就是翻译了一下简介,而且翻译的很烂.到真正的生产时,就会发现很鸡肋,连熟悉大概知道rest framework都 ...

  9. Unity3D用户手册

    Unity Manual 用户手册 Welcome to Unity. 欢迎使用Unity. Unity is made to empower users to create the best int ...

随机推荐

  1. 【Demo 0005】Java基础-类继承性

    本章学习要点:       1.  了解Java继承特性;       2.  掌握继承实现方法;       3.  掌握override规则: 一.类继承特性       1.  继承定义:使用己 ...

  2. javascript实现的可改变滚动方向的无缝滚动

    效果图如下: 代码: <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http:// ...

  3. leetCode 34.Search for a Range (搜索范围) 解题思路和方法

    Search for a Range Given a sorted array of integers, find the starting and ending position of a give ...

  4. DLL五篇

    http://www.cnblogs.com/NeuqUstcIim/archive/2009/01/12/1374511.htmlhttp://www.cnblogs.com/NeuqUstcIim ...

  5. 绘制FastMM内存分配流程图(小块内存分配)

    http://blog.csdn.net/henreash/article/details/38751353

  6. 与众不同 windows phone (21) - Device(设备)之摄像头(拍摄照片, 录制视频)

    原文:与众不同 windows phone (21) - Device(设备)之摄像头(拍摄照片, 录制视频) [索引页][源码下载] 与众不同 windows phone (21) - Device ...

  7. Unity3D 游戏开发构架篇 ——输入控制

    临近毕业之初.进入Unity3D这个行业,是一家小工作室.老板人非常不错,公司氛围也非常单纯.近期公司开发一款小游戏,初次上手,颇多周折,记录下自己的开发心得.主要涉及一些设计理念,互相交流. 先说下 ...

  8. TCP连接的建立(二)

    被动打开 SYN cookies TCP协议开辟了一个比較大的内存空间请求连接队列来存储连接请求块,当SYN请求不断添加,请求连接数目到达上限时,会致使系统丢弃SYN连接请求.SYN cookies技 ...

  9. js错误 SyntaxError: missing : after property id

    在用jquery的post方法时 $.post('adminCheckTpmisPlans.do',{'test',str},function(f){ ... }) 报如下错误 SyntaxError ...

  10. [ffmpeg 扩展第三方库编译系列] 关于须要用到cmake 创建 mingw32编译环境问题

    我在这里给出我编译的样例 cmake -G"MinGW Makefiles" -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=& ...