用户手册编写模板.doc

密级 内部公开 项目名称 用户手册编写指南 项目编号文件编号 SXW TS UM V5 0 记录号项目编号 TS UM版本号可以是日期 正文页数附件个数 项目经理项目经理 批准 日期 用户手册用户手册 第 1 页 共 12 页 文件修文件修订记录订记录 版本号版本号变变化状化状态态 简简要要说说明明 变变更内容和更内容和变变更范更范围围 变变更日期更日期变变更人更人 变化状态 C 创建 A 增加 M 修改 D 删除 文件文件审审批信息批信息 版本号版本号审审批人批人角色角色审审批意批意见见签签字字审审批日期批日期 用户手册编写指南用户手册编写指南 第 2 页 共 12 页 注 蓝色斜体部分为注释或举例 实际使用时请去掉 版权声明版权声明 版权声明是保护我们所开发软件的产权 不使公司利益受到损害的一种方式 在版权声 明中应该包括以下内容 1 对我们所提供的软件及用户手册的保护声明 2 对我们的软件及商标所有权的声明 3 对我们的用户手册中所提到的各种商标的版权声明 4 我们不对用户因为使用我们的软件所造成的损失负责的声明 用户手册编写指南用户手册编写指南 第 3 页 共 12 页 前 言 文档目标 通过阅读该用户手册 用户应该或能够达到什么目标 阅读对象 说明谁应该阅读本手册 或谁应该阅读本手册的哪些部分 关于本手册 如果本系统的用户手册 包括管理员手册 参考手册等 由多份文档组成 则首先应 该分别简要介绍这些手册的情况 然后分别介绍本手册在每一章所要描述的内容 有 助于用户阅读和理解本手册的相关文档资源 也可以在本段中特别指明 文档约定 说明文档中字体体例 用什么字体代表什么意义 例如 黑体 粗 代表命令 黑体 常规 代表命令参数等等 说明文档中的符号代表何种意义 例如 代表提醒等 缩略语和术语 列出本文档涉及的缩略语和术语 并扼要解释 如果篇幅较大 则可以以附录和 引用文件的形式给出 如何获得最新版本 说明获得本手册最新版本的途径 用户反馈 列出用户通过什么途径 提交对产品手册的意见 用户手册编写指南用户手册编写指南 第 4 页 共 12 页 目目 录录 1 简介 7 1 1 描述 7 1 1 1 的用途 7 1 1 2 系统主要特性 7 1 1 3 不能胜任的工作 本条可选 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 用户手册编写指南用户手册编写指南 第 5 页 共 12 页 4 4 3 10 4 4 4 帮助 Help 菜单 10 5 使用 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 用户手册模板用户手册模板 第 6 页 共 11 页 1 简介 1 1 描述 1 1 1 的用途 描述系统的用途 例如用于社区信息管理 诸如此类 1 1 2 系统主要特性 扼要描述系统的主要特性 features 例如支持多少种操作系统 支持多少个用 户 支持同时多少个并发等等 1 1 3 不能胜任的工作 本条可选 描述系统不具备的能力 防止用户误用 例如用户可能会用一个网络包分析和包 生成软件来实施路由功能 显然这不是应用程序设计的本意 1 2 安装 运行环境 描述系统安装 运行所需的环境 如果安装和运行的环境不一致 则需要单独说 明 1 2 1 软件环境 列出系统安装 运行所需的操作系统以及其他辅助的应用程序 例如 Windows2003 SQL Server 诸如此类 1 2 2 硬件环境 列出系统安装 运行所需的硬件环境 例如主机的数量 主机的配置 CPU 内 存 硬盘 网卡 以及外设 打印机 扫描仪 绘图仪 诸如此类 1 2 3 其它 列出系统安装 运行所需的其它要求 用户手册模板用户手册模板 第 7 页 共 11 页 1 3 问题报告和获得帮助 说明用户反映系统问题以及获得帮助的途径 例如email 电话 在线帮助 诸如 此类 2 快速指南 本章可选 以一个或几个简单的功能为例 快速地把操作流程演示一遍 让用户对系统的界 面和功能有一个直观的印象 减少陌生感 本段篇幅应该尽量短少 几页就可能收到 不错的效果 描述的风格以用户界面截屏图以及菜单操作为主 3 系统安装 说明系统的安装流程 如果系统的安装前的准备工作对于不同的操作系统有特殊 的要求 那么就应该按不同的操作系统分别列出 例如 3 1 Windows 2003 3 2 Solaris 3 3 RedHat Linux AS4 3 1 windows 2003 下安装 用实际的操作系统名称来代替标题中 的操作系统名称 3 1 1 安装前准备 说明系统安装之前需要进行的准备工作 例如检查操作系统和应用程序的版本 硬盘的空间 用户在系统中的权限 环境变量的设置 诸如此类 3 1 2 安装 详细说明系统的整个安装过程 内容包括 编译 本条可选 如果系统是以源代码方式提供的 则说明如何编译成可执行 的安装程序 安装命令 例如菜单命令 命令行命令以及脚本命令等等 用户手册模板用户手册模板 第 8 页 共 11 页 安装过程中的交互 详细描述每一次交互的输入 输出以及所导致的系统状态的 改变 建议用GUI交互的应同时提供截屏图 用命令行交互的给出命令的完整输入 输出结果 3 1 3 安装验证测试 本条可选 说明安装完成以后 执行哪些测试操作来验证系统已经被正确安装 详细说明整 个验证流程和输出结果 3 2 Solaris 下安装 用实际的操作系统名称来代替标题中的操 作系统名称 3 2 1 安装前准备 3 2 2 安装 3 2 3 正确安装测试 本条可选 3 3 RedHat Linux AS4 下安装 用实际的操作系统名称来代替标 题中的操作系统名称 4 用户界面 本章可选 说明用户界面上的各个菜单项的内容和功能 对于没有用户界面的系统 例如后 台服务程序 则不需要在本段说明 如果系统可以在多个操作系统中使用 在不同的操作系统中的用户界面又不完全 一致 则对不一致的地方要单独说明 用户手册模板用户手册模板 第 9 页 共 11 页 4 1 简介 简单介绍用户界面的特性 4 2 开始使用系统 说明系统的启动方式 4 3 主窗口 扼要描述主窗口菜单的外观与布局 例如工具栏 状态栏的位置 文本编辑区的 布局 诸如此类 4 4 菜单 详细说明每个菜单的内容 功能以及包含的子菜单 说明的方式可以用对一个顶 层菜单完全展开的方式来说明 最好配以相应菜单的截屏图 4 4 1 文件 File 菜单 4 4 2 编辑 Edit 菜单 4 4 3 4 4 4 帮助 Help 菜单 5 使用 说明如何用本系统开始工作 针对每一项主要的任务 用户管理 数据管理等等 说明其工作的流程 如果系统可以在多个操作系统中使用 在不同的操作系统中的工作流程又不完全 一致 则对不一致的地方要单独说明 5 1 用户管理 5 1 1 用户登录 用户手册模板用户手册模板 第 10 页 共 11 页 5 1 2 新建用户 5 1 3 删除用户 5 2 数据管理 6 7 常见问题解决 列出系统曾经遇到过的常见的问题以及解决方案 如下示例 问题序号问题序号问题描述问题描述解决方案解决方案 1不能添加新用户检查你登录的身