微人事 star 數超 10k,如何打造一個 star 數超 10k 的開源項目


看了下,微人事(https://github.com/lenve/vhr)項目 star 數超 10k 啦,松哥第一個 star 數過萬的開源項目就這樣誕生了。

兩年前差不多就是現在這個時候,松哥所在的公司業績下滑嚴重,關門倒閉已成定局,很多同事在謀划的新的出路,松哥則被公司留下來善后,在一段並不太忙碌的日子里,做了兩個 Spring Boot + Vue 的前后端分離開源項目,以期能給自己來年找工作增加一點籌碼,沒想到這兩個項目后來受到很多關注,也幫助了很多人。有不少小伙伴在公司使用微人事項目做腳手架開發項目,也有國內 top20 的高校研究生借鑒微人事做畢設,我自己也因此收到一些大廠的橄欖枝,可以說還是收獲滿滿。

關於這個項目誕生的故事,松哥之前寫過一篇文章,感興趣的小伙伴可以看看:

今天,我想和小伙伴們聊聊如何從零開始打造一個 star 數過萬的開源項目。松哥把這些經驗總結為三點:

  • 文檔詳細
  • 項目有料
  • 適當宣傳

這些經驗不是什么驚世駭俗的大道理,都很普通,關鍵在於執行。

1. 文檔詳細

其實在做微人事和 V 部落之前,松哥在 GitHub 上已經做過多個開源項目了,比較有意思的一個是一個 Android 上的自定義控件,我做了一個歌詞展示的控件,這個控件引入到自己的項目中以后,可以根據當前歌曲的播放進度動態滾動歌詞,效果如如下:

還有一個比較好玩的就是 Android 上自動搶紅包的 App。不過這些開源工具和項目最終都石沉大海了。

究其原因,我覺得是自己對待這些項目不夠認真,項目開源之后基本上都沒有再繼續維護了,一個項目提交次數一般都是個位數,項目做完之后,寫一篇博客介紹下就算完事了。一個自己都不怎么重視的項目,其實很難引起別人的重視。

所以在 V 部落和微人事中,我就吸取教訓,盡量把項目的文檔寫的詳細一些,讓不懂前后端分離開發的小伙伴看到我寫的開發文檔后,就能夠快速理清項目的思路。就這樣,我每寫一個功能點,就寫一篇技術文檔,微人事項目前前后后一共寫了 30 多篇文檔:

同時我考慮到很多小伙伴第一次接觸到這個項目,一個龐然大物不好處理,因此我在每一次項目提交之前,都會對項目打一個 tag,這樣大家通過 git clone 命令獲取到項目之后,就可以通過 tag 非常方便的定位到項目的任意時刻,例如只想看登錄設計的,可以根據文檔介紹回到 v20180107 這個版本:

小伙伴也可以點擊 GitHub 上的 release 下載不同時期的項目。我一開始擔心有的小伙伴不熟悉 Git 上的 tag 操作,還針對此寫了個教程,就是上面文檔的第 17 篇。

可以說,這個項目我從頭到尾考慮了很多小伙伴們可能遇到的問題,不是自嗨,確實是希望能夠帶着小伙伴們一起飛。

這么詳細的文檔當然也得到了小伙伴和一些平台的認可,項目剛剛發布的時候,也就是 2018 年年初的時候,慕課網在它的官方知乎賬號、微博賬號上都有推過我的介紹項目的文章,當時這個項目就受到了很多小伙伴的關注,收獲了不少 star,小伙伴們的關注也鼓勵我繼續把這個項目向前推進。

這是我介紹的第一點經驗,文檔詳細。

2. 項目有料

項目有料,也就是這個項目對大家而言是有價值的,能夠真正幫到大家。

很多小伙伴看到微人事會覺得奇怪,這個項目還有一些功能沒有實現,怎么就有這么多人關注呢?其實原因很簡單,這個項目的價值不在於它的業務,而在於它解決了很多小伙伴在前后端分離開發中遇到的問題,這也是我做這個項目的初衷之一。

作為一個 Java 攻城獅,我非常明白很多小伙伴去接觸 Vue、接觸 Nodejs、接觸 SPA 以及接觸前端工程化這些概念時所面臨的困惑,因為這些困惑我也曾經遇到過。

例如前后端分離后,開發環境下前后端如何進行數據交互、權限管理怎么做、文件上傳怎么做、項目怎么部署等等,事無巨細,我覺得小伙伴們可能會困惑的地方,我在微人事中直接用代碼做出樣例,然后再輔以詳細的文字解釋,這樣對於大部分小伙伴而言,都能夠快速理解這個項目了。

這個項目建立之初,一開始就定位是一個學習項目,目的就是幫助大家建立前后端分離開發知識體系,搞定前后端分離開發中常見的坑,因此,一旦將項目的框架搭建成功,大家理解了前后端分離架構中的各個細節,剩下的業務不過是堆代碼,技術上已經沒有挑戰了,這也是這個項目最近一段時間更新慢的原因。

這是我和大家分享的第二點經驗,項目要有價值。

3. 適當宣傳

微人事和 V 部落剛剛上線的時候,我的相關文章被慕課網猛推過幾次,當時就讓微人事受到了比較多的關注,印象中,大概不到一個月的時間,star 數就超過 1k 了。

由於文檔比較詳細,很多大佬在整理相關資料的時候都會加上微人事項目,很多小伙伴可能見過標題類似下面這樣的文章:

  • 13個優秀的 Spring Boot 學習項目
  • 開源的13個Spring Boot 優秀學習項目!
  • 六月份 GitHub 上最受歡迎的開源項目
  • 七月份 GitHub 上最受歡迎的開源項目

....

這一類的文章大部分都會收錄微人事項目,進而將微人事項目曝光給更多小伙伴去學習。

今年七月份,有感於 1 年前公司倒閉時的無助,松哥寫了一篇文章介紹了微人事項目的誕生過程:

沒想到這篇文章被很多大佬轉發,單單在知乎上這篇文章的閱讀量就超過 12w,那一段時間,微人事項目也被很多有需要的小伙伴關注到了。

宣傳這一塊,我的經驗是如果項目確實幫助到了很多小伙伴,對很多人而言有價值,你會發現平台,一些有影響力的技術牛人會自然的幫你推。所以,我還是建議將重心放在項目上。所謂家有梧桐樹,引得鳳凰來。

這是我介紹的第三點經驗,適當宣傳。

好了,一點點不太成熟的經驗分享給小伙伴們,希望能幫到大家。
關注公眾號【江南一點雨】,專注於 Spring Boot+微服務以及前后端分離等全棧技術,定期視頻教程分享,關注后回復 Java ,領取松哥為你精心准備的 Java 干貨!


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM