Documentation guide
#Documentation Style and Methods:
Setting up and maintaining the project website:
- We used Jekyll to manage the documentation via Github Pages.
- The
docs/
folder is used for documentation about the project, the userguide, developer guide, usecases, userprofiles and more.
Style guidance:
-
Our project follows the Google developer documentation style guide.
-
Also relevant is the [se-edu/guides] Markdown coding standard
Diagrams:
- Our UML diagrams are done via [se-edu/guides] Using PlantUML