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: Do you log your changes? From:Tony Chung <tonyc -at- tonychung -dot- ca> To:techwr-l -at- lists -dot- techwr-l -dot- com Date:Sun, 24 Jan 2010 10:12:45 -0800
In a former company we mantained 2 different change history tables in
the same document. The first was a detailed log for internal use, the
second was a more general log highlighting significant details only.
The detailed log was stripped with the signoff pages before releasing
to customers. This system worked really well.
As to "why" we log the changes: I think it's evident that nobody can
remember the history of every single change. Multiple authors could
overstep each other without understanding the history. And yes, doc
problems do exist. Not every change is due to a product spin.
Sometimes changes to the doc only are needed for specific customer or
legal issues.
Cheers!
-Tony
--
Tony Chung: Creative Communications
Cell: +1-604-710-5164
Email: tonyc -at- tonychung -dot- ca * Web: http://tonychung.ca
Skype: tonychung.ca * GTalk/MSN: tonychung -dot- ca -at- gmail -dot- com
Twitter: @techcom * Facebook: http://www.facebook.com/tonychung.ca
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Are you looking for one documentation tool that does it all? Author,
build, test, and publish your Help files with just one easy-to-use tool.
Try the latest Doc-To-Help 2009 v3 risk-free for 30-days at: http://www.doctohelp.com/
Explore CAREER options and paths related to Technical Writing,
learn to create SOFTWARE REQUIREMENTS documents, and
get tips on FUNCTIONAL SPECIFICATION best practices. Free at: http://www.ModernAnalyst.com
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-
