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.
RE: maintaining a list of changes in User Guides between versions
Subject:RE: maintaining a list of changes in User Guides between versions From:"Gordon McLean" <Gordon -dot- McLean -at- GrahamTechnology -dot- com> To:<techwr-l -at- lists -dot- techwr-l -dot- com> Date:Tue, 6 Feb 2007 09:39:03 -0000
I'd use that request and find out what it is the customer wanted.
Previously I have provided a list of 'major' changes to the documentation,
listing new sections (limiting to chapter and H1 levels) or major updates
due to new functionality (excluding 'expected' changes through UI). It's the
kind of thing you can pretty much draw up at the start of project (based on
plans), a then a revision towards the end to reflect reality and you are
good to go.
But of course, as ever, depends on what the customer wants/is expecting.
HTH
Gordon
-----Original Message-----
Beth,
Actually, it is vaguely to do with a discussion of some sort of request
from outside the company and this must have come up as a requirement for
documentation delivered. So I wondered, "Should I be doing this? Will
someone ask me to do this soon? Is everyone doing it except me? If so, what
will I answer when they ask me to document changes in the UGs?"
____________________________________________________________________________________________________
This email (and any attachments) is private and confidential, and is intended solely for the
addressee. If you have received this communication in error please remove it and inform us via
telephone or email. Although we take all possible steps to ensure mail and attachments
are free from malicious content, malware and viruses, we cannot accept any responsibility
whatsoever for any changes to content outwith our administrative bounds. The views represented
within this mail are solely the view of the author and do not reflect the views of the organisation
as a whole.
____________________________________________________________________________________________________
Graham Technology plc
Registered in Scotland company no. SC143434
Registered Office India of Inchinnan, Renfrewshire, Scotland PA4 9LH
Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include single source authoring, team authoring,
Web-based technology, and PDF output. http://www.DocToHelp.com/TechwrlList
Now shipping: Help & Manual 4 with RoboHelp(r) import! New editor,
full Unicode support. Create help files, web-based help and PDF in up
to 106 languages with Help & Manual: http://www.helpandmanual.com
---
You are currently subscribed to TECHWR-L as archive -at- infoinfocus -dot- com -dot-