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: What do you call your examples? From:"Joyce Fetterman" <Joycef -at- gtsoftware -dot- com> To:"Wendy Loreti" <wloreti -at- gmail -dot- com>, <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Thu, 30 Aug 2007 16:24:46 -0400
<< The problem I have with Company1 and Company2 or John Smith is that
it doesn't ring true in the mind of the user. I like to work on the
theory that realistic but fake is the best way to go.>>
As usual, I suspect it all boils down to the audience. I write software
documentation aimed at high-level users (developers), and I use examples
such as CompanyName1 and UserName2 because there's no distraction. When
I see recognizable names -- or fun fanciful ones -- I get distracted
sometimes.
I took a quick poll of the developers here: they prefer the generic
examples rather than recognizable names and they cited the same reasons.
On screen samples, it's a bit different: I might have John Smith or Mary
User, but I'm long past the days when I spent time trying to come up
with cute names.
Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include support for Windows Vista & 2007
Microsoft Office, team authoring, plus more. http://www.DocToHelp.com/TechwrlList
True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity! http://www.helpandmanual.com
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-