ISO/IEC IEEE 26514：软件工程 — 用户文档设计者和开发者的要求

ISO/IEC IEEE 26514规定了软件产品用户文档设计和开发的要求。它提供了一种结构化的方法，将原始产品信息转化为组织良好、以用户为中心的文档，使用户能够有效地安装、学习、使用和维护软件产品。该标准是创建用户文档的技术沟通者的核心参考，定义了应指导文档开发活动的流程、技术和质量标准。

信息设计与架构

文档开发的设计阶段从信息架构开始——即支持用户任务和信息检索的内容结构组织。标准要求设计者分析用户任务，识别执行每个任务所需的信息，并将该信息组织成连贯的结构。该结构通常表示为主题层次结构或信息映射，显示不同内容元素之间的关系，并定义用户将遵循的导航路径。

标准倡导模块化的内容设计方法，其中文档由离散的、自包含的主题组成，而不是连续的叙述性散文。每个主题应服务于单一目的——概念、任务、参考或故障排除指导——并且应在不要求用户阅读前面主题的情况下可理解。这种模块化方法有时称为”基于主题的创作”，支持从单一来源生成多种输出格式（打印PDF、在线帮助、嵌入式帮助），实现跨多个产品的内容重用，并通过减少内容元素之间的相互依赖关系促进翻译和本地化。

内容开发标准与写作

标准为内容开发过程本身建立了全面的要求。每个文档项目应有记录在案的风格指南，定义：术语标准、语法和标点惯例、插图和截图的图形标准、表示用户界面元素的排版惯例、内容的可访问性要求，以及本地化和翻译考虑因素。风格指南确保文档间的一致性，特别是在多个作者贡献同一文档集时。

26514中的写作要求既涉及宏观层面（文档结构、标题、信息分组）也涉及微观层面（句子构造、术语、交叉引用）。标准强调根据目标受众的阅读水平和技术背景进行写作，为程序性内容使用主动语态和祈使语气，为抽象概念提供具体示例，并确保每个句子为读者增加价值。标准还涉及视觉沟通——使用图表、截图、表格和其他视觉元素比纯文本更有效地传达信息。

输出生产与交付格式

标准认识到用户文档必须以适合用户使用环境的格式交付。要求包括：以至少一种持久格式（如PDF用于打印）和一种可导航格式（如HTML用于在线浏览）生成文档，支持相关法规要求的可访问性功能，为电子格式提供搜索功能，确保格式和布局不掩盖内容含义，以及在所有文档交付物中保持一致的品牌和视觉标识。

对于在线文档，标准特别要求注意超链接的清晰性（链接应描述其目标）、导航一致性（类似内容应通过类似的导航路径可访问）、响应式设计（文档必须在不同屏幕尺寸和设备上可用）以及搜索优化（内容应结构化以支持有效的搜索引擎索引和检索）。标准还涉及嵌入式帮助日益增长的重要性——在需要时出现在软件界面内的上下文帮助——作为传统独立文档的补充。

常见问题