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: Document the detritus? From:jenny_berger -at- fairfieldresidential -dot- com To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Thu, 15 May 2003 10:14:17 -0500
I'd keep it in. Management probably knows the junk's in the system, but
they've forgotten about it. Seeing it all in the doc, like you mentioned,
might remind them of the stuff and prompt them to at least make a decision
about what to do with it. At any rate, it's sometimes easier to take
content out later than add it at crunch time.
Jenny Berger
Technical Writer
Information Systems
Fairfield Residential
John Posada <JPosada -at- book -dot- com>
Sent by: bounce-techwr-l-115343 -at- lists -dot- raycomm -dot- com
05/15/2003 09:42 AM
Please respond to John Posada
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
cc:
Subject: Document the detritus?
So, I guess the question is should I clean up the documentation to
represent
the way the system should be, or should I take the position that the
document is what the system IS?
On the plus side of keeping the scraps in, it may prompt management to
initiate a system-wide cleanup program.
---
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.