Software Engineering - Project

Deliverable 2.0 1

Now that you have received some feedback for the requirements specification and hopefully understand various aspects of your project better, it is time to prepare the software design.

The deliverable for this design phase is a PDF document and PlantUML source files. The document should follow the SDS (Software Design Specification) template available here. You should use PlantUML to prepare various diagrams for the document: keep the PlantUML source files in a single directory in your repository (e.g. uml/source), and their compiled versions in another directory (e.g. uml/images). You should of course also insert the compiled images into your PDF document, but keeping stand-alone files can be helpful if e.g. the font is too small.

There is no specific guidelines for the number of diagrams, it is up to you to decide if your requirements are covered by your design.

If at some point you feel it is necessary to go back and modify your requirements, you can do that, but you have to use a separate commit to clearly distinguish changes to requirements from your work on design.

Once your deliverable is ready, it has to be published using a GitLab release in the same way as the previous deliverable.

Feedback - Deliverable 2.1

The feedback process for this phase is the same as before. Each team has to fill out a CSV file and send it as a merge request. The other team then has to accept the merge request, and import the file using the Issue Importer API. Please refer to the previous deliverable page for more detailed instructions on providing feedback.

Installing PlantUML

The UML tool that will be used for this deliverable is PlantUML. You can download it here: the JAR version is compatible with any OS that has Java installed. Guides and language manuals can be found on the PlantUML webpage.

In order to draw sequence diagrams Graphviz should be installed from here.