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.
How exactly do *you* (yep, it's an opinion question, g*d forbid!) go about using examples in manuals that get your point across? I'm curious to see whether you use cute names, humor, or "real" people (the Vice President of Finance), and which you feel is most effective in *your* situation at the present time. Also, if it is effective, do you ever think the circumstances will change? If it is "not" effective, what would you change?
(There's a method to my madness, I'm trying to make a case for a standard type of example in "our" user manuals, and I haven't decided which way to go yet...)
Lisa Comeau
IS Super-User/Trainer
Certification and Testing Division
Canadian Standards Association
Rexdale, ON
comeaul -at- csa -dot- ca