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

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

什么是文檔馬拉松？

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

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

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

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

在我的組織里，我們的文檔團(tuán)隊(duì)舉辦了一次文檔馬拉松，成功地修改了 102 頁(yè)的安裝指南。這次文檔馬拉松使我們能夠?qū)Ｗ⒂陧?xiàng)目的范圍，即重新組織簡(jiǎn)化，刪除重復(fù)的內(nèi)容，并遵循客戶(hù)旅程。舉辦文檔馬拉松給我的團(tuán)隊(duì)留下了深刻的印象，并提高了客戶(hù)的成功率。

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

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

1、減少積壓

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

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

2、改造大型指南

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

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

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

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

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

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

文檔馬拉松

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