Bad Documentation!
rogersgeorge on January 22nd, 2020
When you write instructions, be sure to get them right:
- Don’t leave anything out
- Get the instructions in order!
Notes, by the way, generally go before the instructions. They give context.
Two rules of thumb:
- Test all instructions! If the reader gets it wrong, the problem is with the instructions.
- Bad documentation must not be justified with the excuse that the reader will figure it out.
Leave a Reply