6.12文档工具

文档工具旨在支持软件架构师和开发人员对决策、结构、概念和其他信息进行长期的交流。这一工具类别包括用于开发、维护和生成文档的基于文本和图形的工具。

6.12.1需求和决策标准

• 适合于用户组/项目团队 • 不同文档版本或状态的比较 • 与版本和配置管理的集成 • 最终文档符合公司或组织的标准（例如，符合公司布局或公司设计） • 能够生成特定于利益相关者的文档 • 文档与软件的发布或版本的简单同步 • 与缺陷或问题跟踪系统的集成

6.12.2文档工具面临的挑战

• 版本管理 • 多用户能力，特别是冲突处理(对于大多数文本处理系统，简单的源代码操作如差异比较或合并是一个主要问题) • 为特定目标群体生成印刷和电子格式的结果。这些考虑包括布局和格式要求（如企业形象或企业设计）、自动生成目录和关键字索引、符合文档标准。 • 避免冗余。所有信息能够在单个位置进行维护是至关重要的。从源代码通过模型（图表）到文档的过渡仍然很棘手，但所谓的“单源”方法正在试图解决这个问题。

6.12.3Examples

• 来自不同供应商的经典文本处理(“office”产品) • 基于标记的方法(DocBook, DITA, SGML, MarkDown, Textile, XHTML)，使用特殊字符/字符串在文本中嵌入格式和语义信息 • 维基(有很多开源维基，如TWiki, Mediawiki，和TiddlyWiki(支持离线) • Confluence Team Collaboration（Atlassian） • 许多建模工具可以从其数据库/存储库中生成文档。