The perfect technical author can:
- act as a novice user member of the target audience of the product
- be an expert in understanding all aspects of the product
- be technically adept in the technologies needed to deliver the information to users
- create content in a way that is organised & repeatable, managed & sustainable, while working in a environment that is often ad hoc and chaotic
- manage and deliver projects on time, relying on colleagues who do not report to them
- round up all the useful and relevant content written by others about the product and then present it in a meaningful and useful way
- write clearly and unambiguously in many languages, and
- can measure the value of the work they produce (to the organisation and the users).
[…] The perfect technical author Gordon | June 16, 2009 | permalink […]
I’d maybe swap “novice user” for “member of the target audience”. Domain knowledge is key here, no?
If technical authors can do all of that, or even just most of that, why do IT recruiters still ask us whether we can write code?
[…] Update 17 June 2009: Ellis Pratt at CherryLeaf has just published “The Perfect Technical Author” at: http://www.cherryleaf.com/blog/2009/06/the-perfect-technical-author/ […]
[…] you aim to be the perfect technical author than take a look at the Cherryleaf Technical Authors blog and see how you’re […]
I’m not so sure about “write clearly and unambiguously in many languages.” That’s a pretty rare capacity! How about “write prose that can be translated into multiple languages.”