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.
... So, anyone have research on best practices on indicating changed
documents? In the old old days, documentation departments used to issue
docs with multidigit version numbers, change bars, and change pages.
Later, tech writers did away with change bars and relied on summary paras
of "what's new" similar to Readme files. Then some folks did away with
these altogether relying instead on just the date of the document. Then
even these seem to disappear.
What are you doing that seems to work with your users? Any advice'd be
most appreciated....
______________________________________________
We automatically assign a part number to each manual using our "Request for
Part Number" database. When there is a change to the manual that affects
the form, fit or function of the subject of the manual, then we write an
"Engineering Change Notice", make the changes and assign a new revision
level (A (original issue) through Z). The change notice is generated and
stored in our Lotus Notes database and entered in our Oracle engineering
database. We print all our manuals "on demand" and so the latest revision
version is always going out to the next customer. Since our location
generates manuals for approximately 40 different analyzers, it keeps us in
line.
We manufacture process analyzers and this works for us since all of our
parts and assemblies are created and revised in the same way. Our manuals
are stored in Source Safe to further document and presewrve the revision
process. PDF versions are avaliable on our shared drive and are updated
when a new revision is created. The pdf version is always available to mail
to any customer who wants an updated manual.
Liz Goodwin
Technical Writer, Process Instruments
AMETEK, P&AI
liz -dot- goodwin -at- ametek -dot- com
"In order to keep a true perspective of one's importance, everyone should
have a dog that will worship him and a cat that will ignore him." - Dereke
Bruce
NEED TO PUBLISH FRAMEMAKER CONTENT ONLINE? "Mustang" is a NEW single
sourcing tool for FrameMaker that lets you easily publish your content
online. No macro language required! http://www.ehelp.com/techwr-l3
Mercer University's online MS Program in Technical Communication Management:
Preparing leaders of tomorrow's technical communication organizations today.
See www.mercer.edu/mstco or write George Hayhoe at hayhoe_g -at- mercer -dot- edu -dot-
---
You are currently subscribed to techwr-l as:
archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit http://www.raycomm.com/techwhirl/ for more resources and info.
