Deze repository bevat documentatie over het Kaleidos project. Dit gaat zowel over de Kaleidos applicatie zelf als verwante applicaties zoals Themis, Overlegcomité, ...
De documentatie is momenteel voornamelijk technische geörienteerd om het data model en implementatie te verduidelijken waar nodig. Ze kan ook gebruikt tijdens development ter referentie. Op termijn kan de repository breder opgevat worden om bijvoorbeeld ook documentatie voor eindgebruikers te bevatten, maar dit is momenteel niet de belangrijkste focus.
Het doel van de repository is om de verschillende specificaties, data flows en praktische implementaties te verzamelen en centraliseren op een locatie. Hierbij blijft ook steeds het gehele plaatje bewaard. Deze repository kan als referentiepunt gebruikt worden.
Ook specificaties die nog niet volledig uitgewerkt zijn, worden opgenomen in de repository. Dit wordt duidelijk aangegeven in het document. De historiek zorgt ook voor captatie van de motivering achter bepaalde keuzes en beslissingen.
Het doel van de repository is zeker niet om Jira (of een andere planningstool) te vervangen. Integendeel, de specificaties die in deze repository geschreven worden, zullen gebruikt worden als basis om tot een of meerdere actionable stories te komen om de specificatie effectief te implementeren.
De structuur en workflow van de repository is nog in flux. Deze zal waarschijnlijk evolueren doorheen de tijd op basis van ervaring en eventuele noden. Feedback en suggesties hierover zijn zeker welkom.
Momenteel is de repository als volgt gestructureerd:
- general: algemene documentatie
- data-model: (gewenste) praktische implementatie van de OSLO data modellen
- frontend: toelichting bij best practices en implementaties in Ember.js
- images: afbeeldingen bij de documentatie, bij voorkeur in SVG formaat