Skip to content
📢 Various README templates & tips on writing high-quality documentation that people want to read.
Branch: master
Clone or download
Latest commit c40fbaf Jul 20, 2019

README.md

The Documentation Compendium

The Documentation Compendium

Tweet Status GitHub Issues GitHub Pull Requests License

The Documentation Compendium - Beautiful README templates that people want to read. | Product Hunt Embed


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

Table of Contents

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 reader as someone who doesn't have a lot of knowledge about the topic but is very interested
  • Keep things brief
  • Use headings frequently. This breaks things up when reading and often it is good for linking to specific information
  • Link to other places in the documentation often but only for additional information. Readers should not have to navigate through several pages to find information regarding one specific thing. Just inline the immediately relevant information and link off if they want to know more
  • Use as many code snippets, CLI, etc. examples as possible. Show the reader what you mean
  • Gently introduce a guide before diving into technical details. This gives context and readers are more likely to stay engaged longer
  • It is always good to describe the functionality of the various files in your project
  • Always use gender-neutral pronouns. A gender-neutral pronoun is a pronoun which does not associate a gender with the individual who is being discussed. For eg. - using 'they' instead of 'he/she'

Things you should avoid:

  • Don't assume prior knowledge about the topic. If you want to appeal to a large audience, then you are going to have people with very diverse backgrounds
  • Don't use idioms. Write using more formal terms that are well defined. This makes it easier for non-native English speakers and for translations to be written
  • Don't clutter explanations with overly detailed examples
  • Don't use terms that are offensive to any group. There will never be a good reason to

Templates

Technical Writing Programs

  1. Google Season of Docs
  2. A List of Open Source Projects with Volunteer Documentation Opportunities

Awesome Technical Writing Sources

  1. r/technicalwriting
  2. My Tech Writing Process - Amruta Ranade
  3. Developer to Technical Writer - r/technicalwriting
  4. awesome-github-templates - devspace
  5. makeareadme - dguo
  6. What nobody tells you about documentation - Daniele Procida
  7. 3 Essential Components of Great Documentation - Eli B
  8. Inspiring techies to become great writers - Cameron Shorter
  9. Technical Documentation Writing Principles - Cameron Shorter
  10. Building Our Documentation Site on platformOS — Part 2: Content Production and Layouts - Diana Lakato
  11. Google Developer Documentation Style Guide - Google
  12. README Maturity Model - LappleApple
  13. 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

  1. Documenting your projects on GitHub - GitHub Guides
  2. documentation-handbook - jamiebuilds
  3. Documentation Guide - Write the Docs

P.S.

  • This repo is under active development. If you have any improvements / suggestions please file an issue or send in a Pull Request
  • The TODO.md file or the issues page are a good place to visit if you want to pick up some task. They have a list of things are to be implemented in the near future

CC0
To the extent possible under law, Kyle Lobo has waived all copyright and related or neighboring rights to The Documentation Compendium.

You can’t perform that action at this time.