295 lines
13 KiB
Markdown
295 lines
13 KiB
Markdown
<p align="center">
|
||
<img alt="oss image" src="./imgs/zoss-logo.svg" height="200px" width="200px">
|
||
</p>
|
||
|
||
<p align="center">
|
||
<a href="https://twitter.com/intent/tweet?text=How%20to%20promote%20your%20open-source%20projects%20@ZenikaOSS&url=https://github.com/zenika-open-source/open-source-promotion-cheat-sheet&hashtags=OpenSource,CheatSheet">
|
||
<img alt="tweet" src="https://img.shields.io/twitter/url/https/twitter?label=%E5%88%86%E4%BA%AB%E5%88%B0twitter&style=social" target="_blank" />
|
||
</a>
|
||
</p>
|
||
|
||
<h1 align="center">開源項目推廣備忘單</h1>
|
||
|
||
> 這篇備忘單為您總結了一些關於如何最好地推廣您的開源項目的重要步驟，您可以點擊並展開下列選項以了解更多詳情。
|
||
|
||
現已支持以下語言：
|
||
|
||
- [English](./README.md)
|
||
- [Français](./README-fr.md)
|
||
- [Deutsch](./README-de.md)
|
||
- [Español](./README-es.md)
|
||
- [简体中文](./README-zh-cn.md)
|
||
- [繁體中文](./README-zh-tw.md)
|
||
|
||
沒有您需要的語言？希望幫忙改進這份備忘單？[歡迎您的貢獻](./CONTRIBUTING.md)！
|
||
|
||
[我們也提供這份備忘單的 PDF 版本](./pdf/cheat-sheet.pdf)
|
||
|
||
## 1. 🎢 準備階段
|
||
|
||
<br />
|
||
|
||
<details>
|
||
<summary>👌 保證您的項目已經足夠成熟</summary>
|
||
<p>
|
||
|
||
> 您的項目必須足夠穩定，並且擁有一些最低可行功能用以吸引用戶們。
|
||
|
||
</p>
|
||
</details>
|
||
|
||
<details>
|
||
<summary>😎 為您的項目挑選一個炫酷的名字</summary>
|
||
<p>
|
||
|
||
> 挑選一個用戶們能輕易記住的名字。
|
||
|
||
</p>
|
||
</details>
|
||
|
||
<details>
|
||
<summary>💅 把您的README文檔寫得幹淨漂亮</summary>
|
||
<p>
|
||
|
||
> 您的訪客們的第一件事就是閱讀您的 README 文檔，所以您得確保它幹淨漂亮、易於閱讀。[這些優秀的 README 文檔可以為您提供參考](https://github.com/matiassingers/awesome-readme)。
|
||
|
||
</p>
|
||
</details>
|
||
|
||
<details>
|
||
<summary>💪 強調您的項目中最閃耀的亮點</summary>
|
||
<p>
|
||
|
||
> 找出您的項目的強大之處並確保您的訪客們在第一時間了解到它們。
|
||
|
||
</p>
|
||
</details>
|
||
|
||
<details>
|
||
<summary>✨ 提供一個您項目的演示或示例</summary>
|
||
<p>
|
||
|
||
> 訪客們通常希望迅速了解您的項目的目標，它的工作原理以及應該如何使用它。為您的項目提供一個演示或者示例可以很好地滿足訪客們的需求，比如說：
|
||
>
|
||
> - 利用 GIF 動畫來展示您項目的工作原理
|
||
> - 提供一個在線演示的網頁連接
|
||
|
||
</p>
|
||
</details>
|
||
|
||
<details>
|
||
<summary>👌 安裝和使用必須超級簡單</summary>
|
||
<p>
|
||
|
||
> 您的項目不夠用戶友好可能會造成訪客們的流失。
|
||
|
||
</p>
|
||
</details>
|
||
|
||
<details>
|
||
<summary>📘 創建一個幹淨整潔的結構化文檔</summary>
|
||
<p>
|
||
|
||
> 一個優秀的文檔也許是最為重要的一步了。如果您的文檔比較小的話，您可以直接將它包含在 README 文檔裏。否則的話，您或許應該將您的文檔托管在一個獨立的網站上麵。一些開源項目比如 [vuepress](https://v1.vuepress.vuejs.org) 可以幫助您非常容易地創建幹淨整潔的文檔。
|
||
|
||
</p>
|
||
</details>
|
||
|
||
<br />
|
||
|
||
## 2. 📢 宣傳您的辛苦工作
|
||
|
||
<br />
|
||
|
||
<details>
|
||
<summary>⭐ 在社交網絡上發布您的項目之前，保證它是可以信賴的</summary>
|
||
<p>
|
||
|
||
> 許多訪客會在考慮使用項目之前，先查看項目獲得過得 star 數量。隻需要一些 star 就能讓您的項目比沒有任何 star 的項目更加值得信賴，這就是為什麼您應該在社交網絡上公開宣布之前，請您認識的人支持您的項目。
|
||
|
||
</p>
|
||
</details>
|
||
|
||
<details>
|
||
<summary>↗️ 在社交媒體和專業平台上分享您的項目</summary>
|
||
<p>
|
||
|
||
> 向世界展示您無與倫比的作品！您可以在以下社交媒體和專業平台上發布：
|
||
>
|
||
> - [Twitter](https://twitter.com)
|
||
> - [Linkedin](https://www.linkedin.com/)
|
||
> - [Facebook](https://www.facebook.com/)
|
||
> - [Reddit](https://www.reddit.com/)
|
||
> - [Dev.to](https://dev.to/)
|
||
> - [Lobsters](https://lobste.rs/)
|
||
> - [Hacker News](https://news.ycombinator.com/)
|
||
> - [Product Hunt](https://www.producthunt.com/)
|
||
> - [Beta page](https://betapage.co/)
|
||
> - [Human Coders](https://news.humancoders.com/)
|
||
|
||
</p>
|
||
</details>
|
||
|
||
<details>
|
||
<summary>📃 寫一些文章並且提及您的項目</summary>
|
||
<p>
|
||
|
||
> 為您的項目寫一些關於您項目的文章。您可以在其中分享您使用到的技術棧、您項目的工作原理和您遇到過得問題等等。然後把這些文章發布在這些平台上：
|
||
>
|
||
> - [medium](https://medium.com/)
|
||
> - [dev.to](https://dev.to/)
|
||
|
||
</p>
|
||
</details>
|
||
|
||
<details>
|
||
<summary>🎤 在正式會議或線下聚會上介紹您的項目</summary>
|
||
<p>
|
||
|
||
> 在正式會議或線下聚會上介紹您的項目是提高知名度的好辦法。
|
||
|
||
</p>
|
||
</details>
|
||
|
||
<details>
|
||
<summary>🎥 記錄並發布項目介紹和原理解釋等的視頻</summary>
|
||
<p>
|
||
|
||
> 雖然錄製視頻並不輕鬆，但它也許是能讓您的項目出名的最有效的辦法。
|
||
|
||
</p>
|
||
</details>
|
||
|
||
<details>
|
||
<summary>🕐 選擇最好的時間在社交媒體上發布</summary>
|
||
<p>
|
||
|
||
> 不要在假期或者周末發布您的項目。通常最適合在社交網絡上發布的時間是一周裏中間的那幾天。
|
||
|
||
</p>
|
||
</details>
|
||
|
||
<details>
|
||
<summary>🗑 不要在平台上過度宣傳</summary>
|
||
<p>
|
||
|
||
> 不要在相同的平台上發布兩次。這將會被視為過度的宣傳，並且有可能為您的項目招致負麵宣傳。
|
||
|
||
</p>
|
||
</details>
|
||
|
||
<br />
|
||
|
||
## 3. 🤝 留住您的用戶們
|
||
|
||
<br />
|
||
|
||
<details>
|
||
<summary>🆕 盡量為您的項目定期發布新版本</summary>
|
||
<p>
|
||
|
||
> 維護並且改進您的項目，比如：新版本的發布和撰寫變更記錄。
|
||
|
||
</p>
|
||
</details>
|
||
|
||
<details>
|
||
<summary>❗ 維護您的項目並處理未解決的issue</summary>
|
||
<p>
|
||
|
||
> 別讓 issue 一直處於未解決的狀態並且對此毫無回應。對那些花費自己時間提交 issue 的用戶們好一點。 😉
|
||
|
||
</p>
|
||
</details>
|
||
|
||
<details>
|
||
<summary>🙏 邀請用戶們為項目貢獻</summary>
|
||
<p>
|
||
|
||
> 一個健康的項目通常擁有一個社區和許多貢獻者們。在一些 issue 上標注`contribution welcome`標簽或者`good first issue`標簽來讓您的用戶們知道您需要幫助。[關於 github 標簽](https://help.github.com/en/articles/about-labels)。
|
||
|
||
</p>
|
||
</details>
|
||
|
||
<details>
|
||
<summary>🏆 獎勵貢獻者們</summary>
|
||
<p>
|
||
|
||
> 為那些幫助過您的人們鼓掌喝彩! 一些開源項目像是[gatsby](https://github.com/gatsbyjs/gatsby)會獎勵貢獻者們一些小禮物。如果您負擔不起，也可以在 twitter 或者其它平台上發布一封關於項目貢獻的公開感謝信，並且提及那些貢獻者們（[公開感謝信的示例](https://twitter.com/FranckAbgrall/status/1139470547492978688)）。在您的 README 文檔裏開設一個`貢獻者`欄，以此公開地感謝貢獻者們。或者您也可以在項目文檔或網站上展示您的貢獻者們。以下是一些示例：
|
||
>
|
||
> - [vuepress （在 README 中的貢獻者欄）](https://github.com/vuejs/vuepress#code-contributors)
|
||
> - [Rythm.js （在展示頁麵上隨機顯示貢獻者）](https://okazari.github.io/Rythm.js/)
|
||
|
||
</p>
|
||
</details>
|
||
|
||
<details>
|
||
<summary>💬 開設一個社區聊天平台</summary>
|
||
<p>
|
||
|
||
> Github 的 issue 並不總是和您的用戶溝通最好的地方。如果有需要的話，您可以使用一些聊天平台來和他們討論：
|
||
>
|
||
> - [Discord](https://discordapp.com)
|
||
> - [Slack](https://slack.com)
|
||
> - [Gitter](https://gitter.im/)
|
||
|
||
</p>
|
||
</details>
|
||
|
||
<details>
|
||
<summary>🔙 尋求反饋</summary>
|
||
<p>
|
||
|
||
> 用戶反饋是改進您項目的最佳方法，他們也許有著能使您的項目變得更好的想法和主意。
|
||
|
||
</p>
|
||
</details>
|
||
|
||
<details>
|
||
<summary>❤️ 建造一個用例庫來展示您的用戶是如何使用您的項目的</summary>
|
||
<p>
|
||
|
||
> 如果訪問者們能夠見到具體的用例和成功案例的話，他們會更加信任您的項目，比如 [the vuepress gallery](https://vuepress.gallery/)。
|
||
|
||
</p>
|
||
</details>
|
||
|
||
<br />
|
||
|
||
## 🙏 表示支持
|
||
|
||
如果這份備用單能夠幫助到您，請您支持並 ⭐️ 我們的 repository！
|
||
|
||
<br />
|
||
|
||
## ❤️ 貢獻者們
|
||
|
||
感謝這群無與倫比的人們：
|
||
|
||
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
|
||
<!-- prettier-ignore -->
|
||
<table>
|
||
<tr>
|
||
<td align="center"><a href="https://www.franck-abgrall.me/"><img src="https://avatars3.githubusercontent.com/u/9840435?v=4" width="100px;" alt="Franck Abgrall"/><br /><sub><b>Franck Abgrall</b></sub></a><br /><a href="https://github.com/zenika-open-source/open-source-promotion-cheat-sheet/commits?author=kefranabg" title="Documentation">📖</a></td>
|
||
<td align="center"><a href="https://github.com/tbetous"><img src="https://avatars3.githubusercontent.com/u/4435536?v=4" width="100px;" alt="Thomas Betous"/><br /><sub><b>Thomas Betous</b></sub></a><br /><a href="https://github.com/zenika-open-source/open-source-promotion-cheat-sheet/commits?author=tbetous" title="Documentation">📖</a></td>
|
||
<td align="center"><a href="https://github.com/ebriand"><img src="https://avatars1.githubusercontent.com/u/1011902?v=4" width="100px;" alt="Eric Briand"/><br /><sub><b>Eric Briand</b></sub></a><br /><a href="https://github.com/zenika-open-source/open-source-promotion-cheat-sheet/commits?author=ebriand" title="Documentation">📖</a></td>
|
||
<td align="center"><a href="https://github.com/FofoDev"><img src="https://avatars0.githubusercontent.com/u/27639429?v=4" width="100px;" alt="Faustine Godbillot"/><br /><sub><b>Faustine Godbillot</b></sub></a><br /><a href="https://github.com/zenika-open-source/open-source-promotion-cheat-sheet/commits?author=FofoDev" title="Documentation">📖</a></td>
|
||
<td align="center"><a href="https://myvirtualstorybook.com/"><img src="https://avatars1.githubusercontent.com/u/5747538?v=4" width="100px;" alt="Benjamin Plouzennec"/><br /><sub><b>Benjamin Plouzennec</b></sub></a><br /><a href="https://github.com/zenika-open-source/open-source-promotion-cheat-sheet/commits?author=Okazari" title="Documentation">📖</a></td>
|
||
<td align="center"><a href="https://github.com/Zenigata"><img src="https://avatars1.githubusercontent.com/u/1022393?v=4" width="100px;" alt="Johan Bonneau"/><br /><sub><b>Johan Bonneau</b></sub></a><br /><a href="https://github.com/zenika-open-source/open-source-promotion-cheat-sheet/commits?author=Zenigata" title="Documentation">📖</a></td>
|
||
<td align="center"><a href="https://github.com/bpetetot"><img src="https://avatars3.githubusercontent.com/u/516360?v=4" width="100px;" alt="Benjamin Petetot"/><br /><sub><b>Benjamin Petetot</b></sub></a><br /><a href="https://github.com/zenika-open-source/open-source-promotion-cheat-sheet/commits?author=bpetetot" title="Documentation">📖</a></td>
|
||
</tr>
|
||
<tr>
|
||
<td align="center"><a href="https://nick-hat-boecker.de"><img src="https://avatars0.githubusercontent.com/u/8366071?v=4" width="100px;" alt="NickHatBoecker"/><br /><sub><b>NickHatBoecker</b></sub></a><br /><a href="#translation-NickHatBoecker" title="Translation">🌍</a></td>
|
||
<td align="center"><a href="https://github.com/Claire"><img src="https://avatars2.githubusercontent.com/u/5114096?v=4" width="100px;" alt="Claire Martinez"/><br /><sub><b>Claire Martinez</b></sub></a><br /><a href="#translation-claire" title="Translation">🌍</a></td>
|
||
<td align="center"><a href="https://hazeforum.com/"><img src="https://avatars2.githubusercontent.com/u/31011359?v=4" width="100px;" alt="André Gama"/><br /><sub><b>André Gama</b></sub></a><br /><a href="https://github.com/zenika-open-source/open-source-promotion-cheat-sheet/commits?author=andregamma" title="Documentation">📖</a></td>
|
||
<td align="center"><a href="https://github.com/mbernardeau"><img src="https://avatars0.githubusercontent.com/u/7049049?v=4" width="100px;" alt="Mathias Bernardeau"/><br /><sub><b>Mathias Bernardeau</b></sub></a><br /><a href="https://github.com/zenika-open-source/open-source-promotion-cheat-sheet/commits?author=mbernardeau" title="Documentation">📖</a></td>
|
||
<td align="center"><a href="https://github.com/Antoineoili"><img src="https://avatars1.githubusercontent.com/u/50737365?v=4" width="100px;" alt="Antoine Oili"/><br /><sub><b>Antoine Oili</b></sub></a><br /><a href="https://github.com/zenika-open-source/open-source-promotion-cheat-sheet/commits?author=Antoineoili" title="Documentation">📖</a></td>
|
||
<td align="center"><a href="https://twitter.com/dev_oswld"><img src="https://avatars1.githubusercontent.com/u/40254158?v=4" width="100px;" alt="Oswld TC"/><br /><sub><b>Oswld TC</b></sub></a><br /><a href="#translation-dev-oswld" title="Translation">🌍</a></td>
|
||
<td align="center"><a href="https://yizhiyue.me"><img src="https://avatars3.githubusercontent.com/u/8545277?v=4" width="100px;" alt="Zhiyue Yi"/><br /><sub><b>Zhiyue Yi</b></sub></a><br /><a href="#translation-ZhiyueYi" title="Translation">🌍</a></td>
|
||
</tr>
|
||
</table>
|
||
|
||
<!-- ALL-CONTRIBUTORS-LIST:END -->
|
||
|
||
該項目遵循[all-contributors](https://github.com/all-contributors/all-contributors)說明。歡迎任何形式的貢獻！
|