I have a very rough draft of my Design document for my 3D engine up. I need you guys to read it and tell me what I need to add/change. All comments are welcome. www20.brinkster.com/tyrannica/lightworks design document.doc

Anyone? Its for a programming project thats worth 2 credits. All I need are a few opinions.

Edited by - Moe on May 21, 2001 4:33:43 PM

A design document is a battle plan not a biography :p

P.S. A design document and a design pattern are extremely distinct and different things

Magmai Kai Holmlor
- The disgruntled & disillusioned

Thanks,

Yes, I realize its pretty scetchy for a design doc, but if I go in depth too much more the people who are reading it will get confused. Its not really much of a design doc at all but more of a file explaining what the heck I did and how/why I did it.

So what is the difference between a design pattern and a design doc? Does a design doc describe every part of the code of the project or more generalized plan on how the program will work?

quote:Original post by Moe

Thanks,

Yes, I realize its pretty scetchy for a design doc, but if I go in depth too much more the people who are reading it will get confused. Its not really much of a design doc at all but more of a file explaining what the heck I did and how/why I did it.

i admit, i havent taken the time to read your doc yet, but im on a tight schedule.

A design document is supposed to clearly state the problems occured and their solutions and the general abstraction of the program, so that people who read it WONT get confused. If adding details makes it confusing... well, you're probably doing it wrong.

Don't worry, you're not alone, I still can't write a design doc for shit, heh.

quote:
So what is the difference between a design pattern and a design doc? Does a design doc describe every part of the code of the project or more generalized plan on how the program will work?

Well, the Design Patterns discussed in this forum are specific patterns that occur frequently in computer programming. The forum was designed to discuss the book Design Patterns, and all the related software patterns included within the book.

to put it shortly, a design pattern is a general abstract solution to a problem, and a design doc is a compilation of specific solutions to a large project.

===============================================
But as for me, hungry oblivion
Devour me quick, accept my orison
My earnest prayers Which do importune thee,
With gloomy shade of thy still empery,
To vail both me and my poesy

Edited by - Mithrandir on May 22, 2001 9:42:36 PM

Thanks. I will be sure to get things straight next time I write a design doc. Does anyone know of any design docs out there on the internet that I could have a look at?

Well, there''s a design document section here on GDNet, but I guess you''ve probably already found that..

=======================================
Matt Welch

"What sounds to you like a big bloat of trashy old noise
is in fact the brilliant music of a genius--myself" ~ Iggy Pop

To tell you the truth I didn''t look there. I didn''t even think about it. Thanks!