I am at the point to work on documentation but I have no idea how much I am supposed to write in choices.txt.
I read some post on JavaRanch and found someone has below bulletin.
I just wonder if this is too much?
Why I need to talk about code clarity and documentation in choices.txt?
According to the insturction, choices.txt is
"Detail the problems you perceived, the issues surrounding them, your value judgments, and the decisions that you made. This document should also describe any uncertainties you had regarding the project, and the decisions you made when resolving them."
So I consider it's a document to describe your decision about design.
It's not a document to talk about the design concept.
Is this correct?
what do most people do about choices.txt?
1]Overview.
2]Server Design.
3]Client Design.
4]Record Locking implementation.
5]Record Search implementation.
6]RMI vs Sockets based Remote Server implementation.
7]Modification vs Extension of Data class.
8]DefaultTableModel vs Extending AbstractTableModel.
9)Generic Client vs Generic Server.
10]Use of standard design
patterns.
11]Exception handling scenarios.
12]
Thread Safety.
13]Flexibilty for extension in future implementations.
14]Code clarity.
15]Class and its members naming convention and use of intuitive field names.
16]Documentation.
17]Final Packaging for submission.