浪潮集团通用软件用户手册编制规范
版权申诉
82 浏览量
更新于2024-07-01
收藏 444KB DOC 举报
"某软件公司用户手册编制规范标准.doc"
该文档是针对浪潮集团通用软件公司产品用户手册编制的一份详细规范,旨在为公司内部的设计人员、编程人员、文档编制人员和其他相关人员提供统一的编写标准。这份规范强调了文档的重要性和适用范围,并列出了相关的术语定义和参考资料。
1. 引言
- 目的:制定本规范的目的是为了提供给用户一系列详尽的文档,用于参考、培训和辅助软件销售。
- 范围:规范覆盖了用户手册的类型、大纲、风格、顺序和审核流程,适用于所有参与文档制作的人员。
1.3 术语定义
- 文档中可能包含特定的行业或系统术语,需要在合适的位置进行清晰的定义,确保用户理解。
1.4 参考资料
- 提到了“国强财务软件6.0产品用户手册编写指南V1.3”作为参考,表明公司可能参考了该指南来制定自己的规范。
1.5 版序控制记录
- 这部分记录了文档版本的变化状态,包括起草、审核、批准和发布日期等关键环节。
1.6 版本更新记录
- 提供了一个表格来跟踪文档的修改情况,包括增加(A)、修改(M)和删除(D)等操作,以及对应的修改人和日期。
2. 编制大纲
- 编写要求:要求文档风格统一,使用Word作为编制工具,功能描述需完整无歧义,语言简洁准确,并且编写格式一致。
- 用户使用手册和用户安装手册的大纲分别列出,包括前言、功能介绍、附录等内容,以及安装与配置的详细步骤。
- 系统管理员手册的大纲也进行了规定,涵盖类似的内容但更倾向于系统管理和维护。
3. 编写原则
- 可能涉及文档的完整性、一致性、易读性以及技术准确性等方面的指导原则。
4. 审核鉴定
- 描述了文档完成后的审核流程,确保内容的质量和合规性。
这份规范文档对于确保软件用户手册的专业性和用户友好性至关重要,它指导了从内容组织、表述方式到文档版本管理的全过程,以达到提高用户理解和使用软件的效率,提升产品形象和市场竞争力的目标。
2021-09-21 上传
2022-12-18 上传
2022-11-23 上传
2022-07-12 上传
2021-09-25 上传
2021-10-01 上传
智慧安全方案
- 粉丝: 3814
- 资源: 59万+
最新资源
- 深入浅出:自定义 Grunt 任务的实践指南
- 网络物理突变工具的多点路径规划实现与分析
- multifeed: 实现多作者间的超核心共享与同步技术
- C++商品交易系统实习项目详细要求
- macOS系统Python模块whl包安装教程
- 掌握fullstackJS:构建React框架与快速开发应用
- React-Purify: 实现React组件纯净方法的工具介绍
- deck.js:构建现代HTML演示的JavaScript库
- nunn:现代C++17实现的机器学习库开源项目
- Python安装包 Acquisition-4.12-cp35-cp35m-win_amd64.whl.zip 使用说明
- Amaranthus-tuberculatus基因组分析脚本集
- Ubuntu 12.04下Realtek RTL8821AE驱动的向后移植指南
- 掌握Jest环境下的最新jsdom功能
- CAGI Toolkit:开源Asterisk PBX的AGI应用开发
- MyDropDemo: 体验QGraphicsView的拖放功能
- 远程FPGA平台上的Quartus II17.1 LCD色块闪烁现象解析