How to Document Your Software

Аннотация

Last night I tried to install some software, but it didn’t work. The process was painful because the software’s installation documentation left a lot to be desired. I wasn’t sure which order I should use to perform certain steps. Some of the steps assumed I knew things I could only guess at. Many steps were implied, instead of being explicitly spelled out in detail. The documentation provided never made it clear how to know when the installation was complete and working properly. The result was failure. I still haven’t gotten it working at all. Does this sound familiar?