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:brian_das -at- hotmail -dot- com To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Fri, 16 May 2003 05:31:42 -0600
I suggest investigating exactly what the "detritus" is.
It could be junk left over from testing. But many systems create, alter
and drop tables dynamically, often using login names and timestamps to
give the tables unique names. Systems that stick closely to the relational
model are especially likely to have wacky-looking objects in them.
If those tables are just junk, then by all means bring it to the attention
of the database owner. Chat with him or her, or include a clear statement
of scope in your project plan.
If the tables aren't junk, your job is to determine what system events
created those tables, what your audience needs to know about those events,
and write a doc that meets those needs.
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.