aspose file tools*
The moose likes Beginning Java and the fly likes Documentation Help Big Moose Saloon
  Search | Java FAQ | Recent Topics | Flagged Topics | Hot Topics | Zero Replies
Register / Login
JavaRanch » Java Forums » Java » Beginning Java
Bookmark "Documentation Help" Watch "Documentation Help" New topic
Author

Documentation Help

Jay Beee
Greenhorn

Joined: Oct 11, 2003
Posts: 2
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

Joined: Aug 26, 2003
Posts: 59
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

Joined: Jan 29, 2003
Posts: 8791
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.


A good question is never answered. It is not a bolt to be tightened into place but a seed to be planted and to bear more seed toward the hope of greening the landscape of the idea. John Ciardi
 
I agree. Here's the link: http://aspose.com/file-tools
 
subject: Documentation Help
 
Similar Threads
Design Patterns Study Group
RSS Aggregator
what good sources to prepare?
Connection Pool Implementation ... ?
UML to generated Java (and sql)? Does this work? Good tools?