{"id":793,"date":"2011-02-11T21:07:50","date_gmt":"2011-02-12T04:07:50","guid":{"rendered":"http:\/\/www.apolonio.com\/blog\/?p=793"},"modified":"2011-02-11T21:23:15","modified_gmt":"2011-02-12T04:23:15","slug":"producing-documentation","status":"publish","type":"post","link":"https:\/\/www.apolonio.com\/blog\/?p=793","title":{"rendered":"Producing Documentation"},"content":{"rendered":"<p>I had an extremely interesting conversation with my boss today regarding documentation.<\/p>\n<p>I work in the IT industry and there seems to be a mistaken belief amongst some that not documenting certain processes will preserve ones job role.<\/p>\n<p>Maybe&#8230;<\/p>\n<p>To me, it illustrates couple bad things&#8230;<\/p>\n<p><em>Laziness<\/em><br \/>\nOn two levels&#8230; the first is simply one may be too lazy to document&#8230; they don&#8217;t want to open up word, sharepoint, the wiki, onenote or whatever tool you use to document what it takes to do what you did&#8230; the second is more long term, whatever process that was learned may have been difficult to find out, there may have been gotchas, nuances that made the solution very difficult to come by and now they want to rest on their laurels.\u00a0 They don&#8217;t want to learn anything else.<\/p>\n<p><em>Poor Team Player<\/em><br \/>\nThese types forge their own little empires within their workspace.\u00a0 They want people to come to them for certain tasks and want to dictate pace and workflow on their terms.\u00a0 There is is no way for this person to hand off these tribal tasks to someone else to go and run with it.<\/p>\n<p><em>Fear of Peer Review<\/em><br \/>\nWhen a person documents, they are declaring to the team and maybe a wider audience what they know.\u00a0 There is a fear that what they know, may be wrong, or worse, someone may have a better solution and may upstage their work.<\/p>\n<p><em>Disorganized<\/em><br \/>\nFailure to document usually leads to disorganization.\u00a0 If one makes a change to fix a problem today, why was it changed?\u00a0 Will you know why tomorrow?\u00a0 Will you know why next year?\u00a0 As time goes on, all that stuff in that person&#8217;s head WILL get jumbled and confused.<\/p>\n<p>Earlier in this blog post I said &#8220;maybe&#8230;&#8221; and here is why, you will be stuck in a position that only you can do, where you cannot branch out, extend and grow.\u00a0 You will be stuck doing the same job, because only you can do it, whereas others can hand the job off.\u00a0 Let&#8217;s look at those characteristics from another the opposite site.<\/p>\n<p><em>Organized<\/em><br \/>\nWhen you document, you will show to everyone you can keep track of many things and be able to reference back to them.\u00a0 Because everything has its place and you can do more things. You can take on new more interesting projects because your manager will trust the documentation you provide will help the organization, you can do bigger more meaningful projects.<\/p>\n<p><em>Welcome Peer Review<\/em><br \/>\nYes it is an ego thing if you are wrong, get over it. Being a professional, I would like to know I am wrong and fix the problem so I don&#8217;t make things worse.\u00a0 You will learn how to do things more.\u00a0 Over 20 years, I have been wrong many times, I have done some stupid things, I don&#8217;t make too many errors anymore.\u00a0 So I absolutely welcome peer review because it keeps me moving towards perfection and peer acceptance.\u00a0 To me, its better to admit a mistake and make it right, then to have it blow up later down the road. Also, if something goes wrong, there will be a greater understanding of why things went wrong.<\/p>\n<p><em>Understands being a Team Player<br \/>\n<\/em>There is this goal that an organization tries to achieve, its usually written in some mission statement, or contract, etc.\u00a0 But there is a goal and it is much easier to reach that goal if you work as a team.\u00a0\u00a0 Keeping tribal knowledge weakens the team, because you have less skills throughout to make the team strong and there is less of an understanding on what your team mates tendencies are.\u00a0 For example, say you are a great at account creation, you teach others how to create accounts, all the little details are documented, where home directories are and password requirements.\u00a0 When a user has trouble accessing their home directories, the person in charge of the file server can look at the process without the original account creator to resolve this problem more quickly.<\/p>\n<p><em>Does (Makes) More<br \/>\n<\/em>Originally I titled this works hard to counter the laziness tag, but really, a person that documents properly will be able to do more and the new stuff they do will be interesting.\u00a0 Think of it from a management&#8217;s point of view, this person shows he can document, shows he can do more, shows a willingness to educate peers.\u00a0 The organization as a whole is way better off.\u00a0 This person completed this project, this person fixed this problem, this person is willing to learn, this person is willing to get criticized. Who do you think will make more?<\/p>\n<p>Me personally, I would place odds on the player that documents better.<\/p>\n<p>So what does this have to do with a blog that primarily focuses on training and weightloss.\u00a0 Well first off recall that this is a new blog and I want to add more than just weight loss, but more importantly, I want to document, my weight loss methods so people will critique me and so I can do things maybe better.<\/p>\n<p>Hit gym today, can&#8217;t work out as hard as I usually do per Doctors orders.\u00a0 She said gradually work into it over the course of a week.<\/p>\n","protected":false},"excerpt":{"rendered":"<p>I had an extremely interesting conversation with my boss today regarding documentation. I work in the IT industry and there seems to be a mistaken belief amongst some that not documenting certain processes will preserve ones job role. Maybe&#8230; To &hellip; <a href=\"https:\/\/www.apolonio.com\/blog\/?p=793\">Continue reading <span class=\"meta-nav\">&rarr;<\/span><\/a><\/p>\n","protected":false},"author":2,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[11,3],"tags":[],"class_list":["post-793","post","type-post","status-publish","format-standard","hentry","category-technical","category-training"],"_links":{"self":[{"href":"https:\/\/www.apolonio.com\/blog\/index.php?rest_route=\/wp\/v2\/posts\/793","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.apolonio.com\/blog\/index.php?rest_route=\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.apolonio.com\/blog\/index.php?rest_route=\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.apolonio.com\/blog\/index.php?rest_route=\/wp\/v2\/users\/2"}],"replies":[{"embeddable":true,"href":"https:\/\/www.apolonio.com\/blog\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=793"}],"version-history":[{"count":8,"href":"https:\/\/www.apolonio.com\/blog\/index.php?rest_route=\/wp\/v2\/posts\/793\/revisions"}],"predecessor-version":[{"id":796,"href":"https:\/\/www.apolonio.com\/blog\/index.php?rest_route=\/wp\/v2\/posts\/793\/revisions\/796"}],"wp:attachment":[{"href":"https:\/\/www.apolonio.com\/blog\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=793"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.apolonio.com\/blog\/index.php?rest_route=%2Fwp%2Fv2%2Fcategories&post=793"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.apolonio.com\/blog\/index.php?rest_route=%2Fwp%2Fv2%2Ftags&post=793"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}