17、软件文档可通信性框架解析

软件文档可通信性框架解析

1. 引言

在软件开发中，沟通起着核心作用，而文档则是软件项目通信基础设施中的信息载体。随着软件开发从预测性环境转向适应性环境，并且要服务于硬件更加多样化的用户群体，新的通信挑战也随之出现。例如，工程师希望能在 shell 环境中远程编写文档，无需特殊软件，还能将文档移植到不同计算机架构，并为用户提供不同视图而无需修改原文。然而，当前软件文档的现状无法满足这些期望。

2. 背景

自软件诞生以及软件工程成为一门学科以来，文档就一直扮演着重要角色。过去，表达软件文档有多种方式，如结构化自然语言文本、富文本格式（RTF）、超文本标记语言（HTML）、便携式文档格式（PDF）以及 TEX/LATEX 等。但这些传统方式存在诸多局限：
- 具有专有性，只能由专有软件编写或渲染。
- 重点不在软件工程，而在通用办公或科学用途等其他领域。
- 主要关注展示或处理，而非表示。

描述性标记基于有序层次的内容对象（OHCO）模型，为文档赋予层次结构。标准通用标记语言（SGML）及其简化版可扩展标记语言（XML）是描述性标记的典范。它们为软件文档中的信息表达提供了具体的序列化语法，以助记名称定义文档的 OHCO 结构。基于 SGML/XML 的标记语言数量众多且不断增加，本文主要聚焦于 XML。

3. 软件文档的表达

从生产者和消费者两个角度来看，软件文档的表示有以下要求：
- 生产者的可通信性关注点 ：负责内外文档的生产者可能关注以下方面：
- 能很好地表达所考虑的领域。
- 具有以不同方式编写和提供文档的灵活