Re: Document the detritus?

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

Hi John,

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.

Good luck,


Robohelp X3, from eHelp, lets you quickly and easily create
professional Help systems for all your Windows and Web-based
applications, including Net.

Order RoboHelp X3 in May and receive a $100 mail-in rebate, PLUS
free RoboScreenCapture and WebHelp Merge Module.

Order RoboHelp today:

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 for more resources and info.

Previous by Author: Re: Term for elegant, efficient, tight code?
Next by Author: Re: Document the detritus?
Previous by Thread: Re: Document the detritus?
Next by Thread: Re: Document the detritus?

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

Sponsored Ads