Detailed Technical Design document ( /5)
Includes design class diagram (DCD) with types and attributes/functions of all classes and files, and a link to commentable (and preferably editable e.g. with Miro or other tool) version of the diagram
The DCD needs to represent the team’s app.
The DCD should show classes with their attributes, associations, and methods, and types, and functions and parameters, that fit your team’s app i.e. user stories, use cases.
If it doesn’t reasonably agree with the project’s current source code or doesn’t show how the design patterns will be used, -5 points each. Ask a question if you have any questions or doubts about this.
The DCD should build on the names, types, etc in the domain model but you are welcome to improve them.
For every mistake or mismatch, deduct -2 points.
As an example for “matching”/corresponding to domain model for domain objects (not React components), see
Examples (from the examples document)
Team F: Design Class Diagram
Corresponding earlier domain model
Example 2
Design class diagram in two parts at end and design patterns
Corresponding earlier domain model that the above design class diagram was based on
Put your use of external libraries onto your diagram as in this example ( firebase and firebase-react-hooks are examples)
For every missing key external dependency required to implement all the user stories your team intends to finish by Deliverable 5, i.e. APIs you will use, -3 points
This penalty will be reduced to -1.5 each by specifying a facade or a “todo” with an example function/method signature for the API, which is then shown to be used by your app’s components
For each poor/overcomplicated design choice, -1 to -4 points depending on size and severity
“Helper functions” (if your design has them) should be put into a filename box (similar to a class) as in the example single helper functions “class” and list the method name, parameters and types, and return type, as in this example
-2 points for each that is represented as a class method or class variable when it is actually just a function exported from a file
Put your React functional-style components onto the diagram as “View” or “ViewController” as in this example
-1 points for each deviation from that format e.g. for each variable, function, type, etc
Detailed Technical Design document ( /5) Includes design class diagram (DCD) with types and attributes/functions of all classes and files, and a link to commentable (and preferably editable e.g. with Miro or other tool) version of the diagram The DCD needs to represent the team’s app. The DCD should show classes with their attributes, associations, and methods, and types, and functions and parameters, that fit your team’s app i.e. user stories, use cases. If it doesn’t reasonably agree with the project’s current source code or doesn’t show how the design patterns will be used, -5 points each. Ask a question if you have any questions or doubts about this. The DCD should build on the names, types, etc in the domain model but you are welcome to improve them. For every mistake or mismatch, deduct -2 points. As an example for “matching”/corresponding to domain model for domain objects (not React components), see Examples (from the examples document) Team F: Design Class Diagram Corresponding earlier domain model Example 2 Design class diagram in two parts at end and design patterns Corresponding earlier domain model that the above design class diagram was based on Put your use of external libraries onto your diagram as in this example ( firebase and firebase-react-hooks are examples) For every missing key external dependency required to implement all the user stories your team intends to finish by Deliverable 5, i.e. APIs you will use, -3 points This penalty will be reduced to -1.5 each by specifying a facade or a “todo” with an example function/method signature for the API, which is then shown to be used by your app’s components For each poor/overcomplicated design choice, -1 to -4 points depending on size and severity “Helper functions” (if your design has them) should be put into a filename box (similar to a class) as in the example single helper functions “class” and list the method name, parameters and types, and return type, as in this example -2 points for each that is represented as a class method or class variable when it is actually just a function exported from a file Put your React functional-style components onto the diagram as “View” or “ViewController” as in this example -1 points for each deviation from that format e.g. for each variable, function, type, etc