It is my belief that a user-centered approach makes good (that is, actually useful) product documentation. This is not rocket science, and is in some ways self-evident.
The users have to – well – use these products, so it seems absurd not to keep these users in mind when developing documentation for them. It means that common sense should be used to produce a product that is neither unnecessarily complicated nor overly simple but simply usable and effective (of course, keeping within budget and time constraints).
In other words, documentation should not insult the intelligence of the user nor should it baffle the user. It should accomplish what it was (presumably) produced for – assisting the user to accomplish tasks.
This professional vision has come about through years of experience working for both small and large companies documenting a wide range of products. Below is a summary of this experience and associations that have led to this approach.
B.A. Honours English and History from the University of Waterloo in Waterloo, Ontario Canada: As a university that prides itself in its excellence in engineering, my degree has been influenced by engineering practices. It has also given me a healthy respect for human factors when designing and developing technical documentation.
Technical Writer since 1994: Each new task brings with it new challenges and opportunities for learning and growing in this profession and to deepen my understanding of what constitutes quality technical documentation.
Continual education: Technical Writing as a profession doesn’t stand still. It changes with the times, and so does my skill set. As time and resources allow, I upgrade my skills. Tekom, STC, and other TW colleagues keep me informed of trends.
Website development since 1996: Although not central to the role of a technical writer, website development is becoming an important tool in a technical communicator’s toolkit. Through GJL Webweavers (founded 1996), I have had the opportunity to dabble in this technology. Recently, I’ve been focused on WordPress blogging.
Native English writer (and speaker, of course): For good or ill, English has become the primary language of commerce, and this means most documentation meant for a international audience is written in English.
Award-winning technical writer: The Society for Technical Communication holds competitions. I participated as both judge and submitter of work. Thesee competitions gave me an insight into the quality of my work and into what constitutes excellence in techical writing. I received a few awards through these competitions, including the Award of Achievement and Best Judging Team.
Membership in non-technical communication related organizations: A well-balanced life means having interests other than work. These organizations remind me that there is more to life than just my profession. These include, in no particular order, Deutsch-Kanadischer Business Club (DKBC) Berlin-Brandenburg e.V., the Berlin Historical Association, and the Christadelphian Church.
