Project Documentation (1 Viewer)

[Daveo]

Hi,

I've been working on my program now (due next term) and I have neglected most of the documentation. I think this is mainly because I don't know what to put into it...

So my question is...What would I put into the documentation for the program? I know I have to have a flow chart and a diary, but what else???

Thx

Daveo

 

[sunny]

I would suggest you look in your textbook for a comprehensive list of documentation you can do. Others you might have discussed in class would also be good.

- Internal/intrinsic (comments)
- Soure code
- DFD
- User manual
- Online help
- Data dictionary
etc

 

[Merforga]

You also need a log book of what you did. If you don't have one...bs one up. i suspect that's what most people do anyway. In it you should have these things :

Problem defined
Feasibility study
Design specifications
System Models
Algorithms
Source code documentation

 

[sunny]

Originally posted by Merforga
You also need a log book of what you did. If you don't have one...bs one up. i suspect that's what most people do anyway. In it you should have these things :

Problem defined
Feasibility study
Design specifications
System Models
Algorithms
Source code documentation

I'd assume thats the diary he said he wrote.

 

[Merforga]

Oh yes...my bad...i really need to read these posts more carefully =S