用户手册编写模板.doc

密级：内部公开 { 项目名称 } 用户手册编写指南 项目编号 文件编号 SXW_TS_UM_V5.0 记录号 项目编号_TS_UM 版本号 可以是日期 正文页数 附件个数 （项目经理）批准/日期：  文件修订记录 版本号 变化状态* 简要说明 （变更内容和变更范围） 变更日期 变更人 *变化状态：C―创建，A—增加，M—修改，D—删除 注：蓝色斜体部分为注释或举例，实际使用时请去掉。 版权声明 [版权声明是保护我们所开发软件的产权、不使公司利益受到损害的一种方式。在版权声明中应该包括以下内容： 1. 对我们所提供的软件及用户手册的保护声明 2. 对我们的软件及商标所有权的声明 3. 对我们的用户手册中所提到的各种商标的版权声明 4. 我们不对用户因为使用我们的软件所造成的损失负责的声明]  前 言 文档目标 通过阅读该用户手册，用户应该或能够达到什么目标。 阅读对象 说明谁应该阅读本手册，或谁应该阅读本手册的哪些部分。 关于本手册 如果本系统的用户手册(包括管理员手册、参考手册等)由多份文档组成，则首先应该分别简要介绍这些手册的情况。然后分别介绍本手册在每一章所要描述的内容。有助于用户阅读和理解本手册的相关文档资源，也可以在本段中特别指明。 文档约定 说明文档中字体体例，用什么字体代表什么意义。例如：黑体（粗）代表命令，黑体（常规）代表命令参数等等。 说明文档中的符号代表何种意义。例如：代表提醒等。 缩略语和术语 列出本文档涉及的缩略语和术语，并扼要解释。如果篇幅较大，则可以以附录和引用文件的形式给出。 如何获得最新版本 说明获得本手册最新版本的途径。 用户反馈 列出用户通过什么途径，提交对产品手册的意见。  目 录 1 简介 7 1.1 XX系统描述 7 1.1.1 XX系统的用途 7 1.1.2 系统主要特性 7 1.1.3 XX系统不能胜任的工作（本条可选） 7 1.2 安装、运行环境 7 1.2.1 软件环境 7 1.2.2 硬件环境 7 1.2.3 其它 7 1.3 问题报告和获得帮助 8 2 快速指南（本章可选） 8 3 系统安装 8 3.1 windows 2003下安装（用实际的操作系统名称来代替标题中的操作系统名称） 8 3.1.1 安装前准备 8 3.1.2 安装 8 3.1.3 安装验证测试（本条可选） 9 3.2 Solaris下安装（用实际的操作系统名称来代替标题中的操作系统名称） 9 3.2.1 安装前准备 9 3.2.2 安装 9 3.2.3 正确安装测试（本条可选） 9 3.3 RedHat Linux AS4下安装（用实际的操作系统名称来代替标题中的操作系统名称） 9 4 用户界面（本章可选） 9 4.1 简介 10 4.2 开始使用系统 10 4.3 主窗口 10 4.4 菜单 10 4.4.1 “文件”（File）菜单 10 4.4.2 “编辑”（Edit）菜单 10 4.4.3 …… 10 4.4.4 “帮助”（Help）菜单 10 5 使用XX系统 10 5.1 用户管理 11 5.1.1 用户登录 11 5.1.2 新建用户 11 5.1.3 删除用户 11 5.2 数据管理 11 6 视具体情况，添加更多的章节来说明系统。例如：命令参考、系统数据格式说明等 11 7 常见问题解决 11 8 附录 11 8.1 附录1-列表（本条可选） 11 8.1.1 表格列表 11 8.1.2 插图列表 12 8.1.3 示例列表 12 8.2 附录2-参考文档 12 简介 XX系统描述 XX系统的用途 描述系统的用途，例如用于社区信息管理，诸如此类。 系统主要特性 扼要描述系统的主要特性（features），例如支持多少种操作系统、支持多少个用户、支持同时多少个并发等等。 XX系统不能胜任的工作（本条可选） 描述系统不具备的能力，防止用户误用。例如用户可能会用一个网络包分析和包生成软件来实施路由功能，显然这不是应用程序设计的本意。 安装、运行环境 描述系统安装、运行所需的环境。如果安装和运行的环境不一致，则需要单独说明。 软件环境 列出系统安装、运行所需的操作系统以及其他辅助的应用程序，例如Windows2003、SQL Server，诸如此类。 硬件环境 列出系统安装、运行所需的硬件环境，例如主机的数量、主机的配置（CPU、内存、硬盘、网卡）以及外设（打印机、扫描仪、绘图仪），诸如此类。 其它 列出系统安装、运行所需的其它要求。 问题报告和获得帮助 说明用户反映系统问题以及获得帮助的途径，例如email、电话、在线帮助，诸如此类。 快速指南（本章可选） 以一个或几个简