标准摘要
[中文适用范围]: 本条款介绍了本国际标准的范围、目的、组织和候选用途。 该国际标准支持软件用户对一致、完整、准确和可用文档的兴趣。 它包括两种标准化方法: a) 过程标准,指定文档产品的开发方式; b) 文件产品标准,规定文件的特征和功能要求。 本国际标准的第一部分涵盖了文档设计者和开发者的用户文档流程。 它描述了如何确定用户需要什么信息,如何确定向用户呈现该信息的方式,以及如何准备信息并使其可用。 它不仅限于生命周期的设计和开发阶段,还包括整个信息管理和文档流程的活动。 本国际标准的第二部分规定了用户文档的结构、信息内容和格式的最低要求,包括包含软件的系统的用户在工作环境中使用的打印文档和屏幕文档。 它适用于印刷版用户手册、在线帮助、教程和用户参考文档。 本国际标准既不鼓励也不阻止使用印刷或电子(屏幕)媒体进行文档记录,也不鼓励使用特定的文档开发或管理工具或方法。 本国际标准可能有助于开发以下类型的文档,尽管它没有涵盖它们的所有方面:〜软件以外的产品文档; ~ 使用动画、视频和声音的多媒体系统; ~ 主要用于正式培训计划的计算机培训 (CBT) 包和专业课程材料; ~ 为非最终用户的安装人员、计算机操作员或系统管理员制作的文档; ~ 描述系统软件内部操作的维护文档; ~ 文档合并到用户界面本身中。 专家:〜信息设计师和架构师,他们规划文档集中文档产品的结构和格式; ~ 可用性专家和业务分析师,他们确定目标用户使用软件执行的任务: ~ 开发和编辑用户文档书面内容的人员; ~ 具有电子媒体专业知识的平面设计师; ~ 用户界面设计师和人体工程学专家共同设计文档在屏幕上的呈现方式。 文档过程中具有其他角色和兴趣的人员也可以参考本国际标准: ~ 软件开发过程或文档过程的管理者; ~ 供应商准备的文件的获取者; ~ 可用性测试人员、文档审阅人员、主题专家; ~ 创建屏幕文档工具的开发人员; ~ 人为因素专家,他们确定使文档更易于访问和使用的原则。 本国际标准适用于所有类型的组织,无论是否有专门的文档部门,并且可以用作当地标准和程序的基础。 假定读者具有软件开发或文档开发过程的经验或知识。 本国际标准的用户应采用在其组织内使用的风格手册,以补充本国际标准附件中提供的指南,或采用行业认可的风格指南。 附件 A 提供了风格指南的内容指导,附件 B 和 C 提供了风格指南。 [外文原描述]: ISO/IEC 26514:2008 provides requirements for the design and development of software user documentation as part of the life cycle processes. It defines the documentation process from the viewpoint of the documentation developer. ISO/IEC 26514:2008 also covers the documentation product. It specifies the structure, content, and format for user documentation, and also provides informative guidance for user documentation style. It is independent of the software tools that may be used to produce documentation, and applies to both printed documentation and on-screen documentation. Much of ISO/IEC 26514:2008 is also applicable to user documentation for systems including hardware.
英文名称Systems and software engineering - Requirements for designers and developers of user documentation