Tom Krush

Tom Krush

Dad, Husband, Programmer, Amateur Woodworker

17 Apr 2020

Documentation Systems

Over the past few months I’ve learned a few things about writing good documentation. This advice should be obvious.

You need to make sense to your reader.

If you are teaching someone new than write a tutorial. If you are teaching someone who has some experience than give them a how-to. If you are teaching someone who wants to know everything about a topic give them a reference guide.

Do not mix these documentation types together.

To learn more: https://documentation.divio.com

comments powered by Disqus