The purpose of this repository is to document your project work.
Your group is responsible for the repository structure and content, but we created some template folders for you. You do not have to stick to this.
Github documentation is part of the communication grade for project 2 (PRJ23). Therefore it is important to make sure to write proper documentation and to write that in a format that can be rendered by Github. Github supports a multitude of languages for this purpose, however you are only allowed to use:
- Markdown - Have a look at the Github flavored markdown
- AsciiDoc - Have a look at the AsciiDoctor cheatsheet
In the AADE course you will learn how to develop diagrams with the use of Visual Paradigm. You are free to use this program also for the diagrams for project 2.
However Visual Paradigm creates binary files which don't play nice with version control systems (VCS) such as Git. We therefore also recommend to have a look at the following ways of creating diagrams, based on text files (which is what VCSs excel at).
- PlantUML - PlantUml let's you easily create unified modeling languages (UML) diagrams in a text based manner. There is a VSCode extension available for live previews and exporting of diagrams.
- Diagrams.net - Drag and drop editor that works in the browser. There is also a VSCode extension available. Have a look at this guide on how to make sure your images are always up-to-date.
Examples of these diagrams can be found in the design directory.
⚠️ Make sure there is always an image available of all diagrams (preferably as SVG)
- Project Management - For all project management related artefacts, e.g. meetings outcomes, retrospectives, screenshots, minutes, planning.
- Analysis - For all analysis artefacts
- Design - For all design artefacts
- Implementation - For the implementation of the Airline Information System