{"id":2661,"date":"2018-11-06T10:31:52","date_gmt":"2018-11-06T10:31:52","guid":{"rendered":"https:\/\/www.appservgrid.com\/paw92\/?p=2661"},"modified":"2018-11-07T14:21:16","modified_gmt":"2018-11-07T14:21:16","slug":"the-eight-rules-of-good-documentation-linux-com","status":"publish","type":"post","link":"https:\/\/www.appservgrid.com\/paw92\/index.php\/2018\/11\/06\/the-eight-rules-of-good-documentation-linux-com\/","title":{"rendered":"The Eight Rules of Good Documentation | Linux.com"},"content":{"rendered":"<p>If useful documentation is so important to the success of projects and developer well-being, why don&#8217;t all projects have it? The answer, I believe, is that like good code, good documentation is difficult and time consuming to write.<\/p>\n<p>In my eyes, there are eight rules that we can follow to produce good documentation:<\/p>\n<ol>\n<li>Write documentation that is inviting and clear<\/li>\n<li>Write documentation that is comprehensive, detailing all aspects of the project<\/li>\n<li>Write documentation that is skimmable<\/li>\n<li>Write documentation that offers examples of how to use the software<\/li>\n<li>Write documentation that has repetition, when useful<\/li>\n<li>Write documentation that is up-to-date<\/li>\n<li>Write documentation that is easy to contribute to<\/li>\n<li>Write documentation that is easy to find<\/li>\n<\/ol>\n<p><a href=\"https:\/\/www.linux.com\/learn\/eight-rules-good-documentation\" target=\"_blank\" rel=\"noopener\">Source<\/a><\/p>\n","protected":false},"excerpt":{"rendered":"<p>If useful documentation is so important to the success of projects and developer well-being, why don&#8217;t all projects have it? The answer, I believe, is that like good code, good documentation is difficult and time consuming to write. In my eyes, there are eight rules that we can follow to produce good documentation: Write documentation &hellip; <\/p>\n<p class=\"link-more\"><a href=\"https:\/\/www.appservgrid.com\/paw92\/index.php\/2018\/11\/06\/the-eight-rules-of-good-documentation-linux-com\/\" class=\"more-link\">Continue reading<span class=\"screen-reader-text\"> &#8220;The Eight Rules of Good Documentation | Linux.com&#8221;<\/span><\/a><\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[1],"tags":[],"class_list":["post-2661","post","type-post","status-publish","format-standard","hentry","category-linux"],"_links":{"self":[{"href":"https:\/\/www.appservgrid.com\/paw92\/index.php\/wp-json\/wp\/v2\/posts\/2661","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.appservgrid.com\/paw92\/index.php\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.appservgrid.com\/paw92\/index.php\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.appservgrid.com\/paw92\/index.php\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.appservgrid.com\/paw92\/index.php\/wp-json\/wp\/v2\/comments?post=2661"}],"version-history":[{"count":1,"href":"https:\/\/www.appservgrid.com\/paw92\/index.php\/wp-json\/wp\/v2\/posts\/2661\/revisions"}],"predecessor-version":[{"id":2827,"href":"https:\/\/www.appservgrid.com\/paw92\/index.php\/wp-json\/wp\/v2\/posts\/2661\/revisions\/2827"}],"wp:attachment":[{"href":"https:\/\/www.appservgrid.com\/paw92\/index.php\/wp-json\/wp\/v2\/media?parent=2661"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.appservgrid.com\/paw92\/index.php\/wp-json\/wp\/v2\/categories?post=2661"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.appservgrid.com\/paw92\/index.php\/wp-json\/wp\/v2\/tags?post=2661"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}