I don’t like writing technical documentations, and I find a lot people do not enjoy writing these documentations either. In a CS project, especially project developed by students or new graduates, documentation gets less attestation than the features and other aspects of the project. Of course it is understandable, the major results of a project is the APIs and web pages for a web project, documentation is very likely to get ignored. However, in some cases, it is critically important, such as documentation for any development tools. <\/p>\n\n\n\n
Documentation helps keep track of all detail information about an application and also improves user experience. Successful documentation will help engineers in couple different aspects: setup, develop and maintain. I became realize the importance of good documentation during my first internship. In a remote working environment, my choices are the documentation, ask for help on company website, search for answers in inside wiki. Often times I find myself lost in those documentations, and wish for a clear guidance. Since then, I always spend time working on the documentation of my projects and put documentation as a task into our project requirements. I wish every engineer can be proud of their effort in documentations and enjoy the good documentation made by others. <\/p>\n","protected":false},"excerpt":{"rendered":"
I don’t like writing technical documentations, and I find a lot people do not enjoy writing these documentations either. In a CS project, especially project developed by students or new graduates, documentation gets less attestation than the features and other aspects of the project. Of course it is understandable, the major results of a project… Continue reading Importance of Technical Documentation<\/span><\/a><\/p>\n","protected":false},"author":11579,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[1],"tags":[],"class_list":["post-40","post","type-post","status-publish","format-standard","hentry","category-uncategorized","entry"],"_links":{"self":[{"href":"https:\/\/blogs.oregonstate.edu\/coolcoder\/wp-json\/wp\/v2\/posts\/40","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/blogs.oregonstate.edu\/coolcoder\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/blogs.oregonstate.edu\/coolcoder\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/blogs.oregonstate.edu\/coolcoder\/wp-json\/wp\/v2\/users\/11579"}],"replies":[{"embeddable":true,"href":"https:\/\/blogs.oregonstate.edu\/coolcoder\/wp-json\/wp\/v2\/comments?post=40"}],"version-history":[{"count":3,"href":"https:\/\/blogs.oregonstate.edu\/coolcoder\/wp-json\/wp\/v2\/posts\/40\/revisions"}],"predecessor-version":[{"id":43,"href":"https:\/\/blogs.oregonstate.edu\/coolcoder\/wp-json\/wp\/v2\/posts\/40\/revisions\/43"}],"wp:attachment":[{"href":"https:\/\/blogs.oregonstate.edu\/coolcoder\/wp-json\/wp\/v2\/media?parent=40"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/blogs.oregonstate.edu\/coolcoder\/wp-json\/wp\/v2\/categories?post=40"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/blogs.oregonstate.edu\/coolcoder\/wp-json\/wp\/v2\/tags?post=40"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}