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: Change History Tables From:Linda Sherman <linsherm -at- GTE -dot- NET> Date:Sat, 23 Jan 1999 13:55:53 -0500
Dave Neufeld wrote:
>
> I'd like to hear the pros and cons of including document change history
> tables in user documents. Please e-mail me personally and I'll try really
> hard to post a summary if it gets interesting...
I can conceive of exceptions, most notably in the engineering
specifications for complex systems such as aircraft, but as a rule, I
don't like it. I'm currently working with some government documents that
include complete change history for the document (as opposed to the file
formats being documented), and as far as I can tell, it only adds 100
pages to an already hefty manual without telling me one useful thing.
A reasonable compromise is to provide users the option of printing the
change history from a .pdf file.
Lin
--
Linda K. Sherman <linsherm -at- gte -dot- net>
Computer programming, technical writing, web development
phone: 1-727-842-6756 fax: 1-727-842-6853
