• Post Reply Bookmark Topic Watch Topic
  • New Topic

Documentation required in part 2  RSS feed

Din Don
Posts: 5
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator

The part 2 assignment only requires UML diagrams and assumption of the requirements as deliverables. It does not require other documentation to cover application logic, functionalities of classes. These are the main essence of the arhcitecture of an IT system. These information can be implied by the mehtod names and attributes in the class diagram as well as the sequence diagram. But the names have to be very informative. In reality, class/method/attributes name are concise and do tell much about what they represent.

The only place we can document the application logic/functionalities is the assumption deliverable, but as the name itself implied, only assumptions to clear ambiguity of requirement is to be provided.

Can anyone suggest we should document architected functionalities in the 'assumption' deliverable ?
It is sorta covered in the JavaRanch Style Guide.
  • Post Reply Bookmark Topic Watch Topic
  • New Topic
Boost this thread!