Re: Numbered Callouts

Subject: Re: Numbered Callouts
From: "Tom Johnson" <tjohnson -at- freeway -dot- net>
To: "TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Wed, 2 Feb 2005 13:25:49 -0500


It doesn't have to be hard. It takes neatly numbering the parts and
creating two lookup tables. One table organized by part name and the
other organized by part number. It has limitations, but if we're
trying to do our readers a service and make information accessible, it
is may be worth the effort. Unless you're working on a product with
tens of thousands, or millions, of parts. Of course, that would
require sorting which Frame doesn't do.

The big question is how will people look up the information. Are you
trying to find where a part is located, or are you trying to identify
a part that you know where it is, but have no idea what it is called.
It all goes back to one of the top-ten rules of techwriting, "Know
your audience."

Susan Gallagher Wrote:
> > I'm so glad I've never had to do this, because IMO there's
> > no good way. Either things are numbered in alphabetical order
> > and the numbers are scattered willy-nilly over the illustration,
> > or the numbers on the illustration are in a reasonable order
> > and the list is arranged numerically so it's impossible to
> > scan the list for a specific feature (e.g. where's the
> > mute button???).
>

And Eric Dunn replied:

> I've seen it all.
>
> 1 - Numbering has to match the parts catalogue >> procedure
illustrations
> don't have sequential numbers.
> 2 - Numbered in order of procedure. Which includes all illustrations
> number sequentially and all common part in each illustration keep
the same
> callout.
> 3 - Numbered sequentially (counter-)clockwise.
> 4 - Numbered as per engineering BOM (no logic).
> 5 - Random.
>
> Seems that no matter what the general rule, they all end up looking
like
> the fifth type. ;)
>
--
Tom Johnson
Elk Rapids Engineering
231-264-5661 x. 5033
tjohnson -at- starcutter -dot- com

http://home.core.com


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

WEBWORKS FINALDRAFT - EDIT AND REVIEW, REDEFINED
Accelerate the document lifecycle with full online discussions and unique feedback-management capabilities. Unlimited, efficient reviews for Word
and FrameMaker authors. Live, online demo:
http://www.webworks.com/techwr-l

Technical Communication Certificate online - Malaspina-University College, Canada. Online training in technical writing, software (FrameMaker, RoboHelp, Dreamweaver, Acrobat), document & web design, writing manuals, job search. www.pr.mala.bc.ca/tech_comm.htm for details.

---
You are currently subscribed to techwr-l as:
archiver -at- techwr-l -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- techwr-l -dot- com
Send administrative questions to lisa -at- techwr-l -dot- com -dot- Visit
http://www.techwr-l.com/techwhirl/ for more resources and info.



Previous by Author: Numbered Callouts
Next by Author: Robohelp question: is this possible without going into code?
Previous by Thread: Re: Capitalizing...research need
Next by Thread: RE: Numbered Callouts


What this post helpful? Share it with friends and colleagues:


Sponsored Ads