sâmbătă, 22 ianuarie 2011

Technical Writing and why I don’t do it very well at this moment

 

The issue of technical writing and how well a programmer does it hasn’t bothered me in the past before. I used to think that in order to be a good programmer you have to know your programming language, some algorithms and, depending on your domain, some database stuff, some OOP, or, god forbid, some low level assembler or even microcontroller programming.

But for the last 3-4 months my views have shifted towards a more open style of communication and knowledge sharing, and, as I had to write more and more technical documents @ my work place, I started to think about what should be in a TD and the flow of language and ideas that must reside there.

So, why I’m not good @ technical writing? For one, I am not a good writer, of anything. Secondly, I ‘ve started late and need to catch up. Practice makes perfect. And the last one… I must improve my programming skillsSmile

So, there. Three reasons why I’m not good at this…

Improving takes time and you can’t be a great writer without being a good reader, so here are some books I’m going to get this year:

http://www.amazon.com/Developing-Quality-Technical-Information-Handbook/dp/0131477498/ref=sr_1_9?ie=UTF8&qid=1295697433&sr=8-9

http://www.amazon.com/First-Style-Guide-Computer-Industry/dp/0137058268/ref=pd_sim_b_2

http://www.amazon.com/Elements-Technical-Writing-Gary-Blake/dp/0020130856/ref=pd_sim_b_3