文档详情

用户手册编写.doc

发布:2018-12-11约5.87千字共12页下载文档
文本预览下载声明
密级:内部公开 { 项目名称 } 用户手册编写指南 项目编号 文件编号 SXW_TS_UM_V5.0 记录号 项目编号_TS_UM 版本号 可以是日期 正文页数 附件个数 (项目经理)批准/日期: 文件修订记录 版本号 变化状态* 简要说明 (变更内容和变更范围) 变更日期 变更人 *变化状态:C―创建,A—增加,M—修改,D—删除 文件审批信息 版本号 审批人 角色 审批意见 签字 审批日期 注:蓝色斜体部分为注释或举例,实际使用时请去掉。 版权声明 [版权声明是保护我们所开发软件的产权、不使公司利益受到损害的一种方式。在版权声明中应该包括以下内容: 1. 对我们所提供的软件及用户手册的保护声明 2. 对我们的软件及商标所有权的声明 3. 对我们的用户手册中所提到的各种商标的版权声明 4. 我们不对用户因为使用我们的软件所造成的损失负责的声明] 前 言 文档目标 通过阅读该用户手册,用户应该或能够达到什么目标。 阅读对象 说明谁应该阅读本手册,或谁应该阅读本手册的哪些部分。 关于本手册 如果本系统的用户手册(包括管理员手册、参考手册等)由多份文档组成,则首先应该分别简要介绍这些手册的情况。然后分别介绍本手册在每一章所要描述的内容。有助于用户阅读和理解本手册的相关文档资源,也可以在本段中特别指明。 文档约定 说明文档中字体体例,用什么字体代表什么意义。例如:黑体(粗)代表命令,黑体(常规)代表命令参数等等。 说明文档中的符号代表何种意义。例如:代表提醒等。 缩略语和术语 列出本文档涉及的缩略语和术语,并扼要解释。如果篇幅较大,则可以以附录和引用文件的形式给出。 如何获得最新版本 说明获得本手册最新版本的途径。 用户反馈 列出用户通过什么途径,提交对产品手册的意见。 目 录 TOC \o 1-3 \h \z \u HYPERLINK \l _Toc142447620 1 简介 PAGEREF _Toc142447620 \h 7 HYPERLINK \l _Toc142447621 1.1 XX系统描述 PAGEREF _Toc142447621 \h 7 HYPERLINK \l _Toc142447622 1.1.1 XX系统的用途 PAGEREF _Toc142447622 \h 7 HYPERLINK \l _Toc142447623 1.1.2 系统主要特性 PAGEREF _Toc142447623 \h 7 HYPERLINK \l _Toc142447624 1.1.3 XX系统不能胜任的工作(本条可选) PAGEREF _Toc142447624 \h 7 HYPERLINK \l _Toc142447625 1.2 安装、运行环境 PAGEREF _Toc142447625 \h 7 HYPERLINK \l _Toc142447626 1.2.1 软件环境 PAGEREF _Toc142447626 \h 7 HYPERLINK \l _Toc142447627 1.2.2 硬件环境 PAGEREF _Toc142447627 \h 7 HYPERLINK \l _Toc142447628 1.2.3 其它 PAGEREF _Toc142447628 \h 7 HYPERLINK \l _Toc142447629 1.3 问题报告和获得帮助 PAGEREF _Toc142447629 \h 8 HYPERLINK \l _Toc142447630 2 快速指南(本章可选) PAGEREF _Toc142447630 \h 8 HYPERLINK \l _Toc142447631 3 系统安装 PAGEREF _Toc142447631 \h 8 HYPERLINK \l _Toc142447632 3.1 windows 2003下安装(用实际的操作系统名称来代替标题中的操作系统名称) PAGEREF _Toc142447632 \h 8 HYPERLINK \l _Toc142447633 3.1.1 安装前准备 PAGEREF _Toc142447633 \h 8 HYPERLINK \l _Toc142447634 3.1.2 安装 PAGEREF _Toc142447634 \h 8 HYPERLINK \l _Toc142447635 3.1.3 安装验证测试(本条可选) PAGEREF _Toc142447635 \h 9 HYPERLINK \l _Toc142447636 3.2 Solaris下安装(用实际的操作系统名称来代替标题中的操作系统名称) PAGER
显示全部
相似文档