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

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

什么是文檔馬拉松？

文檔馬拉松就像 黑客馬拉松hackathon。黑客馬拉松是工程師和社區(qū)領(lǐng)袖聚集在一起改進(jìn)或添加新功能到一個現(xiàn)有的應(yīng)用的活動。在一個文檔馬拉松中，同樣的合作集中在改進(jìn)文檔上。

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

一些產(chǎn)品文檔的例子包括：

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

在我的組織里，我們的文檔團(tuán)隊舉辦了一次文檔馬拉松，成功地修改了 102 頁的安裝指南。這次文檔馬拉松使我們能夠?qū)Ｗ⒂陧椖康姆秶粗匦陆M織簡化，刪除重復(fù)的內(nèi)容，并遵循客戶旅程。舉辦文檔馬拉松給我的團(tuán)隊留下了深刻的印象，并提高了客戶的成功率。

3 件你可以通過文檔馬拉松實現(xiàn)的事情

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

1、減少積壓

大多數(shù)文檔必須隨著它所支持的產(chǎn)品的發(fā)展而發(fā)展。隨著產(chǎn)品的變化或更新，文檔也必須如此。在某些情況下，文檔團(tuán)隊與工程團(tuán)隊的發(fā)布周期一起發(fā)布新版本的文檔。隨著團(tuán)隊內(nèi)優(yōu)先級的改變和 GA 發(fā)布 的繼續(xù)，文檔團(tuán)隊面臨著跟上新功能、錯誤修復(fù)和任務(wù)完成的挑戰(zhàn)。被遺棄的變化成為積壓的一部分，一種需要在以后完成的工作的積累。

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

2、改造大型指南

當(dāng)你的文檔團(tuán)隊意識到是時候修改指南的時候，它可能已經(jīng)有好幾章，好幾百頁了。一旦制定了內(nèi)容計劃，重組的復(fù)雜性就開始了。重組大量的文檔并不適合膽小的人。

提示： 組建一個團(tuán)隊來領(lǐng)導(dǎo)文檔馬拉松，并為不同團(tuán)隊或部門的全組織參與提供獎勵。根據(jù)工作范圍和時間限制，你的團(tuán)隊可以在比你預(yù)期更短的時間內(nèi)成功重組整個指南。

3、跨職能團(tuán)隊之間的合作

一個組織內(nèi)的不同小組孤立地工作是很常見的。工程、產(chǎn)品、客戶支持、營銷和文檔團(tuán)隊可能沒有像他們應(yīng)該的那樣經(jīng)常在項目上進(jìn)行協(xié)作。

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

提示： 使跨職能的團(tuán)隊為了一個共同的事業(yè)走到一起。

文檔馬拉松

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