Project Documentation

[mendhak]

Attached is a template for the final project documentation. I'd like it if someone could go over it and post any points I may be missing. Also, if someone has something of the sort I could see, could they please attach that?

Thanks.

[mendhak]

*bump*

Nobody writes documentation???

[mendhak]

*bump*

Nobody has a job?

[KayJay]

One thing that strikes me immediately is the absence of any reference to Time or Cost.

Include them in your "Design Considerations/Methodolgy" section, to justify why this particular approach is the most Cost-Effective and Time-Efficient approach to fullfil the Purpose of the Software

and in the "Software Module" section, to elaborate why a particular product/process has been chosen, though others, maybe better, exist. e.g: Flat-File databases over the Relational ones.

HTH

[mendhak]

Originally posted by KayJay
One thing that strikes me immediately is the absence of any reference to Time or Cost.

Include them in your "Design Considerations/Methodolgy" section, to justify why this particular approach is the most Cost-Effective and Time-Efficient approach to fullfil the Purpose of the Software

and in the "Software Module" section, to elaborate why a particular product/process has been chosen, though others, maybe better, exist. e.g: Flat-File databases over the Relational ones.

HTH

Thank you for answering! That helped, I've added these.

[Wokawidget]

You usually have 2 type of specification document for a project:

• User Sec
• Developer Spec

Yours seems to be an all in one document. Does the user really care what drivers the app uses?
Here's a very quick and crap developer spec I wrote for a Customer/Supplier section of a financial app I was writting. Hope this may give you some ideas...
I know, it's crap, but I only had 3 hours to write it

Adios,

Woka

PS Long time no see...
PPS I was going to upload it, but it's too big
Got an email add, I'll post it to ya.

[mendhak]

PS... true.
PPS... Wait eagerly for a PM from me.