info/the-documentation-compendium
1
0
Fork 0
mirror of https://github.com/kylelobo/The-Documentation-Compendium.git synced 2025-09-25 12:09:15 +02:00
Code Issues Releases Wiki Activity

Added info for badges & feedback

Browse Source
This commit is contained in:
Kyle Lobo
2019-06-05 21:10:27 +05:30
committed by GitHub
parent 0b3fb51a07
commit 83a37b43ee
1 changed files with 14 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@@ -14,12 +14,14 @@
+ [Novice Technical Writers](https://www.writethedocs.org/guide/#new-to-caring-about-documentation) + [Novice Technical Writers](https://www.writethedocs.org/guide/#new-to-caring-about-documentation)
+ [Experienced Technical Writers](https://www.writethedocs.org/guide/#experienced-documentarian) + [Experienced Technical Writers](https://www.writethedocs.org/guide/#experienced-documentarian)
+ [API Documentation](https://www.writethedocs.org/guide/#api-documentation) + [API Documentation](https://www.writethedocs.org/guide/#api-documentation)
+ [Adding badges](https://github.com/badges/shields/blob/master/README.md#examples)
+ [Tools](https://www.writethedocs.org/guide/#tools-of-the-trade) + [Tools](https://www.writethedocs.org/guide/#tools-of-the-trade)
+ [Technical Writer Programs](#programs) + [Technical Writer Programs](#programs)
+ [Awesome Technical Writing Sources](#sources) + [Awesome Technical Writing Sources](#sources)
+ [Get Feedback](#feedback)
+ [Acknowledgements](#acknowledgements) + [Acknowledgements](#acknowledgements)
## 🤔 Why must you document your project?<a name = "why_document"></a> ## 🤔 Why must you document your project? <a name = "why_document"></a>
+ **THE MAJORITY OF PEOPLE GLANCE AND LEAVE.** Make it pretty so that it's easier for them to star before they leave. The more stars you have, the likelier it is that serious developers will use your repo. + **THE MAJORITY OF PEOPLE GLANCE AND LEAVE.** Make it pretty so that it's easier for them to star before they leave. The more stars you have, the likelier it is that serious developers will use your repo.
+ You will be using your code in _6 months_. Code that you wrote 6 months ago is often indistinguishable from code that someone else has written + You will be using your code in _6 months_. Code that you wrote 6 months ago is often indistinguishable from code that someone else has written
+ You want people to use your code because you think that others might find it useful. However, people need to _understand why_ your code might be useful for them, before they decide to use it + You want people to use your code because you think that others might find it useful. However, people need to _understand why_ your code might be useful for them, before they decide to use it
@@ -47,13 +49,17 @@
## 🎉 Awesome Technical Writing Sources <a name = "sources"></a> ## 🎉 Awesome Technical Writing Sources <a name = "sources"></a>
1. [r/technicalwriting](https://www.reddit.com/r/technicalwriting/) 1. [r/technicalwriting](https://www.reddit.com/r/technicalwriting/)
2. [My Tech Writing Process - Amruta Ranade](https://amrutaranade.com/2018/03/07/my-writing-process/) 2. [My Tech Writing Process](https://amrutaranade.com/2018/03/07/my-writing-process/) - _Amruta Ranade_
3. [Developer to Technical Writer](https://www.reddit.com/r/technicalwriting/comments/a1x6c8/) 3. [Developer to Technical Writer](https://www.reddit.com/r/technicalwriting/comments/a1x6c8/)
4. [awesome-github-templates by devspace](https://github.com/devspace/awesome-github-templates) 4. [awesome-github-templates](https://github.com/devspace/awesome-github-templates) - _devspace_
5. [makeareadme by dguo](https://www.makeareadme.com/) 5. [makeareadme](https://www.makeareadme.com/) - _dguo_
6. [What nobody tells you about documentation by Divio](https://www.divio.com/blog/documentation/) 6. [What nobody tells you about documentation](https://www.divio.com/blog/documentation/) - _Divio_
## Get Feedback <a name = "feedback"></a>
- [feedmereadmes](https://github.com/LappleApple/feedmereadmes) - Free README editing + feedback to make your open-source projects grow. See the README maturity model to help you keep going.
- [maintainer.io](https://maintainer.io/) - Free README standardization and feedback if you click on 'Book an audit'.
## 📚 Acknowledgements <a name = "acknowledgements"></a> ## 📚 Acknowledgements <a name = "acknowledgements"></a>
1. [Documenting your projects on GitHub by GitHub Guides](https://guides.github.com/features/wikis/) 1. [Documenting your projects on GitHub](https://guides.github.com/features/wikis/) - _GitHub Guides_
2. [documentation-handbook by jamiebuilds](https://github.com/jamiebuilds/documentation-handbook) 2. [documentation-handbook](https://github.com/jamiebuilds/documentation-handbook) - _jamiebuilds_
3. [Documentation Guide by Write the Docs](https://www.writethedocs.org/guide/) 3. [Documentation Guide](https://www.writethedocs.org/guide/) - _Write the Docs_