nl-digigo / visi

Beheeromgeving van de VISI open standaard.
https://nl-digigo.github.io/visi/
6 stars 4 forks source link

Hoofddoel verbeteren technische documentatie 2020 #97

Closed ElisabethKloren closed 3 years ago

ElisabethKloren commented 3 years ago

De technische documentatie van VISI is in de afgelopen vier jaar tweemaal toegepast door een voor de VISI standaard nieuwe softwareleverancier: eenmaal een leveranciers die in opdracht van CROW een VISI-transactiecatalogus heeft gemaakt; en eenmaal een leverancier die hiermee een gecertificeerde VISI- applicatie heeft gemaakt. In beide gevallen bleek dat de documentatie niet voldoende hielp om de standaard te doorgronden, en werd in het geval van de VISI leverancier de implementatie van VISI in een nieuwe en in een bestaande applicatie als complex ervaren. [...]

Werkzaamheden (Hoofddoel) De technische documentatie zo opstellen en organiseren dat implementatie van VISI in een bestaande of nieuwe applicatie goed ondersteund wordt.

Beoordeling concept uitwerking technische documentatie nov 2020: De informatie is vooral in een andere volgorde gezet, in plaats van dat ontbrekende informatie is benoemd en toegevoegd. We nemen aan dat een leverancier met dezelfde informatie, maar in een andere structuur maar lichtelijk geholpen zou zijn bij de implementatie, want het is nog steeds dezelfde informatie. We zien niet hoe de documentatie de implementatie nu beter ondersteunt.

ElisabethKloren commented 3 years ago

Verder inhoudelijke opmerkingen ontvangen van reviewers: In 2.1.1 komen de bijlagen 2, 3 en 8 niet voor. In een eerder bericht van de schrijvers is geschreven dat men die bijlagen met bijlage 1 tot een nieuwe bijlage 1 wil samenvoegen. Dit duidelijk maken in het rapport 2.1.2 Er is juist voor een voorbeeld buiten de bouw gekozen om te voorkomen dat het inhoudelijk over het voorbeeld gaat in plaats van over de communicatie. Wat is het verbetervoorstel? 2.1.3 Vraag is of het ook voor softwareontwikkelaars minder begrijpelijk wordt. En wat is het verbetervoorstel? 2.1.6 VISI, COINS en IDM zijn standaarden. BIM is een begrip dat op vele manieren wordt uitgelegd. Hoe zou de relatie wel duidelijk gelegd kunnen worden? En wat helpt dit de softwareontwikkelaars om te begrijpen welke software zij moeten bouwen? 2.1.7 Wat is het voorstel? 2.2 Ik zie hier geen verbeteringen staan die de technische documentatie beter maken en daar gaat het om. 2.3.1 Aanpassingen in de standaard zijn bedoeld als aanpassingen in de communicatie tussen partijen. Er zal specifieker aangegeven moeten worden welke functionaliteiten niet altijd door beide partijen die met elkaar communiceren, toegepast moeten worden. Welke functionaliteiten worden niet gebruikt? Ik ga niet verder in op de specifieke vragen en opmerkingen die ik heb bij de rest van het document. De gegeven opmerkingen zijn voldoende in aantal en inhoud om mijn mening te ondersteunen. Het punt is dat het rapport alleen globaal commentaar geeft bij de bestaande documentatie. Het probleem dat we opgelost willen hebben, is dat er kennelijk documentatie ontbreekt, waardoor het moeilijk is voor nieuwe leveranciers om zelfstandig VISI-software te ontwikkelen. Het rapport geeft geen aanvullingen op de documentatie, terwijl die zeker en ook uitgebreid zijn gegeven door de geïnterviewden van BakkerSpees en Future Insight.

ElisabethKloren commented 3 years ago

Opdracht voltooid op 11-02-2021