Talking to Myself
One of the things that technical writers have to deal with in the course of our jobs is prying information out of the developers, and keeping the information up to date as development progresses. I’m both the developer and the technical writer on my current project, which means that I’m very well-informed as to what’s going on. I have also discovered that it can be downright tedious having to pause during development in order to document what I’m doing. However, any tediousness is far outweighed by being able and come back the next day and know what I was doing.
The down side to being both the technical writer and the developer is that although I know what I was talking about, I am not convinced that the documentation speaks to the end user. I’ve dropped off copies and am awaiting feedback. Fingers crossed that it makes sense.
Powered by FireStats
September 29th, 2003 at 4:33 pm
Having read what you wrote in the course of your last job, I have no doubt it will make sense.
August 2nd, 2004 at 4:32 pm
[...] you add something, delete something, or make a change to the application, write it down. I know it’s a pain the ass, but it does not even compare to the pain I will inflict upon tho [...]