DITA文档方法和敏捷流程相互契合的十大理由

 ▲ 搜索“大龙谈智能内容”关注公众号▲ 

敏捷开发方法（Agile Methodologies）起始于软件产品开发领域。它以用户的需求进化为核心，采用迭代、循序渐进的方法进行开发。自从它被证明在软件产品开发领域有效后，在各行业产品研发中得到学习和应用。

比如，在竞争激烈的汽车行业，以前是5年时间设计一辆车，现在变成要在18月内设计一辆车。传统的ASPICE制定的流程在新的形式下很难直接应用，车厂纷纷进行敏捷流程改良。

在使用敏捷开发方法的软件研发领域，有文档工程师跟我说他们的文档和产品界面很难对得上，因为软件界面在持续变化，文档很难跟上。  

如今，各行业都在推行的敏捷流程，那么文档怎样跟上节奏呢？来看看Keith对敏捷流程和DITA文档方法的思考和分析。 

他原文发表在TCWorld杂志：

https://www.tcworld.info/e-magazine/technical-writing/ten-reasons-why-dita-and-agile-are-made-for-each-other-755/

作者 | Keith Schengili-Roberts

1. DITA中基于主题的方法有助于敏捷中的增量开发

DITA的原则之一是内容重用，鼓励文档工程师“一次编写，多次使用”。这也意味着不需要重写已经存在的内容，得益于DITA中的重用机制，作者可以简单地重用其他地方已经写好的整个主题、段落或短语。这使文档工程师能够轻松跟上快节奏开发的步伐。

2. 敏捷用户故事与DITA中的任务主题类型很好地对应

基于Scrum的敏捷经常需要用户故事（user story）来帮助制定开发工作。用户故事通常采用用户想要完成某个任务的形式来编写。比如：

作为“公司的运营”，我想要“看到新注册的用户数”，以便于“统计产品拉新的效果”。

这种格式和DITA任务（Task）主题类型非常契合。在采访敏捷团队工作的DITA文档工程师时，我发现一个他们常见的做法是将概念封装为任务的上下文，而不是编写单独的概念（Concept）和任务（Task）主题。

此外，敏捷开发中的“Epic”是相关用户故事的集合，构成了一类用户的完整工作。从DITA的角度来看，当存在用户故事层次结构时，Epic可用于帮助完善基于读者的内容条件处理，或bookmap中的章节。

DITA 1.3中添加了新主题类型troubleshooting，用于为可能出现的情况提供具体的解决方案，以及如何解决这些问题。这种新的DITA主题类型非常适合描述排除故障类型的用户故事，因为在这些用户故事中，任务可能不是合适的主题类型。

3. DITA最佳实践主张内容完全以用户为中心

文档工程师能够通过积极使用产品提供产品的早期反馈。通过这种方式，文档工程师往往成为用户的拥护者；这反过来又有助于定义真实的用户故事。

内容在多个版本上的不断变化和迭代迫使文档工程师的思维方式从“记录所有内容”转变为“只记录用户需要的内容”。同样，DITA基于主题的粒度特性有助于实现这一点。

4. 可以计算单个主题，以便文档项目度量

在一个典型的基于Scrum的敏捷环境中，参与项目的每个人都会聚集在一起，定期在会议上讨论进展情况。

使用传统的基于DTP（桌面出版）的方法，通常可以报告的只是字数或自上次sprint以来完成的章节数。

使用DITA，可以将开发特性与单个主题相匹配，从而更容易以更现实的方式报告文档进度。如果使用CCMS，也可以在Scrum会议上度量和报告工作流状态，如：草稿、审阅中、完成等。

5. DITA的极简主义最佳实践减少了“浪费”

精益管理的关键理念之一是尽可能减少浪费。在日语中使用术语“muda”表达这个意思。在文档中，这指的是客户使用产品时不必要的内容。

它用于检查文档工程师是否编写了“填充符”（通常是用户为了完成产品的特定任务或操作而不需要的背景或市场相关内容）。

DITA的哲学基础之一是极简主义它同样告诉文档工程师要把内容精简到最基本的部分。

6. 主题重用提高了内容一致性

DITA中的各种内容重用机制（topic、conref和key）有助于提高敏捷环境中生成的文档输出的一致性。

由于敏捷环境中的截止日期较短且时间有限，文档工程师更适合重用现有内容，而DITA提供了实现这一点的简单机制。

在许多业务环境中，如果您有一个主题，并且该主题已经过审核和批准，并且您希望在其他地方重用它，则不必再次发送该主题以供审核，因为它已经完成了。

例外是管控环境，其中所有内容都必须在上下文中进行审核，但即使在这种情况下，内容重用也会加快审批过程。

7. 内容与格式的分离节省了时间

由于DITA中内置的内容和格式的分离，文档工程师可以专注于创建内容而不是调整格式，这可以节省大量时间。

几年前，我对一组文档工程师进行了一项非正式调查，他们使用一种流行的桌面出版软件来制作文档，结果显示，他们大约有一半的时间花在格式调整上。

现在在基于DITA的环境中，他们可以把时间花在编写更多敏捷内容上。同时，这也消除了业务专家对格式提出意见的需要。

8. 敏捷鼓励持续反馈；基于主题的审核更容易

对于开发人员来说，审核主题比审核DTP工具生成的章节更容易，从而缩短了审核时间。通过这种方式，文档还可以支持团队、客户、审计流程等之间更广泛的沟通。

要提高工作效率，文档反馈很关键。

我采访过的一位文档工程师告诉我，敏捷开发人员“没有拖延的余地，所以对他们来说，这是从自己的任务清单中勾掉这个任务的一种简单方法。

9. DITA简短描述将用户引导到内容

编写DITA主题的简短描述已被视为最佳实践，对于基于敏捷的内容来说更是如此，因为它为用户在搜索信息时提供了一种逐步披露内容相关性的方法。

通常，简短的描述可以类似于敏捷用户故事的意图，其中：“用户x可以基于z做y”。

10. DITA使按需发布多种格式变得简单

DITA Open Toolkit是为输出多种格式文档而设计，包括HTML、WebHelp和PDF。还可以根据需要在章节或单个主题级别灵活输出文档。在基于DITA的流程中，等待文档交付很少是一个瓶颈。