软件使用手册编写规范

软件使用手册编写规范篇一：软件开发标准-用户手册编制规范用户手册编制规范 i 前 言用户手册对于任何产品都是不可缺少的组成部分。一个好的产品没有一份完备的用户手册，也不能算作一个完备的产品。对于软件产品来说更是如此，没有用户手册的软件不能算产品，没有好的用户手册，就不可能算好产品。也就是说，一个好的软件产品除了具备与市场对路的思想、良好的用户界面、完备的测试之外，还必须有一本适合用户使用的用户手册。 本规范手册不仅指明了软件用户手册的内容，而且规定了沈阳东大阿尔派软件股份有限公司软件用户手册的统一版面、格式。本规范手册就是按本规定编写的，但由于本规范手册内容的局限性，很难以样本的形式表现软件用户手册中可能出现的各种情况，所以请大家认真阅读本规范手册的内容。 我们希望沈阳东大阿尔派软件股份有限公司的相关人员，能够按照本规范手册编写自己的软件用户手册，做好我们的软件产品化工作。由于时间仓促，编者水平有限，希望大家能够提出宝贵意见，以逐步完善本规范手册的内容。 i 篇二：用户手册编写规范用户手册编写规范 文档标识：comtop-std-ugud 深圳市康拓普信息技术有限公司 Shenzhen Comtop Information Technology Co.,Ltd. 二六年十一月 修订记录 所有权声明： 深圳市康拓普信息技术有限公司 版权所有 不得复制 Copyright ? XX by Shenzhen Comtop Information Technology Co., Ltd. 目录1 2 3 目的 . 1 适用范围 . 1 编写规范 . 1 使用 ROBOHELP .1 编写规范 . 1 文件规范 .1 页面规范 .3 导出规范 . 4 1 目的 1. 使软件项目的用户手册编写工作有章可寻。 2. 使编写的用户手册更加完整和规范。 2 适用范围 深圳市康拓普信息技术有限公司的所有软件测试项目。3 编写规范 使用 RoboHelp 参见“Robohelp 编写在线帮助使用说明.doc” 。 文档存放位置：testSCMTEST GROUPTest Document6-Regulation TemplateSupportFile 编写规范 文件规范 1. 用户手册的文件名使用系统名称+下划线+UserGuide 组成。比如：技改科技修理项目管理系统的 用户手册文件名为：Itmpms_UserGuide。 2. 用户手册右上角的 RoboHelp 图标需改为公司名称（即：Comtop） 。 3. 用 RoboHelp 工具编写用户手册时必须使用标准模板。模板参见“template_” 。如 下图（二）的 Template 字段选择了已经定好的物资管理帮助文档模板。标准模板中的格式规定为：标题 14 号；注意标题 11 号加粗；概述、正文和注意事项均为 10 号字体；概述需首行缩进 2 个汉字，概述中的参见描述使用带圆点项目符号的正文格式；正文和注意事项之间需空一行，且格式为正文格式；概述、正文和注意事项的行间距均为：；模板中需去掉所有空格。 标准模板文档存放位置：testSCMTEST GROUPUser Guidetemplate user guide。 4. 用户手册的目录结构按照软件系统的菜单层次建立，如下图（一）的菜单层次所示。页面上的功 能名称在目录结构中的先后顺序按照该功能在系统中的主次排列。 图（一） 5. 新增一个页面的 Topic Title、File Name 和页面标题这 3 个名称必须保持一致。如下图（二）和 图（三）所示。 图（二） 篇三：软件需求规格说明书编写规范 项目名称：公司文档 文档名称：软件需求规格说明书编写规范 软 件 需 求 规 格 说 明 书 编 写 规 范 文档修订批准人签字 说明： 软件需求规格说明书应遵循用户需求规格说明书 （见用户需求规格说明书编写规范 ）编写，从编程的角度做出详细说明。 目 录 1 概述 . 5 目的 .5 项目背景 . 5 范围 . 5 术语定义 . 5 2 系统说明 . 6 3 软件需求说明 . 7 功能要求 .7 输入输出要求 . 7 故障处理要求 . 7 可用性 . 8 可靠性 .8 性能要求 .8 可维护性, 可扩展性 .9 灵活性 .9 安全性 .9 设计约束 .9 用户使用手册和在线帮助系统 . 10 界面要求 . 10 支持软件 .10 控制 .10 设备 . 10 其他要求 .11 4 验收标准 . 12 5 参考资料 .13 一、概述 在概述部分应对整个系统进行概要描述。通常还包括目的，范围，术语定义等。 目的 说明编写这份软件需求说明书的目的。 项目背景 说明： 1） 、待开发的软件系统的名称； 2） 、本项目的任务提出者、开发者、用户及实现该软件的计算机中心或计算机网络； 3） 、该软件系统