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 need to stick to this.
Currently the structure is as follows:
- Project Management - Put all project management related stuff in here, e.g. meetings outcomes, retrospectives, screenshots, minutes, planning.
- Analysis - this is the folder where you should put all analysis artefacts into
- Design - this is the folder where you should put all design artefacts into
- Implementation - this is the folder where you should put all analysis artefacts into
Preferably document with markdown files or AsciiDoc.
Feel free to adapt the structure
If you want to write documentatio with markdown:
Check the github markdown cheatsheet: https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet#links to learn how to work with .md files.
Further links for learning github in the Github Learning Labs:
If you want to choose asciidoctor, see the following link:
If you are interested to create your diagrams with PlantUML, see: