The-Documentation-Compendium

awesome listpushed over 2 years ago

📢 Various README templates & tips on writing high-quality documentation that people want to read.

AI summary

Documentation guidelines

A collection of documentation best practices and templates to help software developers write high-quality documentation that is easy to read and understand.

stars: 5.6K
forks: 765
watching: 91
awesome lists: 2
entries: 41

View on GitHub

What's in the list

41 links in 8 sections, with live GitHub stats.activeno commit in 2y

Table of Contents / The Art of Technical Writing

Templates

The Art of Technical Writing

Technical Writing Programs

Get Feedback

feedmereadmes
Free README editing + feedback to make your open-source projects grow. See the README maturity model to help you keep going
maintainer.io
Free README standardization and feedback if you click on 'Book an audit'

Acknowledgements

Documenting your projects on GitHub
GitHub Guides
documentation-handbook
jamiebuilds
294almost 10 years
Documentation Guide
Write the Docs

P.S.

issue
This repo is under active development. If you have any improvements / suggestions please file an or send in a
5.6Kover 2 years
issues
The page is a good place to visit if you want to pick up some task. It has a list of things that are to be implemented in the near future
5.6Kover 2 years

Featured in 2 awesome lists

Each link jumps to the spot where the list mentions The-Documentation-Compendium.