{"id":78,"date":"2004-02-07T23:04:29","date_gmt":"2004-02-08T05:04:29","guid":{"rendered":"http:\/\/www.minnesotageek.net\/wordpress\/?p=78"},"modified":"2004-02-07T23:04:29","modified_gmt":"2004-02-08T05:04:29","slug":"documentation-part-1-how-do-you-decide-what-to-document-part-1","status":"publish","type":"post","link":"http:\/\/www.minnesotageek.net\/wordpress\/?p=78","title":{"rendered":"Documentation &#8211; Part 1 &#8211; How do you decide what to document? &#8211; Part 1"},"content":{"rendered":"<p>As a new tech support person, one the difficult things for me to learn was what to document.  If you document everything, you&#8217;ll quickly get buried in the process.  You&#8217;ll spend your day documenting instead of fixing things.  If you document too little, you won&#8217;t be able to look up the resolution to a problem you solved six months ago so you don&#8217;t have to reinvent the wheel again.<\/p>\n<p>Here is my suggestion:  <\/p>\n<p>Think about the question you are being asked or the problem you are solving.  If you can solve the problem in a minute or less, it is probably unneccessary to document it.  For example, if a user stops me in the hall and says, &#8220;How do you make text bold in Microsoft Word?&#8221; I would simply tell the user how to do it and then forget about.  I wouldn&#8217;t run right back to my desk and document that I had been asked that question.  <\/p>\n<p>If the problem takes between 1 minute and 10 minutes to solve, it might be worth documenting it.  It will depend on the problem, the user, and the solution.  I hate to be this vague, but it is simply a judgement call.<\/p>\n<p>If it takes you more than 10 minutes to solve it, you should definitely document it.  You&#8217;ll want a record of it so if you have to do it again, you&#8217;ll remember what you did and so when someone asks you why it is taking so long to finish another task you needed to do, you can say, &#8220;Here!  I was working on this!&#8221;<\/p>\n<p>In my next post, I&#8217;ll tell you what we use to do our documentation.<\/p>\n<p>&#8211;Pete<\/p>\n","protected":false},"excerpt":{"rendered":"<p>As a new tech support person, one the difficult things for me to learn was what to document. If you document everything, you&#8217;ll quickly get buried in the process. You&#8217;ll spend your day documenting instead of fixing things. If you document too little, you won&#8217;t be able to look up the resolution to a problem [&hellip;]<\/p>\n","protected":false},"author":2,"featured_media":0,"comment_status":"closed","ping_status":"","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[13],"tags":[],"class_list":["post-78","post","type-post","status-publish","format-standard","hentry","category-tech-tips"],"_links":{"self":[{"href":"http:\/\/www.minnesotageek.net\/wordpress\/index.php?rest_route=\/wp\/v2\/posts\/78","targetHints":{"allow":["GET"]}}],"collection":[{"href":"http:\/\/www.minnesotageek.net\/wordpress\/index.php?rest_route=\/wp\/v2\/posts"}],"about":[{"href":"http:\/\/www.minnesotageek.net\/wordpress\/index.php?rest_route=\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"http:\/\/www.minnesotageek.net\/wordpress\/index.php?rest_route=\/wp\/v2\/users\/2"}],"replies":[{"embeddable":true,"href":"http:\/\/www.minnesotageek.net\/wordpress\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=78"}],"version-history":[{"count":0,"href":"http:\/\/www.minnesotageek.net\/wordpress\/index.php?rest_route=\/wp\/v2\/posts\/78\/revisions"}],"wp:attachment":[{"href":"http:\/\/www.minnesotageek.net\/wordpress\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=78"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"http:\/\/www.minnesotageek.net\/wordpress\/index.php?rest_route=%2Fwp%2Fv2%2Fcategories&post=78"},{"taxonomy":"post_tag","embeddable":true,"href":"http:\/\/www.minnesotageek.net\/wordpress\/index.php?rest_route=%2Fwp%2Fv2%2Ftags&post=78"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}