TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
Subject:Re: Understanding the things you document From:"Wing, Michael J" <mjwing -at- INGR -dot- COM> Date:Wed, 7 Jul 1999 10:28:25 -0500
I document at the API level. I must have an understanding of automation and
Visual Basic for all projects. This is because I write my own example code
and programming instructions.
On some other products (the internet-based ones), I am an SME. For these
products I write the programming manuals, provide on-site and local
training, and go out in the field to do ASP/DHTML programming. This
requires in-depth knowledge of the products; however, it provides some
opportunities for travel (2 weeks in Denmark in June was not too hard to
> With everything I've documented in the past, I have always understood at
> some level how the device or program worked. I'm getting the picture at my
> new job that understanding the program is secondary to producing the
> documentation. Do other writers face this same challenge?
> Jonathan Soukup