为你的开源项目举办文档马拉松的 3 个理由

你开源项目的文档对你的客户至关重要。你的目标受众必须了解你项目的目的以及如何使用它，而文档是弥合这一差距的桥梁。一个项目很少真正完成，因此，资源需要随着项目的持续改进而维护和更新也同样重要。

但是，当你有很多文档需要维护但缺乏资源来保持其最新状态时会发生什么？答案很简单：举办文档马拉松！

什么是文档马拉松？

文档马拉松就像黑客马拉松。黑客马拉松是一项活动，工程师和社区领导者聚集在一起以改进现有应用程序或向其添加新功能。在文档马拉松中，同样的协作侧重于改进文档。

[ 了解有关编写 代码即文档的信息。 ]

文档马拉松可以填补内容中的空白、重组大型文档集、修复断开的链接，或者只是更正错别字。举办文档马拉松的目的是在相对较短的时间内改进大量文档。

产品文档的一些示例包括

• 培训手册
• 用户手册
• 安装指南
• 故障排除指南
• 快速入门指南
• API 文档
• 教程

在我的组织中，我们的文档团队举办了一次文档马拉松，并成功地改造了一份 102 页的安装指南。文档马拉松使我们能够专注于项目的范围，即为了简洁性而重新组织、删除重复内容以及遵循客户旅程。举办文档马拉松给我的团队留下了持久的印象，并提高了客户的成功率。

[ 阅读 编写真正适合你社区的文档 ]

通过文档马拉松可以实现的 3 件事

以下是我举办文档马拉松的三个主要理由

1. 不再有积压工作

大多数文档必须随着其支持的产品一起发展。随着产品更改或更新，文档也必须如此。在某些情况下，文档团队会在工程团队的发布周期旁边发布新版本的文档。随着团队内部优先事项的变更和 GA 版本 的持续发布，文档团队面临着跟上新功能、错误修复和要完成的任务的挑战。被遗忘的更改会成为积压工作的一部分——需要在以后完成的工作积累。

文档马拉松技巧：在文档马拉松期间，参与者可以对积压工作项进行分类，并在列表中的进展过程中完成它们。非技术参与者可以处理与错别字、断开的链接和其他与文本相关的问题相关的修复。

2. 改造大型指南

当你的文档团队意识到是时候改造指南时，它可能已经深入到多个章节和数百页。一旦内容计划制定完成，重组的复杂性就开始了。重组大量文档并非易事。

文档马拉松技巧：组建一个团队来领导文档马拉松，并为来自不同团队或部门的全组织参与提供激励。根据工作范围和时间限制，你的团队可以在比你可能预期的更短的时间内成功地重组整个指南。

3. 跨职能团队之间的协作

组织内不同的团队孤立地工作是很常见的。工程、产品、客户支持、营销和文档团队可能没有像他们应该做的那样经常在项目上进行协作。

想象一下举办一个活动，每个团队成员都可以利用他们的专业知识来改进产品文档。文档马拉松促进了主题 matter 专家 (SME) 的多样性、实时协作和沟通。它们还允许创建一个包容性的环境，让居住在不同地理位置的个人可以亲自或远程参与。你的文档获得了来自具有不同观点和专业知识的专家的全神贯注，从而最大限度地减少了孤立的孤岛、无意识的偏见和倦怠。

文档马拉松技巧：使跨职能团队能够为了共同的目标走到一起。

[ 了解 构建弹性 IT 文化 需要什么 ]

文档马拉松

下次你的团队遇到看似无法克服的积压工作或被赋予重组大型文档项目的任务时，请考虑举办文档马拉松。它很容易，而且它的生产力可能会让你感到惊讶。有关举办此类活动的更多信息，请阅读 Tiffany Long 撰写的优秀 举办黑客马拉松的 10 步指南。