為你的開源項目舉辦一場文檔馬拉松

文檔馬拉松是為你的開源項目製作或改進文檔的一個好方法。

你的開源項目的文檔對你的客戶至關重要。你的目標受眾必須了解你的項目的目的和如何使用它，而文檔是彌合這一差距的工具。一個項目很少有真正完成的時候，所以隨著你項目的不斷改進，資源的維護和更新同樣重要。

但是，當你有大量的文檔需要維護，但又缺乏資源來保持它的時效性時，會發生什麼？答案很簡單：舉辦一個 文檔馬拉松 docathon ！

什麼是文檔馬拉松？

文檔馬拉松就像 黑客馬拉松 hackathon 。黑客馬拉松是工程師和社區領袖聚集在一起改進或添加新功能到一個現有的應用的活動。在一個文檔馬拉松中，同樣的合作集中在改進文檔上。

文檔馬拉松可以填補內容上的空白，重組大型文檔集，修復失效的鏈接，或者只是糾正錯別字。舉辦文檔馬拉松的目的是為了在相對短的時間內改進大量的文檔。

一些產品文檔的例子包括：

• 培訓手冊
• 用戶手冊
• 安裝指南
• 故障排除指南
• 快速入門指南
• API 文檔
• 教程

在我的組織里，我們的文檔團隊舉辦了一次文檔馬拉松，成功地修改了 102 頁的安裝指南。這次文檔馬拉松使我們能夠專註於項目的範圍，即重新組織簡化，刪除重複的內容，並遵循客戶旅程。舉辦文檔馬拉松給我的團隊留下了深刻的印象，並提高了客戶的成功率。

3 件你可以通過文檔馬拉松實現的事情

以下是我舉辦文檔馬拉松的三大理由：

1、減少積壓

大多數文檔必須隨著它所支持的產品的發展而發展。隨著產品的變化或更新，文檔也必須如此。在某些情況下，文檔團隊與工程團隊的發布周期一起發布新版本的文檔。隨著團隊內優先順序的改變和 GA 發布 的繼續，文檔團隊面臨著跟上新功能、錯誤修復和任務完成的挑戰。被遺棄的變化成為積壓的一部分，一種需要在以後完成的工作的積累。

提示： 在文檔馬拉松期間，參與者可以對積壓的項目進行分流，並在列表中完成它們。非技術性的參與者可以從事與錯別字、失效的鏈接和其他文本相關問題的修復工作。

2、改造大型指南

當你的文檔團隊意識到是時候修改指南的時候，它可能已經有好幾章，好幾百頁了。一旦制定了內容計劃，重組的複雜性就開始了。重組大量的文檔並不適合膽小的人。

提示： 組建一個團隊來領導文檔馬拉松，並為不同團隊或部門的全組織參與提供獎勵。根據工作範圍和時間限制，你的團隊可以在比你預期更短的時間內成功重組整個指南。

3、跨職能團隊之間的合作

一個組織內的不同小組孤立地工作是很常見的。工程、產品、客戶支持、營銷和文檔團隊可能沒有像他們應該的那樣經常在項目上進行協作。

想像一下，舉辦一次活動，每個團隊成員都可以利用他們的專業知識來改善產品文檔。文檔馬拉松促進了主題專家（SME）的多樣性、實時協作和溝通。它們還允許一個包容性的環境，居住在不同地理位置的人可以親自或遠程參與。你的文件會得到具有不同觀點和專業的專家的關注，最大限度地減少孤立的孤島、無意識的偏見和倦怠。

提示： 使跨職能的團隊為了一個共同的事業走到一起。

文檔馬拉松

下一次，當你的團隊有一個似乎無法克服的積壓工作，或者被賦予重組一個巨大的文檔項目的任務時，考慮舉辦一個文檔馬拉松。這很容易，而且它的生產力可能會讓你吃驚。關於舉辦這樣的活動的更多信息，請閱讀 Tiffany Long 寫的很棒的 舉辦黑客馬拉松的 10 步指南。

（題圖：MJ/1284f6fb-91e9-4799-8773-ee7f51fd87c9）

via: https://opensource.com/article/23/4/open-source-docathon

作者：Lydie Modé-Malivert 選題：lkxed 譯者：geekpi 校對：wxy

本文由 LCTT 原創編譯，Linux中國 榮譽推出

本文轉載來自 Linux 中國: https://github.com/Linux-CN/archive