GitHub 剛剛發布了《2017 開源調查》報告，這家知名編程社交網站走訪了 github.com 社區內 3800 多個項目和超過 5500 名成員，并且與 500 名在 GitHub 項目生態系統之外的編程者們進行了交談。本次調查涉及多方面，比如人們在為開源項目做開發、做貢獻時遇到的問題，結果有 93% 的人對“不完整或令人困惑的文檔”感到非常沮喪。

然而這沒能出乎我們的意料，因為 GitHub 上確實有許多描述很稀疏的項目，缺乏如何去使用它們的知道。如果你的腦實力不夠強大，肯定會獨自栽在這上面。

很遺憾，很多碼農忽視了文檔對一個項目取得成功的重要性。科技作者 Mike Pope 曾經如此總結文檔的需求：

我們需要告訴開發者，‘缺了文檔，就等于廢了項目’！（If it isn’t documented, it doesn’t exist.）

你不僅必須寫文檔，還得在其中好好解釋、教導和示范。這樣的話，大家都會很高興的。這不僅關乎你的文檔，也關乎你的產品！

此外，Stack Overflow 創始人?Jeff Attwood、以及 JavaScript 開發者 Nicholas Zakas，也都在博文中強調過文檔的重要性。

GitHub《2017 開源調查》中排名靠前的幾個問題，在“文檔不完整或困惑”之后，分別是“不回應”、“不屑”、“沖突”、“不明原因的拒絕”、以及“不歡迎的語言或內容”。

GitHub 在調查中強調：“文檔有助于營造一個包容性的社區，清楚地解釋了一個項目的過程，比如貢獻指南和行為準則，大家會很珍視這樣的開源工作、但它往往被低估”。

調查還指出，高達 60% 的貢獻者很少或從未對文檔提供過幫助。

原文地址：http://www.cnbeta.com/articles/soft/618585.htm

---

.NET社區新聞，深度好文，微信中搜索dotNET跨平臺或掃描二維碼關注

總結

以上是生活随笔為你收集整理的码农不重视文档：开源项目深受其苦的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。