{"repo":"race2infinity/The-Documentation-Compendium","free":true,"listed":false,"github":"https://github.com/race2infinity/The-Documentation-Compendium","clone":"git clone https://github.com/race2infinity/The-Documentation-Compendium.git","description":"📢 Various README templates & tips on writing high-quality documentation that people want to read.","language":null,"stars":6015,"topics":["documentation","documentation-theme","documentation-template","technical-writing","templates","template-project","project-documentation","readme","readme-template","guidelines"],"license":null,"category":"docs-static-sites","readme_excerpt":"The Documentation Compendium --- 💡 Various templates & tips on writing high-quality documentation that people want to read. Table of Contents - Why must you document your project - Best Practices - Templates - The Art of Technical Writing - Novice Technical Writers - Experienced Technical Writers - API Documentation - Adding badges - Tools - Technical Writer Programs - Awesome Technical Writing Sources - Get Feedback - Acknowledgements Why must you document your project? - It doesn’t matter how good your software is, because if the documentation is not good enough, people will not use it. Even if for some reason they have to use it, without good documentation, they won’t use it effectively or the way you’d like them to - 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 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 help out. If you don’t have documentation, you will miss out on a whole class of contributors - You want to be a better writer Best Practices Things to remember: - Keep a lighthearted friendly tone. Treat the reade","default_branch":null,"files":null,"tree":[],"storefront":"/r/race2infinity","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/race2infinity/The-Documentation-Compendium/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}