Win a copy of The Java Performance Companion this week in the Performance forum!
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic

Design.txt

 
Mark Spritzler
ranger
Sheriff
Posts: 17278
6
IntelliJ IDE Mac Spring
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
How much needs to go into this document. I already stated what I did with the data class, why I chose RMI, and All the Design Patterns I used. I even tried to make a Class Diagram of the interaction between classes. Is this overkill, or is there maybe something that I still need in there?
Thanks
Mark
 
Peter den Haan
author
Ranch Hand
Posts: 3252
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Sounds like you're well on the way. The important thing is to (a) clarify the general architecture of your solution and (b) outline the major design decisions, and your reasons for making them the way you did.
Personally I would beware of turning it into a design patterns catalogue. Patterns are important bits of vocabulary to use when explaining the structure, but the point surely is to deliver a narrative that explains well, not the "spot the pattern" game that some try to make of it (not that I think you're prone to that, but I just wanted it off my chest).
UML diagrams would no doubt be helpful. Concentrate on the key elements of your architecture, don't try to model every nook and cranny.
- Peter
 
Mark Spritzler
ranger
Sheriff
Posts: 17278
6
IntelliJ IDE Mac Spring
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Cool. thanks. I am going to test my submission jar, and then finally post my submission after 5 months. I took 5 months because I didn't have a lot of time to devote to the program, and I wanted to make sure I got it right. So I took my time.
Thanks Peter
Mark
 
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic