Re: What do you call your examples?

[Ned Bedinger <doc -at- edwordsmith -dot- com>]

Sarah Bouchier wrote:

> I'm always worried in case I use the
> name of a /real/ company.

So right! And it isn't just a problem with company names, is it? I don't 
have a systematic solution for making up company names, but I wish 
someone would sponsor a complete set of example names, addresses, phone 
numbers, ...  I think manuals need realistic examples, and we need to be 
free of whatever liability we're exposed to when we create examples.

Once, on a contract for a networking company (a mini-Cisco sort of 
company), I was writing their documentation using one of their 
e-commerce virtual server addresses as the example for configuring and 
testing a router's internet connection. But when the testers read it, 
they insisted that any internet-routable IP address in the examples 
would become a target for countless pings, probes, masquerades, etc. 
They required any documentation to use only non-internet-routable 
addresses, which never would have occurred to me, since their products 
were internet routers.  Someone should donate an internet-routable IP 
address so that networking component documentation can be realistic.

I like Peter's idea of using a little wordplay to make names based on 
historical names. Phone numbers will always need the 555 exchange (not 
valid anywhere in the world).  Addresses are a vacant lot in my town, 
and business names, ewww, that one is sticky.  I tend to go with Acme 
Backscratcher Mfg.  Feel free to use it :-)


Ned Bedinger
doc -at- edwordsmith -dot- com


^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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- 

To unsubscribe send a blank email to 
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit http://lists.techwr-l.com/mailman/options/techwr-l/archive%40web.techwr-l.com


To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to admin -at- techwr-l -dot- com -dot-  Visit
http://www.techwr-l.com/ for more resources and info.