Thank you Olivier, a very interesting read. You and I discussed something similar at a docs meeting sometime ago, when we talked about adding links in the guides and Help files to FAQs, HowTos & Tutorials.
Unfortunately, Daniele Procida (the author of the article) made one glaringly serious omission, when he writes "There isn’t one thing called documentation, there are four." he totally overlooks and consequently offers no solution to the Fifth and critically important thing "Numbers of People to do the Other Four". Sorry to sound a negative note, but I am weary of experts saying how things should/could be done, without offering a solution to the main problem of finding the contributor numbers to do those things. We already have in place much of what Daniele recommends, but we just don't have the numbers of contributors to take them forward. Regards Dave On 10.05.2019 15:21, Olivier Hallot wrote: > Hi Doc team > > I would like to share with our a very interesting reading I found on > documentation and its companion presentation. > > What Nobody Tells about Documentation > https://www.divio.com/blog/documentation/ > > Video > https://www.youtube.com/watch?v=t4vKPhjcMZg > > To sumarize it on the contents, it deals with the several kinds of > documentation. > > <quote> > > There is a secret that needs to be understood in order to write good > software documentation: there isn’t one thing called documentation, > there are four. > > They are: tutorials, how-to guides, explanation and technical reference. > They represent four different purposes or functions, and require four > different approaches to their creation. Understanding the implications > of this will help improve most software documentation - often immensely. > > </quote> > > regards > -- To unsubscribe e-mail to: [email protected] Problems? https://www.libreoffice.org/get-help/mailing-lists/how-to-unsubscribe/ Posting guidelines + more: https://wiki.documentfoundation.org/Netiquette List archive: https://listarchives.libreoffice.org/global/documentation/ Privacy Policy: https://www.documentfoundation.org/privacy
