SoftwareGuidebook

De resultaten van de onderzoeken verwerk je in een Software Guidebook (SGB).

Voor de documentatie gebruik je het Software Guidebook van Simon Brown als uitgangspunt.

Maar je kunt ook de Reader gebruiken die we beschikbaar stellen.

Software Guidebook

Zorg dat jullie Software Guidebook in ieder geval de volgende hoofdstukken bevat.

1. Context
2. Functional Overview
3. Quality Attributes
4. Constraints
5. Principles
6. Software Architecture
7. Code
8. Data
9. Infrastructure Architecture
10. Deployment
11. Operation and Support
12. Development Environment
13. Decision Log

Daarnaast is er waarschijnlijk nog andere documentatie met onderzoeken en onderzoeksresultaten. Deze documentatie kun je integreren in het software guidebook, maar je kunt ook linken naar specifieke plekken in jullie repo als dat handiger is.

GitHub Pages

In het vak SoEx heb je een voorbeeld gezien van een Software Guidebook geschreven in MarkDown in een GitHub repo. In dit project vragen we van jullie om het Software Guidebook in GitHub Pages te publiceren.

Zie https://pages.github.com/ voor een introductie in publiceren op github pages.

Voor het toevoegen van basis-styling kun je het beste een static site generator gebruiken. GitHub raadt zelf Jekyll aan. Zie:

• https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/about-github-pages-and-jekyll

• https://jekyllrb.com/docs/github-pages/

Populaire alternatieven zijn:

• mkdocs: https://www.mkdocs.org/

• docusaurus: https://docusaurus.io/