RE: Tracking Documentation History

Subject: RE: Tracking Documentation History
From: "Sarah L Blake" <sarah -dot- blake -at- exony -dot- com>
To: <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Fri, 27 Jun 2008 12:39:54 +0100

Further to other people's comments, I might suggest that if you decide
to keep an /internal/ documentation history (even if it's only in the
revision history section of your source control tool!) you also note
/who asked you to make a particular change/.

"Removed hoojiwotsit section as hoojiwotsit not in this release" is all
very well, but we've all performed the feature hokey-cokey, and when
someone later says, 'Why isn't hoojiwotsit documented?' it's nice to be
able to track where the communication broke down.

-----------------------------------------
Sarah Blake
Technical Author

exony

______________________________________________________________________
This email has been scanned by the MessageLabs Email Security System.
For more information please visit http://www.messagelabs.com/email
______________________________________________________________________
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include support for Windows Vista & 2007
Microsoft Office, team authoring, plus more.
http://www.DocToHelp.com/TechwrlList

True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity! http://www.helpandmanual.com

---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit http://lists.techwr-l.com/mailman/options/techwr-l/archive%40web.techwr-l.com


To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
http://www.techwr-l.com/ for more resources and info.


References:
Tracking Documentation History: From: Ronquillo, Michael

Previous by Author: RE: Commute/Flex work options a Deal breaker?
Next by Author: Word 2003 TOC and Headings - Bold Numbering
Previous by Thread: Re: Tracking Documentation History
Next by Thread: RE: Tracking Documentation History


What this post helpful? Share it with friends and colleagues:


Sponsored Ads