Win a copy of The Little Book of Impediments (e-book only) this week in the Agile and Other Processes forum!
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic

Documentation what is needed ?

 
Frank Jacobsen
Ranch Hand
Posts: 358
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
I think about starting my SCJD in one months .....

But whats the level of documentation, is javadoc enough ?, schould i create some uml diagrams, and convert it to jpg´s
so im sure that sun can look at my diagrams.....

If i use some design patterns, schould i describe it in word somewhere or ???

Frank

SCJP
SCWCD
 
Roberto Perillo
Bartender
Posts: 2271
3
Eclipse IDE Java Spring
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Howdy, Frank!

Even though you have to provide JavaDoc documentation for all classes you create, you still have to justify your most relevant choices, since the assignment has lots of ambiguities. You'll have to create a choices.txt file for that, as well as the user guide, which can be embedded in your application, or can be a plain text/HTML file. And you don't really have to provide any UML diagram. And that should be about it
 
Roel De Nijs
Sheriff
Posts: 10662
144
AngularJS Chrome Eclipse IDE Hibernate Java jQuery MySQL Database Spring Tomcat Server
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi Frank,

you should provide following things (beside your code of course):
- Javadoc documentation for all classes and interfaces you are submitting.
- choices.txt: containing pure ASCII (not a word processor format) text describing the significant design choices you made.
- userguide: User documentation for the database server and the gui client.

No UML is needed (you could always submit it, but you don't receive extra points for doing so -but maybe loose some points because it is not correct) and the design patterns you could describe in choices.txt

Kind regards,
Roel
 
Frank Jacobsen
Ranch Hand
Posts: 358
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Thanks
 
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic