When I was growing up, kids could either be “Math” kids or “English\/writing” kids. Now that I’m older, I find this notion silly — the skills for both are very similar. Being able to critically think, break down large problems into understandable chunks, and having a decent memory are all skills that would benefit you in both areas. Back in the day though, the rivalry was real.<\/p>\n\n\n\n
I’ve really found value in well-written documentation, especially in the tech world. In fact, if there’s a code package out there that doesn’t have good support in the form of understandable written documentation it’s an automatic “NO” from me. Trying to comb through the source code of the package and stack overflow for implementation examples is fine if you have a really rare particular problem, but not if you’re just trying to figure out how to install the package!<\/p>\n\n\n\n
On the project side of things, I really believe that having written documentation is key to having a successful project. Sometimes it’s hard to focus on the writing and planning portion of a project because it doesn’t give the immediate gratification of building something or fixing a bug. It also takes time, and taking the time to write things down may feel like a slow down. However, I really feel like just the practice of having to explain your thoughts in a document is well worth the effort, and having a design document that your entire team has read, reviewed, and agreed on can be the difference between a success and a failure. Deciding on architecture upfront can save you from trying the headache of integrating parts of your code ahead of time. And you can stay flexible! If you’re writing down your reasons for choosing to do something a certain way, switching will be easier to justify if you compare it against the original reasons. <\/p>\n\n\n\n
I know it can be daunting, especially when you’re just starting out but writing is like a muscle. The more you practice, the easier it becomes over time.<\/p>\n\n\n\n
<\/p>\n","protected":false},"excerpt":{"rendered":"
When I was growing up, kids could either be “Math” kids or “English\/writing” kids. Now that I’m older, I find this notion silly — the skills for both are very similar. Being able to critically think, break down large problems into understandable chunks, and having a decent memory are all skills that would benefit you … Continue reading “A case for writing”<\/span><\/a><\/p>\n","protected":false},"author":11566,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[1],"tags":[],"class_list":["post-14","post","type-post","status-publish","format-standard","hentry","category-uncategorized"],"_links":{"self":[{"href":"https:\/\/blogs.oregonstate.edu\/heymae\/wp-json\/wp\/v2\/posts\/14","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/blogs.oregonstate.edu\/heymae\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/blogs.oregonstate.edu\/heymae\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/blogs.oregonstate.edu\/heymae\/wp-json\/wp\/v2\/users\/11566"}],"replies":[{"embeddable":true,"href":"https:\/\/blogs.oregonstate.edu\/heymae\/wp-json\/wp\/v2\/comments?post=14"}],"version-history":[{"count":1,"href":"https:\/\/blogs.oregonstate.edu\/heymae\/wp-json\/wp\/v2\/posts\/14\/revisions"}],"predecessor-version":[{"id":15,"href":"https:\/\/blogs.oregonstate.edu\/heymae\/wp-json\/wp\/v2\/posts\/14\/revisions\/15"}],"wp:attachment":[{"href":"https:\/\/blogs.oregonstate.edu\/heymae\/wp-json\/wp\/v2\/media?parent=14"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/blogs.oregonstate.edu\/heymae\/wp-json\/wp\/v2\/categories?post=14"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/blogs.oregonstate.edu\/heymae\/wp-json\/wp\/v2\/tags?post=14"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}