I <3 Documentation

Hello Internet stranger! Welcome to the documentation celebration party! Documentation is awesome but too commonly underappreciated so we are having a party for documentation and for those who take the time to write documentation!!!

Documentation is about showing your work so that others can understand and replicate it.

Documentation is accessible. Share it with others!

Documentation is never complete — it's better to ship it even it you don't feel ready. Also, it can grow and change as others react to it.

Documentation is honest. It's OK to note where you're not confident your documentation is correct. It's also important to record which parts of the project were difficult.

Examples of documentation

Benefits

Here are all the reasons documentation is awesome so you can tell your friends and invite them to the documentation writing brigade!

FAQs

Express your love for documentation!

Made with <3 by Ruth Grace Wong and jenbuilds.

Save