用户手册编写模板

《用户手册编写模板》由会员分享，可在线阅读，更多相关《用户手册编写模板（10页珍藏版）》请在装配图网上搜索。

1、 密级：部公开项目名称用户手册编写指南项目编号文件编号SXW_TS_UM_V5.0记录号项目编号_TS_UM版本号可以是日期正文页数附件个数项目经理批准/日期：9 / 10文件修订记录版本号变化状态*简要说明变更容和变更围变更日期变更人*变化状态：C创立，A增加，M修改，D删除文件审批信息版本号审批人角色审批意见签字审批日期注：蓝色斜体局部为注释或举例，实际使用时请去掉。声明声明是保护我们所开发软件的产权、不使公司利益受到损害的一种方式。在声明中应该包括以下容：1. 对我们所提供的软件与用户手册的保护声明2. 对我们的软件与商标所有权的声明3. 对我们的用户手册中所提到的各种商标的声明4. 我

2、们不对用户因为使用我们的软件所造成的损失负责的声明前言文档目标通过阅读该用户手册，用户应该或能够到达什么目标。阅读对象说明谁应该阅读本手册，或谁应该阅读本手册的哪些局部。关于本手册如果本系统的用户手册(包括管理员手册、参考手册等)由多份文档组成，那么首先应该分别简要介绍这些手册的情况。然后分别介绍本手册在每一章所要描述的容。有助于用户阅读和理解本手册的相关文档资源，也可以在本段中特别指明。文档约定说明文档中字体体例，用什么字体代表什么意义。例如：黑体粗代表命令，黑体常规代表命令参数等等。说明文档中的符号代表何种意义。例如：代表提醒等。缩略语和术语列出本文档涉与的缩略语和术语，并扼要解释。如果篇

3、幅较大，那么可以以附录和引用文件的形式给出。如何获得最新版本说明获得本手册最新版本的途径。用户反应列出用户通过什么途径，提交对产品手册的意见。目录1 简介71.1 描述77771.2 安装、运行环境77771.3 问题报告和获得帮助82 快速指南本章可选83 系统安装83.1 windows 2003下安装用实际的操作系统名称来代替标题中的操作系统名称88893.2 Solaris下安装用实际的操作系统名称来代替标题中的操作系统名称99993.3 RedHat Linux AS4下安装用实际的操作系统名称来代替标题中的操作系统名称94 用户界面本章可选94.1 简介104.2 开场使用系统10

4、4.3 主窗口104.4 菜单10“文件File菜单10“编辑Edit菜单1010“帮助Help菜单105 使用105.1 用户管理111111115.2 数据管理116 117 常见问题解决118 附录118.1 附录1-列表本条可选111112128.2 附录2-参考文档121 简介1.1 描述1.1.1 的用途描述系统的用途，例如用于社区信息管理，诸如此类。1.1.2 系统主要特性扼要描述系统的主要特性features，例如支持多少种操作系统、支持多少个用户、支持同时多少个并发等等。1.1.3 不能胜任的工作本条可选描述系统不具备的能力，防止用户误用。例如用户可能会用一个网络包分析和包生

5、成软件来实施路由功能，显然这不是应用程序设计的本意。1.2 安装、运行环境描述系统安装、运行所需的环境。如果安装和运行的环境不一致，那么需要单独说明。1.2.1 软件环境列出系统安装、运行所需的操作系统以与其他辅助的应用程序，例如Windows2003、SQL Server，诸如此类。1.2.2 硬件环境列出系统安装、运行所需的硬件环境，例如主机的数量、主机的配置CPU、存、硬盘、网卡以与外设打印机、扫描仪、绘图仪，诸如此类。1.2.3 其它列出系统安装、运行所需的其它要求。1.3 问题报告和获得帮助说明用户反映系统问题以与获得帮助的途径，例如email、在线帮助，诸如此类。2 快速指南本章可

6、选以一个或几个简单的功能为例，快速地把操作流程演示一遍，让用户对系统的界面和功能有一个直观的印象，减少陌生感。本段篇幅应该尽量缺少，几页就可能收到不错的效果。描述的风格以用户界面截屏图以与菜单操作为主。3 系统安装说明系统的安装流程。如果系统的安装前的准备工作对于不同的操作系统有特殊的要求，那么就应该按不同的操作系统分别列出。例如：3.1.Windows 20033.2.Solaris3.3.RedHat Linux AS43.1 windows 2003下安装用实际的操作系统名称来代替标题中的操作系统名称3.1.1 安装前准备说明系统安装之前需要进展的准备工作，例如检查操作系统和应用程序的版

7、本、硬盘的空间、用户在系统中的权限、环境变量的设置，诸如此类。3.1.2 安装详细说明系统的整个安装过程，容包括：编译本条可选。如果系统是以源代码方式提供的，那么说明如何编译成可执行的安装程序。安装命令。例如菜单命令、命令行命令以与脚本命令等等。安装过程中的交互。详细描述每一次交互的输入、输出以与所导致的系统状态的改变。建议用GUI交互的应同时提供截屏图，用命令行交互的给出命令的完整输入、输出结果。3.1.3 安装验证测试本条可选说明安装完成以后，执行哪些测试操作来验证系统已经被正确安装，详细说明整个验证流程和输出结果。3.2 Solaris下安装用实际的操作系统名称来代替标题中的操作系统名称

8、3.2.1 安装前准备3.2.2 安装3.2.3 正确安装测试本条可选3.3 RedHat Linux AS4下安装用实际的操作系统名称来代替标题中的操作系统名称4 用户界面本章可选说明用户界面上的各个菜单项的容和功能。对于没有用户界面的系统，例如后台效劳程序，那么不需要在本段说明。如果系统可以在多个操作系统中使用，在不同的操作系统中的用户界面又不完全一致，那么对不一致的地方要单独说明。4.1 简介简单介绍用户界面的特性。4.2 开场使用系统说明系统的启动方式。4.3 主窗口扼要描述主窗口菜单的外观与布局，例如工具栏、状态栏的位置、文本编辑区的布局，诸如此类。4.4 菜单详细说明每个菜单的容、

9、功能以与包含的子菜单。说明的方式可以用对一个顶层菜单完全展开的方式来说明。最好配以相应菜单的截屏图。4.4.1 “文件File菜单4.4.2 “编辑Edit菜单4.4.3 4.4.4 “帮助Help菜单5 使用说明如何用本系统开场工作。针对每一项主要的任务用户管理、数据管理等等，说明其工作的流程。如果系统可以在多个操作系统中使用，在不同的操作系统中的工作流程又不完全一致，那么对不一致的地方要单独说明。5.1 用户管理5.1.1 用户登录5.1.2 新建用户5.1.3 删除用户5.2 数据管理6 7 常见问题解决列出系统曾经遇到过的常见的问题以与解决方案。如下示例：问题序号问题描述解决方案1不能添加新用户检查你登录的身份是否拥有根用户的权限8 附录8.1 附录1-列表本条可选8.1.1 表格列表列出文中出现的所用表格所在的页面编号8.1.2 插图列表列出文中出现的所用插图所在的页面编号8.1.3 示例列表列出文中出现的所用示例所在的页面编号8.2 附录2-参考文档用表格的形式列出与系统相关的参考文档。