Skip to content

Instantly share code, notes, and snippets.

@cedrickchee

cedrickchee/secret_to_write_good_docs.md

Created October 18, 2019 09:55
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save cedrickchee/0eef2d32c5ff338571eafd23910475bb to your computer and use it in GitHub Desktop.
Save cedrickchee/0eef2d32c5ff338571eafd23910475bb to your computer and use it in GitHub Desktop.
Download ZIP
Secret to write good software documentation
Raw
secret_to_write_good_docs.md

Why is the documentation structured this way?

However hard you work on documentation, it won't work for your software - unless you do it the right way.

There is a secret that needs to be understood in order to write good software documentation: there isn’t one thing called documentation, there are four.

They are: tutorials, how-to guides, explanation and technical reference.

Source: What nobody tells you about documentation

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment