The mission of technical communication
The mission of technical communication is light.
The developers build the cathedral. The technical communicators bring light into the building so that it can be used.
Rose window in Toledo // flickr: wentzelepsy
What type of light sources should be used? Halogen? Sunlight? LEDs?
How should the light source be handled? Chandeliers? Stained glass? Floodlights?
In technical communication, external constraints help to determine how information is delivered. Here are a few typical ones:
- Medical device documentation is regulated, so the documentation must meet the requirements of the regulatory body.
- The form factor of the product can drive documentation decisions. (A printer with a tiny, one-line screen versus a printer with a large, color touchscreen.)
- A product that is downloaded (as opposed to purchased in a box) will require documentation that accompanies the download or is available online.
About the author
Techquestioner
I’ve always loved Gothic architecture, soaring spaces, and stained-glass windows, and I love your metaphor. Without light, visitors to the most beautiful space cannot see or appreciate it.
Without the guidance of at least some help or documentation, users may not be able to “see” how to install, use, or apply the product.
Craig
I agree 99.9 percent. I might rephrase the second sentence a wee bit. I would say something like, “The technical communicators bring light into the building so you can see where you’re going.”
The “so it can be used” might ruffle a few feathers, and get a response such as, “Are you saying our software is useless?”
Or maybe I’m being overly cautious.
Tom Johnson
What role do technical communicators play in the bazaar?
Sarah O'Keefe
@Craig: I could torture the metaphor further and point out the good design means that the building gets natural light and doesn’t need a lot of work from the tech writers. But I won’t. 🙂
@Tom: “Haggling for Dummies”?
Jason
Watching/reading Pillars of the Earth? 😉
Great metaphor.