Morgan
SCJP (1.4), SCJD (1.4), SCWCD (1.3), SCBCD (1.3)
Originally posted by Morgan Bath:
Anyone else having kittens trying to decide how long the choices.txt should be?
There is no end to documentation so I told myself just stop doing it when more than 80% is done.
Regards, George
SCJP, SCJD, SCWCD, SCBCD
Originally posted by Max Habibi:
Originally posted by Max Habibi:
I suggest just under a page.
One can probably say everything that's necessary to say in about a page. (Of course that means that that page is going to be chock-full of content and your explanations are not going to be exhaustive.) If you're naturally verbose (think me or Javini ) then it's going to take a fair bit of your time to condense down to one page. I think in that case you're OK submitting more than one page, but 5 pages should probably be the outer limit. It's not a question of being lazy but of being concise. Remember, you're not explaining your design to someone off the street, you're explaining your design to someone who grades these things and has probably seen quite a few of them in his time. So your emphasizing what makes your design different from a "typical" solution, rather than explaining the basics of the project. The grader already knows the basics, he wants to be told about the differences, what sets your application apart from the others.
Hope this helps,
George
P.S. See this illustrates the difference: it took me a long paragraph to say the same thing Max said in a sentence: "I suggest just under a page." Emulate Max, not me, and I think you'll be better off in this situation.
[ February 16, 2004: Message edited by: George Marinkovich ]
Regards, George
SCJP, SCJD, SCWCD, SCBCD
Morgan
SCJP (1.4), SCJD (1.4), SCWCD (1.3), SCBCD (1.3)
Originally posted by George Marinkovich:
So your emphasizing what makes your design different from a "typical" solution, rather than explaining the basics of the project. The grader already knows the basics, he wants to be told about the differences, what sets your application apart from the others.
[ February 16, 2004: Message edited by: George Marinkovich ]
Morgan
SCJP (1.4), SCJD (1.4), SCWCD (1.3), SCBCD (1.3)
Originally posted by Morgan Bath:
Just under one page ... I cant order pizza on the phone using so few words!
Ok, ill try But did you include any other documentation sort of extra with that page so that IF the examiner wanted he could go deeper? choices.txt & idiots_guide_to_my_code.txt
Morgan
SCJP (1.4), SCJD (1.4), SCWCD (1.3), SCBCD (1.3)
Morgan
SCJP (1.4), SCJD (1.4), SCWCD (1.3), SCBCD (1.3)
Originally posted by Morgan Bath:
Ill give an example of my dilema :
will the examiner know the difference between the Adapter pattern and Bridge pattern? Should i do a brief 2 sentence description of the difference or is this insulting?
The DataAdapter class is used as the common interface for both local and remote database access. It implements the adapter design pattern by adapting the DataAccess interface to the DBMain interface, which was provided by Sun and cannot be changed.
Regards, George
SCJP, SCJD, SCWCD, SCBCD
Morgan
SCJP (1.4), SCJD (1.4), SCWCD (1.3), SCBCD (1.3)
Originally posted by Morgan Bath:
Had a thought: How about a compromise? What about a short concise choices.txt, a short concise readme.txt. Then a fairly in depth usermanual.txt & user manual popup window on the gui. Lastly a fairly in depth programmers_manual.txt.
The last could cover the ins and outs, whys and wheres of the code. A manual for people wanting to alter or maintain th code. This is a 'best practice' I do commercially any way and the examiner can simply ignore it if he or she so wishes. The critical thinking is covered in choices.txt, and the exact implementation details are left for the other.
They wont mark you down for that surely, and you cover your bases just in case the examiner isnt quite sure what your thinking was in having overloaded lock and unlock methods
Regards, George
SCJP, SCJD, SCWCD, SCBCD
Morgan
SCJP (1.4), SCJD (1.4), SCWCD (1.3), SCBCD (1.3)
Morgan
SCJP (1.4), SCJD (1.4), SCWCD (1.3), SCBCD (1.3)
Originally posted by Morgan Bath:
So I am actually way happier now. Im still gonna include a more verbose programmers text, but im not going to put much into it, just a description of the major classes in each package and how some of the more important 'bits' work.
Regards, George
SCJP, SCJD, SCWCD, SCBCD
Morgan
SCJP (1.4), SCJD (1.4), SCWCD (1.3), SCBCD (1.3)
Aaaaaand ... we're on the march. Stylin. Get with it tiny ad.
a bit of art, as a gift, that will fit in a stocking
https://gardener-gift.com
|