Assignment documentation #7
Description
- How good is the “onboarding” documentation?
• Did you continue with the previous project or choose a new one?
• If you chose a new project: How does the experience compare to the previous one? - Document your experience. Keep track of how your team spends its time.3 If you were not able to finish all tasks, how much progress have you made? How much time do you think you would need to complete the task? If the process turned out to be less difficult than expected, attempt another issue (not necessarily in the same project).
- Assess your team (p. 51 in the Essence standard v1.2) by evaluating the checklist on p. 52: In what state are you in? Why? What are obstacles to reach the next state? How have you improved during the course, and where is more improvement possible?
- Individual contribution
- Changes to the code and test suite are shown and documented, e.g., as a patch.
- Key features affected by the issue are shown in UML class diagrams (for refactorings: include before/after). Note: you do not have to show classes, fields, or methods that are not relevant, unless they help with the overall understanding. Typically, the diagram would contain 5–10 classes.