[lnkForumImage]
TotalShareware - Download Free Software
Confronta i prezzi di migliaia di prodotti.
Asp Forum
 Home | Login | Register | Search 


 

Forums >

microsoft.public.sqlserver.programming

Need to provide documentation

Bahman

3/23/2007 4:52:00 PM

Hi!

I have been asked to provide documentation for a database that consists of
tables, views, sps, dts, etc.

The only problem is that it is supposed to be legible to someone who is a
'novice'. That poses a technical challenge.

Are there guidelines or sample documents that allow me to be precise about
the documentation, do a reasonable job with reports and the views they use,
but not get into a loop of explaining 50k code line by line to a 'novice'?

What would be reasonable expectations here?

Any help is very much appreciated. Thank you!

-Bahman
4 Answers

AlterEgo

3/23/2007 8:25:00 PM

0

Bahman,

I would think that a very brief description of all the databases, tables,
views, jobs, etc. would be fine. For DTS packages, You could supplement the
description with a data flow diagram.

I would also include a data dictionary that explains what each column is
for. That will probably be used the most by "novice" users.

-- Bill


"Bahman" <Bahman@discussions.microsoft.com> wrote in message
news:B50457F8-E40D-4673-892B-C3BB1DA68A5E@microsoft.com...
> Hi!
>
> I have been asked to provide documentation for a database that consists of
> tables, views, sps, dts, etc.
>
> The only problem is that it is supposed to be legible to someone who is a
> 'novice'. That poses a technical challenge.
>
> Are there guidelines or sample documents that allow me to be precise about
> the documentation, do a reasonable job with reports and the views they
> use,
> but not get into a loop of explaining 50k code line by line to a 'novice'?
>
> What would be reasonable expectations here?
>
> Any help is very much appreciated. Thank you!
>
> -Bahman
>


TheSQLGuru

3/23/2007 9:05:00 PM

0

Get ApexSQL Doc from ApexSQL.com. This is a GREAT product. Just point it
at a database and VOILA, out comes either HTML or Compiled Help documenting
everything there is, all linked with nice point-and-click references.

Tell them TheSQLGuru sent you.

--
TheSQLGuru
President
Indicium Resources, Inc.

"Bahman" <Bahman@discussions.microsoft.com> wrote in message
news:B50457F8-E40D-4673-892B-C3BB1DA68A5E@microsoft.com...
> Hi!
>
> I have been asked to provide documentation for a database that consists of
> tables, views, sps, dts, etc.
>
> The only problem is that it is supposed to be legible to someone who is a
> 'novice'. That poses a technical challenge.
>
> Are there guidelines or sample documents that allow me to be precise about
> the documentation, do a reasonable job with reports and the views they
> use,
> but not get into a loop of explaining 50k code line by line to a 'novice'?
>
> What would be reasonable expectations here?
>
> Any help is very much appreciated. Thank you!
>
> -Bahman
>


Bahman

3/27/2007 10:59:00 PM

0

Hi!

I will look into it. Thank you.

-Bahman

"TheSQLGuru" wrote:

> Get ApexSQL Doc from ApexSQL.com. This is a GREAT product. Just point it
> at a database and VOILA, out comes either HTML or Compiled Help documenting
> everything there is, all linked with nice point-and-click references.
>
> Tell them TheSQLGuru sent you.
>
> --
> TheSQLGuru
> President
> Indicium Resources, Inc.
>
> "Bahman" <Bahman@discussions.microsoft.com> wrote in message
> news:B50457F8-E40D-4673-892B-C3BB1DA68A5E@microsoft.com...
> > Hi!
> >
> > I have been asked to provide documentation for a database that consists of
> > tables, views, sps, dts, etc.
> >
> > The only problem is that it is supposed to be legible to someone who is a
> > 'novice'. That poses a technical challenge.
> >
> > Are there guidelines or sample documents that allow me to be precise about
> > the documentation, do a reasonable job with reports and the views they
> > use,
> > but not get into a loop of explaining 50k code line by line to a 'novice'?
> >
> > What would be reasonable expectations here?
> >
> > Any help is very much appreciated. Thank you!
> >
> > -Bahman
> >
>
>
>

Bahman

3/28/2007 1:04:00 AM

0

Hi!

This is very helpful. Thank you!

-Bahman

"AlterEgo" wrote:

> Bahman,
>
> I would think that a very brief description of all the databases, tables,
> views, jobs, etc. would be fine. For DTS packages, You could supplement the
> description with a data flow diagram.
>
> I would also include a data dictionary that explains what each column is
> for. That will probably be used the most by "novice" users.
>
> -- Bill
>
>
> "Bahman" <Bahman@discussions.microsoft.com> wrote in message
> news:B50457F8-E40D-4673-892B-C3BB1DA68A5E@microsoft.com...
> > Hi!
> >
> > I have been asked to provide documentation for a database that consists of
> > tables, views, sps, dts, etc.
> >
> > The only problem is that it is supposed to be legible to someone who is a
> > 'novice'. That poses a technical challenge.
> >
> > Are there guidelines or sample documents that allow me to be precise about
> > the documentation, do a reasonable job with reports and the views they
> > use,
> > but not get into a loop of explaining 50k code line by line to a 'novice'?
> >
> > What would be reasonable expectations here?
> >
> > Any help is very much appreciated. Thank you!
> >
> > -Bahman
> >
>
>
>