Project technische documentatie van VISI
De technische documentatie van VISI is zeer omvangrijk. Voor de ingewijde gebruikers is dit geen probleem, voor nieuwkomers is het moeilijk om overzicht te krijgen. Daarom wordt de technische documentatie op Github verbeterd.
1. Overzichtelijkheid
Op GitHub wordt een aparte map gemaakt voor de geldende documentatie.
Op GitHub wordt een aparte map gemaakt waarin documentatie van vorige versies wordt bewaard.
Op GitHub wordt een aparte map gemaakt voor de volgende versie.
2. Technische documentatie
De technische documentatie wordt verbeterd. Deze bestaat uit de volledige beschrijving van de gezamenlijke componenten, namelijk:
- Het raamwerk
- Project specifieke bericht (PSB)
- Bericht en berichtenverkeer
- Promotor
- Projectarchief
- Beschrijving die de samenhang weergeeft tussen de bovenstaande technische componenten.
3. Functionele documentatie
De functionele documentatie wordt verbeterd. Deze bestaat uit de beschrijving van de functionaliteiten die nodig zijn om:
- Het raamwerk in te lezen
- Het PSB op te stellen
- Het PSB te wijzigen in een lopend project
- Het PSB correct te verwerken
- Het toekennen van rollen aan personen
- Afhankelijkheid tussen transactie en subtransactie te definiëren
- Correct bericht op te stellen en te verzenden naar de andere partij
- Een van de andere partij ontvangen bericht correct te verwerken inclusief het juiste antwoordbericht op te stellen en te verzenden
- Beschrijving die de samenhang weergeeft tussen de bovenstaande functionele componenten
4. Eisen aan certificering
De eisen voor VISI-certificering worden eenduidig beschreven.