Win a copy of Programmer's Guide to Java SE 8 Oracle Certified Associate (OCA) this week in the OCAJP forum!
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic

Documentation Help

 
Jay Beee
Greenhorn
Posts: 2
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hey there,
I wrote a complex Java program for an assignment, and now I am required to write "detailed design and implementation documentation"
Is there a standard on how to write these documents? How exactly do I seperate the design from the implementation?
Thanks alot for your help.
 
Vinod Chandana
Ranch Hand
Posts: 59
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hey Jay,
Go to the following links. Hope these are helpful.
http://java.sun.com/docs/codeconv/html/CodeConventions.doc4.html#385
http://java.sun.com/docs/codeconv/html/CodeConvTOC.doc.html
Regards,
Vinod.
Originally posted by Jay Beee:
Hey there,
I wrote a complex Java program for an assignment, and now I am required to write "detailed design and implementation documentation"
Is there a standard on how to write these documents? How exactly do I seperate the design from the implementation?
Thanks alot for your help.
 
Stan James
(instanceof Sidekick)
Ranch Hand
Posts: 8791
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
The Unified Modeling Language is a neat set of standards for design artifacts. There are books (and books and books) on UML. If you have a good school library, look for Craig Larman (forget the title) or Quatrani's Visual Modeling with Rose as introductory works. Scott Ambler has a bunch of good books and a highly distilled overview of the various diagrams at http://www.agilemodeling.com/artifacts/index.htm. What you need to produce is highly dependent on your application and your audience. Drop in to the OO, Patterns, UML and Refactoring forum if you want to get more dialog going with the gang here.
 
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic