Differences
This shows you the differences between two versions of the page.
| Both sides previous revisionPrevious revision | |||
| documentation [2024/08/29 00:15] – add title qlyoung | documentation [2024/08/29 00:16] (current) – qlyoung | ||
|---|---|---|---|
| Line 1: | Line 1: | ||
| ====== documentation ====== | ====== documentation ====== | ||
| - | I strongly appreciate excellent technical documentation. You can have a great piece of software but if it's difficult to understand how to use it, users will fail to appreciate it. | + | I strongly appreciate excellent technical documentation. You can have a great piece of software but if it's difficult to understand how to use it, at best users will fail to appreciate it and at worst huge amounts of time will be wasted and vast quantities of errors committed. |
| Because I appreciate good documentation for tools I use I do my best to write useful documentation. In addition to the obvious benefit, which is that good documentation saves everyone time, I find there are several additional benefits specific to the act of writing documentation: | Because I appreciate good documentation for tools I use I do my best to write useful documentation. In addition to the obvious benefit, which is that good documentation saves everyone time, I find there are several additional benefits specific to the act of writing documentation: | ||
documentation.1724890515.txt.gz · Last modified: 2024/08/29 00:15 by qlyoung
Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Noncommercial-Share Alike 4.0 International