2 ms·

This is well done! > Support error recognition and recovery. I totally agree with this. You have to teach critical concepts a couple different ways in case on

by kwiens 7y ago

This is well done! > Support error recognition and recovery. I totally agree with this. You have to teach critical concepts a couple different ways in case one gets skimmed over or misunderstood. We rely on visuals for this--the text should stand independent of the photo / diagram, and vice versa. I wrote a handbook on technical writing summing up what we've learned over many years of writing iFixit repair guides. https://help.dozuki.com/Tech_Writing/chapter/0 https://help.dozuki.com/Tech_Writing/chapter/0

kaycebasques 7y ago
Another hugely important reason to support error recovery: this is how many people find documentation. They see an error when using an application (or writing code) and they copy-paste the error into a search engine. If you provide that error text verbatim in your documentation, you will capture that search engine traffic.