I was recently asked by a developer colleague to comment on a "functionality and usage guide" he'd written for a piece of mining software. I've written about it here as a classic technical writer's exercise, and a reminder to self that I do have the odd useful skill. With my ill health over the last year each project has dragged on, and it's been a few months since I've had to tackle a new batch of knowledge. I sometimes worry that I've lost It, so it's nice to know I can still parse novel information in a reasonably useful way.
Unfortunately in the process I think I hurt his feelings. Sigh.
( The long middle bit of the story )
Unfortunately for me, the developer had been quite proud of his materials. So, despite the fact they were actually pretty good as developer-supplied raw data goes, they were just not suitable for external eyes. He seemed deeply disappointed.
I, only the other hand, get to write a proper documentation plan, formally assess the raw materials and describe a plan of attack for the project. These things make me happy, and if I feel up to it tomorrow (Saturday) morning, I'll go in to the office for a couple of hours to make a start, and then pop up the road for a bit of Night's Edge. I wish I got to work more often!*
* It's not quite all joy-of-living - I get paid by the hour. No work, no money.
Unfortunately in the process I think I hurt his feelings. Sigh.
( The long middle bit of the story )
Unfortunately for me, the developer had been quite proud of his materials. So, despite the fact they were actually pretty good as developer-supplied raw data goes, they were just not suitable for external eyes. He seemed deeply disappointed.
I, only the other hand, get to write a proper documentation plan, formally assess the raw materials and describe a plan of attack for the project. These things make me happy, and if I feel up to it tomorrow (Saturday) morning, I'll go in to the office for a couple of hours to make a start, and then pop up the road for a bit of Night's Edge. I wish I got to work more often!*
* It's not quite all joy-of-living - I get paid by the hour. No work, no money.