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.
This is how I handle the issue of contant revisions:
- If a chapter has minor revisions (less than half of the chapter has
changed), I just reprint the revised pages. I put a date on every page (in
the footer) to keep track of the version.
- If there are additional pages in a chapter, I add letters to the
numbering system. For example, if I needed to insert a new page between
page 1-2 and 1-3, I would number the inserted pages as 1-2a, 1-2b, 1-2c,
and so on. I have never had changes that required going beyond the letter
"Z" so I am not sure how I would handle that. The inserted pages also get
a date in the footer - just the month and year.
- I send just the changed pages to the printer.
- When distributing the changed pages to the users, I include instructions
that they are to replace the old pages and leave pages that do not have a
corresponding new page. My audience is used to this sort of thing and they
are not confused by it.
I hope this helps.
----------
> From: Ava Carmel <Ava -at- escmed -dot- com>
> To: TECHWR-L -at- listserv -dot- okstate -dot- edu
> Subject: Constant Revisions
> Date: Thursday, August 28, 1997 10:14 AM
>
> Help!
> I am constantly revising a number of manuals for machines which change
> every day. The manuals are presently spiral-bound, but I plan to switch
> to ring binders, so as to be able to replace individual pages or
> chapters, rather than reprinting the entire manual for every new
> revision. About five out of seven chapters remain the same in each
> revision. Sometimes the changes in the other chapters are minor, but
> there are times when the changes are major and all the screen grabs have
> to be updated.
>
> Each manual has a code number and a revision number. I work in Word 7,
> and the page numbering is 1-1, 1-2, etc.
>
> What is the best way to keep track of the revisions, which will be
> coming out about once a month for each of the machines? Should I
> reprint single pages or entire chapters? How should I number the pages?
>
> Should I send the entire manual out for printing and then photocopy
> individual pages that are changed, or order pages as needed?
>
> Ava Carmel
>
> TECHWR-L (Technical Communication) List Information: To send a message
> to 2500+ readers, e-mail to TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU -dot- Send commands
> to LISTSERV -at- LISTSERV -dot- OKSTATE -dot- EDU (e.g. HELP or SIGNOFF TECHWR-L).
> Search the archives at http://www.documentation.com/ or search and
> browse the archives at http://listserv.okstate.edu/archives/techwr-l.html
>
TECHWR-L (Technical Communication) List Information: To send a message
to 2500+ readers, e-mail to TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU -dot- Send commands
to LISTSERV -at- LISTSERV -dot- OKSTATE -dot- EDU (e.g. HELP or SIGNOFF TECHWR-L).
Search the archives at http://www.documentation.com/ or search and
browse the archives at http://listserv.okstate.edu/archives/techwr-l.html
