1樓：果凍蝦仁
哈哈。難道README教科書不是我這個repo嗎？
截止2019.8.31，4200+Star，5400+Forkgithub搜尋readme，排名第二，比第一名github官方repo只差400star。
1700+pv，850+uv。應該只包含了登入了github的使用者，不太清楚。
看一眼refer：
再看一下fork記錄樹：
Woah, this network is huge! We』re showing only some of this network』s repositories.
2樓：我是老尚
README就是專案的說明書，包括為什麼用？怎麼用？怎麼安裝之類的，貢獻者都有誰，
具體可以看看這裡，
GitHub 漫遊指南
其實，我覺得就把時間、地點、人物、事件，這四要素寫清楚，也就可以了。
3樓：吳乎
brpc，看完後對rpc和分布式系統的理解提公升了乙個層面，知識面覆蓋記憶體模型、執行緒模型、負載均衡、分布式系統等一系列知識。認真研讀，內功能提公升不少。強推！
4樓：MasterPa
我感覺我們自己這個還可以，如果你的開源專案也需要雙語的話可以參考：
generalized-intelligence/GAAS
5樓：賴信濤
openresty/nginx-lua 的所有專案和非官方專案，都堪稱教科書。
基本上和這個相關的專案，README 即文件，有明確的 Synopsis 你一看就知道是幹啥的，後面有 TOC，然後每乙個介面的解釋。不知道怎麼做到的，感覺搞這東西的開發者素質真是搞啊。
舉幾個專案：
6樓：TANG
看了下其他回答，補充乙個沒提到的點吧：如果是內容比較多的文件式 README，最好將內容做下細緻的分類，然後最好在最前面把 hash 目錄寫上，以便查閱的人不需要滾動能快速定位到需要的地方，比如：
貼兩個個人覺得比較不錯的倉庫：
7樓：地鐵風
其實寫 README 和寫其他文學/文件一樣，無非就是那 5W + 1H（這個好像是新聞學裡的說法？）。
5W: What, When, Where, Who, Why1H: How
換乙個不那麼高大上的，人人都知道：時間地點人物，起因經過結果。這些都交代清楚了，自然就是個好文件，萬變不離其宗。小學語文。
這個原則不僅適用於寫作，還適用於其它一些領域，比如管理文件時如何貼 tag。
8樓：程式設計師吳師兄
安利一下這幾天剛寫的乙個README，目前收穫600starhttps://
介面還算友好吧~
9樓：
這個怎麼樣，有圖有文，有Gif動畫演示一目了然。
10樓：
11樓：北南
如果是格式方面的好，看這個，有完整做得好的專案列表，還有幾篇教程。
matiassingers/awesome-readme其實Readme不能太長，細節要是多的話，再做幾個文件的頁面這個是我最近看到的乙個我覺得還比較好的專案：
jaegertracing/jaeger
或者就這樣精簡的，我覺得可能更好。
twitter/twitter-text
我再補充乙個我也覺得做得不錯，但內容豐富，特別長的，大家可以比較一下sahat/hackathon-starter
GitHub 上有哪些優秀的專案？
閃閃sharon 現在好像要推國內的Gitee了吧 Gitee上這幾天看到乙個叫WorkPlus Lite的，做開源即時通訊，體驗還不錯。 JunMa 醫學影象分割領域 AI演算法與影象處理 如果你是搞計算機視覺的，我推薦你這些優質的專案 opencv相關 opencv官方開源庫opencv ope...
針對軟體開發專案的專案管理系統有哪些？
田小姐 排行榜前十有天翎 禪道bai teambition等等，多個中du小型專案同時使用的話，可zhi以使用禪道 teambition這之類的dao,如果是科研專案的話可以選擇天翎 說一下這類軟體的特點 支援SaaS雲端，如果預算足夠可以直接買斷私有化部署 具體功能如下 支援專案組合與專案策略管理...
個人 Github 上面有哪些專案會贏得 HR 青睞？
其實還好吧，加入幾個開源專案，作為組織成員，很快就有獵頭找上門了。有事沒事提點PR修復一下開源專案就好了。那種每天都有一大把commit的，其實我到是覺得很奇怪的，是公司專案在github上嗎？能有那麼多時間提交？我只有學生時代能達到過。 牛岱 本文使用 Zhihu On VSCode 創作並發布 ...