@jerry-d
Ever try to actually read a technical manual? I mean really read it and not skim it? It’s all accurate info, but so dry as to put the audience into a coma.
In college, my English professors would drill into us that we must write with succinct economy. Every word must be there for a reason and not as unnecessary fluff.
I occasionally find myself playing the role of Technical Writer for projects, business cases, etc. and the work seems at odds with the sage advice from those college professors.
It’s fairly well-established that programmers don’t like to comment their code much less write lengthy documentation about how it integrates with other applications via APIs.
However, that’s exactly what we have to do as part of due diligence prior to getting a system or integrated application out for production use.
I’ve always been conflicted about this disparity, but I suppose I’ve learned to live with it. Anyone else have a similar experience at work or elsewhere?
1 reply
2 recasts
11 reactions