3 ms·
Write proper documentation.
by wott 10y ago
Write proper documentation.
- danieltillett 10y agoHaving just spent the last three week writing a manual for a new product I have to laugh at the suggestion. Absolutely nobody reads manuals.
- deleted 10y ago[deleted]
- flukus 10y agoDocumentation and manuals are two different things. A lot of people read documentation.
- danieltillett 10y agoI am not too sure what the difference is between documentations and manuals other than the format. The funny thing is if you don’t provide a manual people ask where is the manual, but if you do they don’t read it.
- flukus 10y agoA manual will typically document every function of the software in mind numbing fashion. "Section 4, Subsection 7 - Adding Foos - To add a new foo click the add button as indicated in the picture below". Documentation is much more encompassing and often in more of a wiki format. You could include a recipes section for example, which apart from being useful for customers, it can also show off what the software can do. A FAQ section is another very common one. People asking for a manual is really people asking "how do I do X".
- danieltillett 10y agoWell by this standard the manuals I write are documentation. Nobody reads them :)