Individual Assignment: Writing Documentation

Each student will write documentation.

Ideally, this will be planned during Sprint 4, but could carry over into Sprint 5 for individual students if other activities take priority.

In consultation with the instructor, the team will determine which documentation elements from the following list are effective for documenting technical details of their project for future teams, and will assign each member of the team as the primary author of one aspect of this documentation.

• An effective project README discussing high-level project goals, how to build the system, how to deploy the system, and how to execute a smoke test.
• Documentation about how to execute the project test suite, how to modify and add tests, and limitations of the current suite
• Updated architecture diagrams
• Documentation on project dependencies such as third-party libraries with an analysis of related risks
• A review of any security risks, especially those related to external threats, that are relevant to system that would be deployed at the end of the semester.
• A detailed discussion of any concurrency issues in the system that would need to be considered by future developers, including timing issues related to system testing.
• Documentation on any remaining technical debt along with a detailed discussion of possible ways to address that debt.
• An informative UML class diagram (focused on project structure, not details)
• Sequence diagrams for several key scenarios
• Other documentation as identified by the team and instructor.

The instructor should review and approve the PBI for the documentation, and the student should meet the acceptance criterion when creating the documentation. [Submit the URL of the PBI to the “Your PBI” assignment that is paired with this one.]

To this assignment, the student should submit a URL to the file in the repo (not wiki) in which the documentation is contained. Be sure to link to the right branch, preferably main, but only if your work shows on that branch.

As with the previous assessment, early submissions are encouraged through an early deadline marked in Canvas. Please submit early to receive early feedback. To be considered on time, the document should be submitted with Sprint 5’s Review and Retro document.