3 Replies - 24313 Views - Last Post: 25 February 2008 - 02:56 AM Rate Topic: -----

#1 frisbee  Icon User is offline

  • New D.I.C Head

Reputation: 0
  • View blog
  • Posts: 2
  • Joined: 23-February 08

Java design document

Post icon  Posted 23 February 2008 - 11:17 AM

Hi! Maybe have a stupid question but what makes a good design document? I wrote code for a program--didn't include it because not sure it needs to be seen for this question--if someone needs it to answer me let me know. So the program is written and then the teacher sent it back stating that i need to include a design document listing all classes and variables used, packages used, description of purpose of each method and a flowchart for the site and release notes. How do I write a good design document after the fact??? It was never stated that I needed to do that first. Any ideas on writing a good design??? Examples???

Is This A Good Question/Topic? 0
  • +

Replies To: Java design document

#2 bhandari  Icon User is offline

  • D.I.C Addict
  • member icon

Reputation: 9
  • View blog
  • Posts: 754
  • Joined: 31-January 08

Re: Java design document

Posted 24 February 2008 - 08:24 AM

UML is the anwser. Look at below links. For automated tools, consider Star UML which is free.

http://www.agilemode...lassDiagram.htm
http://en.wikipedia....i/Class_diagram
http://www.ibm.com/d...dge/sep04/bell/
Was This Post Helpful? 0
  • +
  • -

#3 Martyr2  Icon User is offline

  • Programming Theoretician
  • member icon

Reputation: 4436
  • View blog
  • Posts: 12,307
  • Joined: 18-April 07

Re: Java design document

Posted 24 February 2008 - 10:50 AM

Well a design document is more than UML. UML is typically part of the document. A design document typically includes what you listed there. It states the requirements of the project (a scope document as it is usually called), some test cases that your program is designed to solve by the end with expected outputs for given inputs, a list of classes and their variables (this is the UML) with relations to one another, and release notes are typically where the project is limited and expectations you have for the user of your program. These notes are usually a few paragraphs talking about how the program is to be used, what platform it is to be used on etc.

A nice example is something like the one located at the URL below... but keep in mind that I think your teacher will want one that is only a fraction of this so keep it brief.

A software design specification template

A few notes about the link...

1) Document Description section - aka Scope document
2) Design considerations - Release notes
3) Architectural strategies - UML and other diagrams
4) You may opt to put in a glossary and bibliography of anything you used. But the teacher may not require it.

Hope this helps. Enjoy!

"At DIC we be document design code ninjas!" :snap:
Was This Post Helpful? 0
  • +
  • -

#4 frisbee  Icon User is offline

  • New D.I.C Head

Reputation: 0
  • View blog
  • Posts: 2
  • Joined: 23-February 08

Re: Java design document

Posted 25 February 2008 - 02:56 AM

View Postbhandari, on 24 Feb, 2008 - 08:24 AM, said:

UML is the anwser. Look at below links. For automated tools, consider Star UML which is free.

http://www.agilemode...lassDiagram.htm
http://en.wikipedia....i/Class_diagram
http://www.ibm.com/d...dge/sep04/bell/

Thank you very much.

View PostMartyr2, on 24 Feb, 2008 - 10:50 AM, said:

Well a design document is more than UML. UML is typically part of the document. A design document typically includes what you listed there. It states the requirements of the project (a scope document as it is usually called), some test cases that your program is designed to solve by the end with expected outputs for given inputs, a list of classes and their variables (this is the UML) with relations to one another, and release notes are typically where the project is limited and expectations you have for the user of your program. These notes are usually a few paragraphs talking about how the program is to be used, what platform it is to be used on etc.

A nice example is something like the one located at the URL below... but keep in mind that I think your teacher will want one that is only a fraction of this so keep it brief.

A software design specification template

A few notes about the link...

1) Document Description section - aka Scope document
2) Design considerations - Release notes
3) Architectural strategies - UML and other diagrams
4) You may opt to put in a glossary and bibliography of anything you used. But the teacher may not require it.

Hope this helps. Enjoy!

"At DIC we be document design code ninjas!" :snap:

Thank you very much!! Both of you people that replied were very helpful!
Was This Post Helpful? 0
  • +
  • -

Page 1 of 1