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: Categories in a Parts Catalog From:"Hannah Drake" <hannah -at- formulatrix -dot- com> To:"'Debbi Crum'" <debbi -dot- crum -at- yahoo -dot- com>, "'Frank Taylor'" <taylor_f -at- netvision -dot- net -dot- il>, <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Mon, 10 Feb 2014 10:33:46 -0500
Don't know if this is helpful or not, but what we do is have the engineers
make an exploded view of the subassemblies and number the parts starting at
1 on each page, then have a table on the same page or on the next page that
lists the number, then the part name/description, then the part number, then
the quantity, and finally a column for "notes" which is either blank or, in
some cases sub-assemblies include other smaller assemblies, and then we list
the page number of where they can find that assembly further broken down.
This way, deciding where to include things falls on the hands of the
engineers, and it's also an extremely logical parts manual. Reader starts
with an overview picture, sees the assembly goes to the page number of that
assembly, sees THAT assembly broken down into other assemblies, and finally
gets to the nitty gritty.
But it depends how complicated your machines are.
-----Original Message-----
From: techwr-l-bounces+hannah -dot- drake=formulatrix -dot- com -at- lists -dot- techwr-l -dot- com
[mailto:techwr-l-bounces+hannah -dot- drake=formulatrix -dot- com -at- lists -dot- techwr-l -dot- com] On
Behalf Of Debbi Crum
Sent: Monday, February 10, 2014 8:55 AM
To: Frank Taylor; techwr-l -at- lists -dot- techwr-l -dot- com
Subject: Re: Categoriesin a Parts Catalog
Frank,
I don't see a problem with listing the parts in both places. I think the
objective should be to ensure the person looking for the part is able to
find it especially since you mentioned that there are only a few that fit
into two categories. I might rethink my strategy if there were so many parts
that fit into more than one category that the parts catalog doubled in size.
If I had to pick a single category...
I'd put the vacuum pump with Vacuum System and the ink temperature gauge
with Ink System.
Hope that helps.
On Monday, February 10, 2014 2:09 AM, Frank Taylor
<taylor_f -at- netvision -dot- net -dot- il> wrote:
I am creating a parts catalog for a machine, for service & support engineers
around the world.
The data shown for each part are: Part No., Photograph of the part, and
Description.
I have a problem with a few parts and their categories.
Should a Vacuum Pump be entered under Pumps or Vacuum System (or even both)?
Should an Ink Temperature Gauge be entered under Gauges or Ink System?
Frank Taylor
Technical Communicator
email: <mailto:taylor_f -at- netvision -dot- net -dot- il> taylor_f -at- netvision -dot- net -dot- il
Looking for articles on Technical Communications? Head over to our online
magazine at http://techwhirl.com
Looking for the archived Techwr-l email discussions? Search our public
email archives @ http://techwr-l.com/archives
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Doc-To-Help: new website, content widgets, and an output that works on any
screen.
