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: Help with Documentation From:"Mike O." <obie1121 -at- yahoo -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Thu, 8 May 2003 05:22:46 -0700 (PDT)
Karen Cromwell wrote:
> I have been providing edits to web sites for the client
Do they want a report on all changes to the site, or just a record of
your recommended edits?
> I need some information on methods of documenting web site changes
If the management really wants to document changes, it's simple: All
they have to do is declare "Thou shalt not change the code (or data)
except in response to a written requirement."
Then to document the changes, all you have to do is review the
requirements and see whether or not they were implemented.
It would be a lot easier and more accurate if the change was documented
by the person who requested the change. It would also be easier if the
change was documented by the person who implemented the change.
But usually, management doesn't go this way. Usually they hire some
poor unempowered soul to tag along ex post facto and try to spot the
Alternatively, you could do diffs to compare the previous vs. the
current versions (Your management DOES save old versions, right?)
Do you Yahoo!?
The New Yahoo! Search - Faster. Easier. Bingo. http://search.yahoo.com
You are currently subscribed to techwr-l as:
archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit http://www.raycomm.com/techwhirl/ for more resources and info.