The-Documentation-Compendium

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.

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

GitHub
6k stars
91 watching
764 forks
last commit: 8 months ago
Linked from 2 awesome lists

awesomedocsdocumentationdocumentation-templatedocumentation-themedocumentation-toolguidelinesproject-documentationreadmereadme-bolierplatereadme-firstreadme-mdreadme-standardreadme-templatetechnical-writingtemplate-projecttemplates

Table of Contents / The Art of Technical Writing
Novice Technical Writers
Experienced Technical Writers
API Documentation
Adding badges 23,835 6 days ago
Tools

Templates
README
Pull Request
Issues
Contributing
Code of Conduct
Coding Guidelines
Codebase Structure
Changelog
TODO

The Art of Technical Writing
Novice Technical Writers
Experienced Technical Writers
API Documentation
Adding badges 23,835 6 days ago
Tools

Technical Writing Programs
Google Season of Docs
A List of Open Source Projects with Volunteer Documentation Opportunities

Awesome Technical Writing Sources
r/technicalwriting
My Tech Writing Process Amruta Ranade
Developer to Technical Writer r/technicalwriting
awesome-github-templates 2,101 over 1 year ago devspace
makeareadme dguo
What nobody tells you about documentation Daniele Procida
3 Essential Components of Great Documentation Eli B
Inspiring techies to become great writers Cameron Shorter
Technical Documentation Writing Principles Cameron Shorter
Building Our Documentation Site on platformOS — Part 2: Content Production and Layouts Diana Lakato
Google Developer Documentation Style Guide Google
README Maturity Model LappleApple
Markdown Style Guide Ciro Santilli

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 292 about 8 years ago jamiebuilds
Documentation Guide Write the Docs

P.S.
issue 5,601 8 months ago This repo is under active development. If you have any improvements / suggestions please file an or send in a
issues 5,601 8 months ago 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

Backlinks from these awesome lists:

More related projects: