https://wintermade.it/blog/enSun, 20 Oct 2019 20:05:34 GMTNikola (getnikola.com)http://blogs.law.harvard.edu/tech/rsshttps://wintermade.it/blog/posts/what-nobody-tells-you-about-documentation.htmlAlessandro Balzano<div><p><a class="reference external" href="https://www.divio.com/blog/documentation/">What nobody tells you about documentation - Divio.com</a></p> <p>This link from Hacker News' frontpage catched my attention. Despite the clickbaity title, it is a thorough blog post about documentation, its role and how to write documentation users will actually enjoy reading.</p> <p>To summarize, Daniele (the author of the blog post) defines four kinds of documentation: tutorials, how-to guides, explanations and reference documentation. They also explain the scope and the role of each kind, and do/don't rules for writing an effective tutorial, how-to guide, <em>et cetera</em>.</p> <p>I am not going to summarize that great article: just go read it. Recommended!</p></div>documentationhttps://wintermade.it/blog/posts/what-nobody-tells-you-about-documentation.htmlSat, 19 Oct 2019 08:52:16 GMT