Final deliverable for the Software Engineering 2 course at Politecnico di Milano.
This repository collects the full documentation work produced by team CotroneDeCiechiDeidier for the design of CKB (CodeKataBattle), including:
- RASD (Requirements Analysis and Specification Document)
- DD (Design Document)
- Alloy formal model and verification artifacts
- Sequence diagrams, component design material, UI mockups, and final slide deck
- Professor: Elisabetta Di Nitto
- Group: CotroneDeCiechiDeidier
- Members:
The project models a platform where:
- educators create and manage tournaments and battles,
- students register to tournaments/battles and form teams,
- collaboration invitations and notifications are handled,
- battle outcomes include automatic and manual evaluation,
- badges are defined and assigned according to tournament lifecycle rules.
These behaviors are documented through functional flows (sequence diagrams) and formally constrained through an Alloy model.
The RASD/ folder contains requirements-oriented artifacts:
mockups/: UI mockups for common, educator, and student views.sequence-diagrams/: scenario-level interaction flows (source.txtand exported.png) for both educator and student roles.alloy/: formal modelCotroneDeCiechiDeidier.alsplus generated world screenshots.
Key RASD outputs are also available in:
delivery-folder/RASD v1.pdfdelivery-folder/RASD v1.1.pdf
The DD/ folder contains design-oriented artifacts:
component-diagram/: global component architecture (.vpdsource + image export).component-interfaces/: interface models for educator/student components (.mdjsources + images).integration-plan/: phased integration visuals.sequence-diagrams/: detailed interaction flows (source.txt+ image exports).user-interface-design/: educator/student UI navigation/design maps (draw.io XML sources + images).
Key DD output is available in:
delivery-folder/DD v1.pdf
delivery-folder/: official PDF submissions.slideshow/: final presentation (.pdf) and editable source (.key).
- Final PDFs:
- Formal model:
- Main interaction diagrams:
For a smooth review, this is a recommended reading order:
- RASD v1.1 to understand goals, requirements, and main scenarios.
- Alloy model plus Alloy images to inspect formal constraints and validation worlds.
- DD v1 to move from requirements to architecture and design choices.
- DD component diagram and DD component interfaces for structural details.
- DD sequence diagrams for role-specific interaction flows.
- Final slideshow for a concise end-to-end project overview.
.
|- DD/
| |- component-diagram/
| |- component-interfaces/
| |- integration-plan/
| |- sequence-diagrams/
| `- user-interface-design/
|- RASD/
| |- alloy/
| |- mockups/
| `- sequence-diagrams/
|- delivery-folder/
|- slideshow/
|- LICENSE
`- README.md
- This repository is documentation-centric and does not include an executable software implementation.
- Many assets are provided both as editable sources (
.txt,.mdj,.vpd,.key) and exported images/PDFs.
Distributed under the GNU General Public License v3.0.