This week's book giveaway is in the Agile and Other Processes forum.
We're giving away four copies of The Little Book of Impediments (e-book only) and have Tom Perry on-line!
See this thread for details.
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

choices.txt

 
mike acre
Ranch Hand
Posts: 197
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
I am now going to be very contentious.

It is my belief that to much is made of the requirement to document all choices in the postings on this site.

Furthermore I believe very little of the marks are given for this document.

I believe that along with the essay exam the primary reason is to attempt to ensure the assignment is your own work.

I think that maybe some marks are allocated for big design issues such as RMI vs Sockets and Thin vs Thick client, but other that that I don't think people should get to hung up on it.

I'm not advocating that it can be skimped, just not to worry that every little issue is documented.

Who is to say what constitutes a documentable design descision, and what is just plain common sense. If every thing was documented you'd have to wait tillthis time next year just for the poor sod marking it to finish reading your choices.txt
 
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 Mike,

I think you are correct in that one of the reasons for the design decisions document is to validate that you wrote the code you submitted - when it is time to do the essay exam you should find that the best study material for the exam is your choices document.

But another reason for the choices document is to see whether you are a developer or just a programmer. That is - have you thought about different ways to complete your assignment, and made a decision about which is the best way, or did you just go with whatever seemed to work at the time?

I have recommended in the past that candidates just write bullet points for their design decisions. Not only does this help keep the document to a more reasonable size, but it is easier to memorise / keep consistent when you go to do the essay exam - especially if English is not your primary language.

You might be interested in reading Patrick Cobbett's post in the topic: 'how verbose should be design desision document?".

Regards, Andrew
 
mike acre
Ranch Hand
Posts: 197
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
[Sun] responded with:


quote:
--------------------------------------------------------------------------

Don't go overboard on this. We're just looking for something simple ... a few sentences on each major decision.

--------------------------------------------------------------------------

Ha ha, as I suspected.

Thanks Andrew.
 
Anton Golovin
Ranch Hand
Posts: 527
1
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
IMHO, only design decisions should be written down. Like using a factory class to launch different modes of the application. Or like hiding actual classes behind interfaces wherever possible. That kind of thing. I don't know what else to put in there.
 
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic