Win a copy of Re-engineering Legacy Software this week in the Refactoring forum
or Docker in Action in the Cloud/Virtualization forum!
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic

choices.txt structure.

 
Javier Corral
Greenhorn
Posts: 24
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hello,

I am wondering what the structure of the choices file is expected.
I have written my choices by describing them class by class, but after reading some posts of this forum, I'm not sure at all. Seems more common to organize choices by design subjects.

Could someone give a clue.

Thanks for advance.
 
Sean Beecroft
Greenhorn
Posts: 26
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
I did mine by date.
 
Alex Belisle Turcot
Ranch Hand
Posts: 516
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi,

I did it per section (Data, Network, GUI...).
For each of these sections, I used bullet points of design decisions.

But the worst was my decision to comply with the requirement 80 characters per lines even with the documentation (silly). I ended up spending most of my time refactoring the document

Regards,
Alex
[ February 12, 2008: Message edited by: Alex Belisle Turcot ]
 
Alberto Ivo
Ranch Hand
Posts: 39
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Helo guys,

Can you explain better this structure, please?

I will sign at Sun to do this certification, I already bought Andrew's book. In this book is explained this structure?

thanks.
 
Javier Corral
Greenhorn
Posts: 24
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
I don't know any concrete specification of the choices.txt structure. I just decided a way of explaining my design decisions.

I sort by packages. For each package I sort by class, and for each class I specify the more important design decisions. If some decision is too much general for being included as a class decision, I put it just below the suitable package title.

For example, if you decide to use RMI instead of sockets, you could write your choice just below the title '--- suncertify.remote.' because it's a choice related to this package.

I think that the point is to explain the decisions you take, not a concrete line of code.
 
Alex Belisle Turcot
Ranch Hand
Posts: 516
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Originally posted by Alberto Ivo:
Helo guys,

Can you explain better this structure, please?

I will sign at Sun to do this certification, I already bought Andrew's book. In this book is explained this structure?

thanks.


Hi,
If you haven't receive the assignment, the organization of the design choices should not be your main concern. For example, the different sections don't make sense to you now, but they will once you start your assignment.

You'll only know which way to organize the information yourself once you're in it!!

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