Major Project Documentation (1 Viewer)

[BlasterWorm]

Hello Past Year 12's + students

I am currently doing my SDD major Project (MP3 Playerin VB6) and was wondering if you by chance have any of your documentation from your projects that you could show us. I mean our text book tells us what it is but it would be good actually seeing the documenation.

Thanks
Alistair

 

[Winston]

lol my documentation is about 120 megs all up.

 

[BlasterWorm]

do you have broadband? why is it so big, i am just after what a data dictionary looks like and a how people approached their IPO charts etc

Thanks
Alistair

 

[Winston]

yes im on cable, its so big cause i did heaps of documentation... i had about 200 pages of documentation, source code turned out to be 500 pages so it was fat ...

data dictionarys would be exactly how the textbooks have it

you list the variable names, type, description about them and that's it.

 

[thebearcub]

Originally posted by Winston
yes im on cable, its so big cause i did heaps of documentation... i had about 200 pages of documentation, source code turned out to be 500 pages so it was fat ...

data dictionarys would be exactly how the textbooks have it

you list the variable names, type, description about them and that's it.

did your teacher READ all your documentation

 

[Winston]

Originally posted by thebearcub
did your teacher READ all your documentation

heh doubt it.

 

[Freedom_Dragon]

Hello Winston,

How did u get ur documentation to be so much?
Im also doing some documentation based on a snooker game i will be creating using java.

How long did it take u to created 500 pages of documentations?

If u dont mind, can i jus take a glimse of ur documentation.
I Just want to see how u set it out.

 

[Beaky]

Im guessing code took up most or at least the majority of the documentation?

EDIT: And Flowcharts/Pseduocode?

 

[Winston]

Originally posted by Freedom_Dragon
Hello Winston,

How did u get ur documentation to be so much?
Im also doing some documentation based on a snooker game i will be creating using java.

How long did it take u to created 500 pages of documentations?

If u dont mind, can i jus take a glimse of ur documentation.
I Just want to see how u set it out.

450 pages worth of source code

250 pages worth of documentation

 

[viper1009]

so does anyone have ANY of documentation? If u do plz email me at hungama_3@hotmail.com

i'll be grateful

thanx

 

[lbft]

Remember that each teacher expects completely different levels and types of documentation. Some teachers might be happy with 10-20 pages, some might expect hundreds for a good mark. Some expect lots of structure, others don't..etc.

 

[Seraph]

Originally posted by Winston
450 pages worth of source code

250 pages worth of documentation

:apig:

 

[Winston]

Originally posted by lbft
Remember that each teacher expects completely different levels and types of documentation. Some teachers might be happy with 10-20 pages, some might expect hundreds for a good mark. Some expect lots of structure, others don't..etc.

True, but it really shouldn't be up to the teacher to decide the quantity, you're telling me if you made a program which just showed message box's and your teacher expected 100 pages, woh boy you got alot to bullshit...

Originally posted by Seraph



:apig:

something wrong?

 

[Seraph]

hah im just wondering what you put in there to make it so long!!

(i guess i can understand the source code... BARELY)

BUT THE DOCUMENTATION.. wow......


I mean.. once again.


Wow....

 

[Winston]

Originally posted by Seraph
hah im just wondering what you put in there to make it so long!!

(i guess i can understand the source code... BARELY)

BUT THE DOCUMENTATION.. wow......


I mean.. once again.


Wow....

Now that's what you call software development.

 

[gman03]

Originally posted by Winston
450 pages worth of source code

250 pages worth of documentation

How many of those 450 pages of source code are made up entirely by you? In other words, how many pages of source code did you not copy from else where?!?

 

[Winston]

Originally posted by gman03
How many of those 450 pages of source code are made up entirely by you? In other words, how many pages of source code did you not copy from else where?!?

All of them, all the code was written entirely raw by myself. i spent the course of 6 months writing the code, and did alot of research into the domain of the problem. I'm not dodgy like many of you students who just navigate to planetsourecode to download their solutions and modify it a little, that's just stupid.

 

[Seraph]

question: ive noticed for the online help that alot of people just use notepad (since it is accessed from the game) ... and it doesnt seem to be a hugely detailed piece of documentation..

what did everyoen else use????

 

[sunny]

MS Help Workshop.

 

[J0n]

There is also HTML Help Workshop (dunno if it is the same as what sunny posted), but it is better than the one that comes with Visual Studio 6 in that you can write your help pages in HTML, and it is a lot easier to use.