Skip to content

Instantly share code, notes, and snippets.

View kendsdavs's full-sized avatar

kendsdavs

  • Jack Russell Software
  • Mt. Pleasant, SC
View GitHub Profile
@twilson63
twilson63 / README.md
Last active October 12, 2023 12:25
How to write documentation

How to write documentation

Documentation is one thing developers hate to do, but other developers hate when there is a new library or tool with no direction on how to use it. While documentation is not a lot of fun to write, it can be super useful to your future self and others who want to use your libraries and tools. If you find yourself getting annoyed from developers or users constantly asking you about x or y. Odds are you have a documentation issue or at least an opportunity to create some documentation to handle future requests for the same information.

This document is a short guide for myself to try to give me something to reference as I try to improve my documentation skills.