• Post Reply
  • Bookmark Topic Watch Topic
  • New Topic

About Documentation...

 
Nikolay Gannev
Greenhorn
Posts: 17
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
hi all,

I'm in the beginning stage of preparation for the exam using the book Java Developer Exam with J2SE 1.4 by Mehran Habibi...

The only thing for the moment that is unclear for me is that documentation - design decisions document - where is discribed what technologies are used and explain why....
Do I need to describe everything (in detailed - for example here I use Vector object because its syncronized and bla bla...) in this document or only explanation of the main parts of the program?
how long this document can be? 1,2, 10ps?

any help is appreciated,
Nick
 
Julian Kennedy
Ranch Hand
Posts: 823
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi Nikolay,

One guy recently posted on this forum that he passed with a two-page design choices document. Personally I'm going to document everything I can think of as, if you make a questionable design decision, you may still get credit if your reasoning is sound. If you don't justify it the examiner cannot know your rationale.

Jules
 
Steven Hoodless
Ranch Hand
Posts: 64
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Nikolay,

I agree with Jules on this. The more substance you provide to back up your development, the more chance you will have of showing your understanding and reasoning.

I'd think in terms of a 10ish page document covering the Network layer, the presentation layer, and the database/server layer. You get plenty of ideas for content from reading other peoples mails about documentation on JavaRanch. Some will put more and others less.

You are lucky if the only dificulty you see is documentation.

Regards,

Steven
 
Andrew Monkhouse
author and jackaroo
Marshal Commander
Pie
Posts: 12007
215
C++ Firefox Browser IntelliJ IDE Java Mac Oracle
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi everyone,

You might be interested in the thread "how verbose should be design desision document?". Not so much for the comments by those of us who write too much, but for the comments from Sun.

Regards, Andrew
 
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic