在线帮助说明书(GoldNT-SPI-TS-Tem-OnlineHelp-V1.0).docVIP

在线帮助说明书 深圳市XXX软件有限公司 　　　　　 　　　　　　　　　　　 　第 PAGE 4页 共4页 镇江金钛软件有限公司　 文件类别：模板 文件版本：1.0 文件编号: GoldNT-SPI-TS-Tem-OnlineHelp 深圳市XXX软件有限公司 在线帮助说明书 受控状态： 受控 文件标题 文档编号 GoldNT-SPI-TS-Tem-OnlineHelp 在线帮助说明书 当前版本 1.0 生效日期 2006.05.19 深圳市XXX软件有限公司 第 PAGE 1页 共4页 文档密级：普通 文档状态：[ ] 草案 [√]正式发布 [ ]正在修订 变更履历 序号 版本 变更描述 修订人/日期 审核/日期 批准/日期 0.2 初定草稿 1.0 发布 目 录 TOC \o 1-3 \h \z 1. 前言 3 1.1 编写目的 3 1.2 背景 3 1.3 定义 3 2. 项目（产品）描述 3 3. 运行环境 3 4. 功能说明 3 4.1 功能简介 3 4.2 使用技巧 3 4.3 故障排除 3 4.4 病毒/修复 4 5. 常见问题列表 4 前言 编写目的 向操作人员提供该软件每一个运行的具体过程的有关知识。描述该软件系统所具有的 功能及基本的使用方法，使用户了解该软件的用途，正确使用它。 背景 配合落实海康公司规范软件项目开发目标。 定义 项目（产品）描述 对于所开发的项目或软件产品进行综合的描述，描述内括：项目（产品）的简介，开发产品的简介，产品功能总体描述等； 运行环境 对于所开发产品的硬件环境、支撑软件或数据结构等相关信息进行说明。同时列出系统运行的推荐配置。 功能说明 功能简介 介绍应用系统或软件产品的特点和各模块的详细功能。 使用技巧 介绍应用系统或软件产品的使用技巧，如系统最佳配置，快速备份数据库等。 故障排除 对于软件使用过程中或与操作系统之间可能出现的故障，提供解决问题的方法，帮助用户处理相关问题。保证用户系统的正常使用。 病毒/修复 为用户提出发现计算机病毒的解决方法，推荐杀毒软件和补丁升级。同时为用户提供数据遭计算机病毒破坏后的恢复方法，尽量减少用户的损失。 常见问题列表 在线帮助过程中及产品中常见的问题明细列出，予以读者注意。 在线帮助方式（说明） 为了更好的为产品用户服务，同时为了更方便的使用户使用在线帮助系统。根据公司软件产品和项目类型的不同，采用以下三种方式。 网站类产品或项目在线帮助文档采用静态页面设计，并在海康公司网站上发布。用户使用时可以连接到路上访问并解决相关的问题。 表现形式我列出了两种，其他方式正在考虑： 一是采用问题方式来提出问题和解决问题。形式是一问一答方式。好处是用户发现问题可以直接查找同类问题，并得到解决方法。特点是便于交流。 二是列出常见问题和技术问题。问题主要以文章或使用技巧为主。可能面对专业用户，如管理员。缺点是缺少用户交流。 应用项目类产品在线帮助系统采用微软帮助系统（.CHM文件），绑定到软件中，方便无法时时在线的用户。同时根据产品出现的问题，定期更新，并在海康公司网站上提供下载。 办公自动化类产品在线帮助系统。C/S版采用LOTUS NOTES内嵌的帮助工具来完成。绑定到程序中。不论用户是否在线都可以随时使用。B/S版可以采用与C/S版相同的方法，也可以采用与网站类产品相同的方法来实现。