Document your work

• Documentation is good when, and only when, it is also discoverable
• Your documentation is discoverable when it exists where your audience goes when they are looking for it
  • Commit messages often not indexed in search engines (external or internal)
  • Agree with “most” that including the raw error message is fantastic; increases precise searchability
  • The commit message referenced in “most” is fantastic documentation (agree with all points made); however, it isn’t as discoverable as it could be.
    • Better to write the documentation in a more accessible place and link to it (or even copy/paste it so long as you also include the link) in the commit message
  • Agree with “least” that commit messages are not the most discoverable place
  • Agree with “least” that tests are (S-tier) documentation
• https://hackernoon.com/write-good-documentation-6caffb9082b4 (a)
• https://www.variance.com/posts/6-rules-of-good-documentation (a)
• https://idratherbewriting.com/simplifying-complexity/discoverability-through-metadata.html (a)
• (“Readme Driven Development” n.d.)
• Synthesize David Thompson | My Favourite Git Commit and Alexey Nikitin | My least favorite Git commit
• Explicitly list the alternatives you considered and why you decided against them

Duty to Document (a)

Bibliography

Backlinks

• Alexey Nikitin | My least favorite Git commit
• David Thompson | My Favourite Git Commit
• Todos
• Why I write notes