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: Parts lists in maintenance manuals From:Don Timmerman <timmerma -at- IPDLINK -dot- IPD -dot- ANL -dot- GOV> Date:Mon, 11 May 1998 08:35:33 -0600
A few short years ago when I was in another life, I documented
auatomation equipment. We included at the end of our
remove-and-replace procedures manual an illustrated (as in exploded
isometric drawings) parts list, which included all the parts
(individual and assembly) the customer could order. We even showed
and included the fasteners in case they got lost during removal and
replacement. That way the customer would know the type and size of
fastener to use.
Don Timmerman, dtimmerman -at- anl -dot- gov
Senior Technical Writer
Argonne National Laboratory (near Chicago)
______________________________ Reply Separator _________________________________
Subject: Parts lists in maintenance manuals
Author: <writejob -at- dnai -dot- com> at ipdlink
Date: 5/8/98 3:52 PM
Hello to hardware writers,
What is your current practice regarding parts lists. If you are writing an
organizational level maintenance manual, do you include just the parts that
appear on the top level of the BOM? For example, PCBs, power supplies, and
complete functional modules such as oscillators or frequency standards and
the like. This question applies to both commercial manuals and manuals done
for military organizations. If you do both -- detailed parts lists and upper
level component parts lists, what percentage of each would you say you do?
We have a discussion going now at work. One camp says limit the parts list
to what the organization is authorized to remove and replace in the field.
The other side says, what the hey, give them a listing of every bit and
piece part in the device.
This assumes that the using organization has not stipulated either choice
and the job is not bid to write removal and replacement procedures for all
the bit and piece parts nor do the troubleshooting procedures go to this
level. The theory write-up is only down to the functional block level and
circuit theory is not discussed.
I'm interested in what the current practice is at this point.