I like linking to this site [0], the "The Grand Unified Theory of Documentation" that describes four categories of documentation that fill out a 2D space of potential docs value: the practical steps <-> theoretical knowledge dimension, and the useful when studying <-> useful when working dimension.<p><pre><code> * Tutorials - Learning-oriented - (practical/studying)
* How To Guides - Problem-oriented - (practical/working)
* Explanations - Understanding-oriented - (theoretical/studying)
* Reference - Information-oriented - (theoretical/working)
</code></pre>
It passed through HN ~9 months ago [1], where
kaycebasques stated, "I think the key breakthrough with Divio's framework is getting authors to think about docs in terms of desired goals and outcomes: learning-oriented, problem-oriented, etc."<p>[0]: <a href="https://documentation.divio.com" rel="nofollow">https://documentation.divio.com</a><p>[1]: <a href="https://news.ycombinator.com/item?id=26002656" rel="nofollow">https://news.ycombinator.com/item?id=26002656</a>
I do think clear writing is an indication of clear thinking, which leads to clear programming. However, technical writing is a real job with real work involved. To make developers write all the documentation is the same management mentality some places have about hiring “full-stack engineers.” The places I’ve worked at with truly excellent documentation had full-time technical writers that collaborated with engineers.
Not sure if this is specific to this book, or Apress in general, but it seems absurd that the eBook sells for $29.99, but you can also buy each chapter individually for $29.95?<p>The $29.99 is more than reasonable as a price for the book. But who would be looking to spend the same price and receive only a chapter? Seems almost like some sort of trick to hopefully get a customer to unintentionally buy only a single chapter.
You can read it with your ACM/O'Reilly subscription => <a href="https://www.oreilly.com/library/view/docs-for-developers/9781484272176/" rel="nofollow">https://www.oreilly.com/library/view/docs-for-developers/978...</a>
I saw this book mentioned on twitter, the author(s) were hyping it. I'd love to buy the ebook but I don't want to have to register or accept any TOS, I just want to give money and download the epub format. Everywhere I've looked requires creating an account. I see it's available on Amazon but... well, I don't want Kindle format and also would prefer almost any other seller.
Lots of talk about documentation in this thread but returning to the book: has anyone read it or seen an independent review yet? I've seen the authors hyping its release; now I want to know if it's any good :)
Not very much off-topic, I wish someone makes <a href="https://docusaurus.io" rel="nofollow">https://docusaurus.io</a> as a service.