vng-realisatie / api-beheer Goto Github PK

View Code? Open in Web Editor NEW

2.0 7.0 0.0 2.93 MB

Repository met beschrijving van het beheer van (ZGW) API specificaties

api-specification

api-beheer's People

Contributors

Stargazers

Watchers

api-beheer's Issues

Als gebruiker van standaarden wil ik alle standaarden op 1 plek kunnen vinden

... zodat altijd duidelijk is welke standaarden actueel zijn en ik altijd alle standaarden eenvoudig kan vinden.

Momenteel zijn er twee API standaarden in ontwikkeling die beiden eigen wijze hebben om de standaard aan te bieden aan publiek, lijkt goed om dat al vanaf begin te integreren.

GEMMA Zaken: - ZDS 2.0 - https://ref.tst.vng.cloud
Bevragingen ingeschreven personen: https://github.com/VNG-Realisatie/Bevragingen-ingeschreven-personen

Als gebruiker wil ik problemen met een standaard kunnen melden zodat deze in een volgende versie opgelost worden.

Als gebruiker wil ik vragen kunnen stellen over een API standaard zodat verder kan gaan met de ontwikkeling van mijn product

Als beheerder wil ik duidelijk kunnen maken welke issues er in een nieuwe versie van een standaard zijn opgelost.

...zodat [vul aan].

Definition of ready

Iedereen in het team begrijpt de user story
Is klein genoeg voor een sprint
Product Owner akkoord en voorzien van prio
Voorzien van Acceptatiecriteria
Voorzien van Definition of Done
Voorzien van taken
Vastgelegd Github en in geplaatst in kolom ready for sprint

Definition of done

Algemeen

Een werkwijze/middel/tools om ZDS-API goed in beheer te nemen.

Specifiek

Oplossingsrichting

...

Acceptatiecriteria

Niet belemmerend werken voor beheer andere standaarden
...

Taken

... (@...)
... (@...)

Als beheerder wil ik meerdere versies van een standaard kunnen beheren zodat het mogelijk is dat er meer dan 1 versie de status 'in gebruik' kunnen hebben..

...zodat [vul aan].

Definition of ready

Iedereen in het team begrijpt de user story
Is klein genoeg voor een sprint
Product Owner akkoord en voorzien van prio
Voorzien van Acceptatiecriteria
Voorzien van Definition of Done
Voorzien van taken
Vastgelegd Github en in geplaatst in kolom ready for sprint

Definition of done

Algemeen

Een werkwijze/middel/tools om ZDS-API goed in beheer te nemen.

Specifiek

Oplossingsrichting

...

Acceptatiecriteria

Niet belemmerend werken voor beheer andere standaarden
...

Taken

... (@...)
... (@...)

Als beheerder wil ik weten wie betrokken moet zijn bij de review van een nieuwe versie van een standaard

Zodat de juiste mensen er op kunnen reageren

Definition of ready

Iedereen in het team begrijpt de user story
Is klein genoeg voor een sprint
Product Owner akkoord en voorzien van prio
Voorzien van Acceptatiecriteria
Voorzien van Definition of Done
Voorzien van taken
Vastgelegd Github en in geplaatst in kolom ready for sprint

Definition of done

Algemeen

Een werkwijze/middel/tools om ZDS-API goed in beheer te nemen.

Specifiek

Oplossingsrichting

...

Acceptatiecriteria

Niet belemmerend werken voor beheer andere standaarden
...

Taken

... (@...)
... (@...)

Als leverancier/gemeente/beheer wil ik weten of ik voldoe aan de standaard en dus compliant ben

...zodat [vul aan].

Definition of ready

Iedereen in het team begrijpt de user story
Is klein genoeg voor een sprint
Product Owner akkoord en voorzien van prio
Voorzien van Acceptatiecriteria
Voorzien van Definition of Done
Voorzien van taken
Vastgelegd Github en in geplaatst in kolom ready for sprint

Definition of done

Algemeen

Een werkwijze/middel/tools om ZDS-API goed in beheer te nemen.

Specifiek

Oplossingsrichting

...

Acceptatiecriteria

Niet belemmerend werken voor beheer andere standaarden
...

Taken

... (@...)
... (@...)

Als beheerder wil ik weten waaraan een standaard/referentie implementie qua beschikbaarheid, performance, etc... moet voldoen.

Visie beheer formuleren en publiceren

Als beheerder wil ik weten welke problemen kunnen optreden bij het hosten van versies van referentie implementaties

zodat ik weet waar ik tegenaan kan lopen.

Definition of ready

Iedereen in het team begrijpt de user story
Is klein genoeg voor een sprint
Product Owner akkoord en voorzien van prio
Voorzien van Acceptatiecriteria
Voorzien van Definition of Done
Voorzien van taken
Vastgelegd Github en geplaatst in kolom ready for sprint

Definition of done

Algemeen

Bij het hosten van Referentie Implementaties (RI) kunnen problemen optreden waardoor leveranciers en gemeenten de RI niet meer kunnen benaderen. Deze problemen moeten zo snel mogelijk opgelost worden zodat de beschikbaarheid van de RI zo hoog mogelijk blijft. Een overzicht van mogelijk optredende problemen en hoe te bepalen welk probleem het betreft is een eerste stap naar de oplossing.
Het overzicht moet zo nodig in de toekomst uit te breiden zijn.

Specifiek

Er is een lijst met problemen die op kunnen treden met de gehoste versies van de RI (volgens mij hebben we het dan over de Docker containers);
Per probleem is duidelijk beschreven hoe vastgesteld kan worden dat het om dit probleem handelt;

Oplossingsrichting

Inventariseer de mogelijk op tredende problemen en beschrijf hoe de analyse plaatsvindt.

Acceptatiecriteria

Niet belemmerend werken voor beheer andere standaarden
Er is een document waarin de problemen zijn opgesomd met de daarbij horende analyse.

Taken

inventariseren problemen (@kciredor)
analyse beschrijven (@kciredor)
review document (@melsk-r @michielverhoef @joeribekker )

Als beheerder wil ik dat API standaarden op gelijksoortige wijze worden overdragen door API devs

zodat niet elke API afwijkend beheerd moet worden

Definition of ready

Iedereen in het team begrijpt de user story
Is klein genoeg voor een sprint
Product Owner akkoord en voorzien van prio
Voorzien van Acceptatiecriteria
Voorzien van Definition of Done
Voorzien van taken
Vastgelegd Github en in geplaatst in kolom ready for sprint

Definition of done

Algemeen

Een werkwijze/middel/tools om ZDS-API goed in beheer te nemen.

Specifiek

Er is een lijst van componenten die overgedragen (kunnen) worden;
Er is vastgelegd hoe deze zaken worden overgedragen en wat daarvoor de randvoorwaarden zijn;

Acceptatiecriteria

Taken

Inventariseer de over te dragen componenten en documenteer dit. (@...)
Beschrijf de overdrachtsprocedure. (@...)
Benoem per component eventuele randvoorwaarden. (@...)
.... (@...)

Als gebruiker wil ik duidelijkheid over de status van de standaard zodat ik weet waar ik met mijn product aan toe ben.

Als leverancier of gemeente wil ik weten wat de status is van een wijziging die ik graag wil zodat ik weet waar ik aan toe ben.

zodat....

Definition of ready

Iedereen in het team begrijpt de user story
Is klein genoeg voor een sprint
Product Owner akkoord en voorzien van prio
Voorzien van Acceptatiecriteria
Voorzien van Definition of Done
Voorzien van taken
Vastgelegd Github en in geplaatst in kolom ready for sprint

Definition of done

Algemeen

Een werkwijze/middel/tools om ZDS-API goed in beheer te nemen.

Specifiek

Acceptatiecriteria

Taken

.... (@...)
.... (@...)
.... (@...)
.... (@...)

Als API ontwikkelpartij wil ik duidelijke wensen en eisen hebben waaraan de oplevering moet voldoen zodat ik zeker weet dat de ontwikkelde API goed in beheer kan worden genomen, gehost wordt en doorontwikkeld kan worden.

Budget en resources regelen

Als leverancier of gemeente wil ik dat de beheerder van de standaard kan bemiddelen bij conflicten

Zodat bij conflicten een duidelijke uitspraak gedaan kan worden.

Definition of ready

Iedereen in het team begrijpt de user story
Is klein genoeg voor een sprint
Product Owner akkoord en voorzien van prio
Voorzien van Acceptatiecriteria
Voorzien van Definition of Done
Voorzien van taken
Vastgelegd Github en in geplaatst in kolom ready for sprint

Definition of done

Algemeen

Een werkwijze/middel/tools om ZDS-API goed in beheer te nemen.

Specifiek

Oplossingsrichting

...

Acceptatiecriteria

Niet belemmerend werken voor beheer andere standaarden
...

Taken

... (@...)
... (@...)

Als beheerder wil ik wijzigingsvoorstellen van leveranciers kunnen beoordelen

zodat deze afgehandeld (afwijzen of goedkeuren) kunnen worden

Definition of ready

Iedereen in het team begrijpt de user story
Is klein genoeg voor een sprint
Product Owner akkoord en voorzien van prio
Voorzien van Acceptatiecriteria
Voorzien van Definition of Done
Voorzien van taken
Vastgelegd Github en in geplaatst in kolom ready for sprint

Definition of done

Algemeen

Een werkwijze/middel/tools om ZDS-API goed in beheer te nemen.

Specifiek

Oplossingsrichting

...

Acceptatiecriteria

Niet belemmerend werken voor beheer andere standaarden
...

Taken

... (@...)
... (@...)

Als leverancier wil ik een optimale developer experience bij een standaard

zodat de informatie en facliteiten voor elke standaard op een vergelijkbare manier opgezet is

Als beheerder wil ik terug kunnen vallen op API-devs om technische issues/features op te pakken

zodat referentie implementatie code snel en efficient wordt aangepast.

Definition of ready

Iedereen in het team begrijpt de user story
Is klein genoeg voor een sprint
Product Owner akkoord en voorzien van prio
Voorzien van Acceptatiecriteria
Voorzien van Definition of Done
Voorzien van taken
Vastgelegd Github en in geplaatst in kolom ready for sprint

Definition of done

Er is een procedure voor gedocumenteerd in markdown op GitHub.

Algemeen

Een werkwijze/middel/tools om ZDS-API goed in beheer te nemen.

Specifiek

Er is een beslissing gemaakt wie API-devs zijn en dat ik deze kan inschakelen

Acceptatiecriteria

Niet belemmerend werken voor beheer andere standaarden

Taken

.... (@...)
.... (@...)
.... (@...)
.... (@...)

Als leverancier wil ik weten waaraan mijn wijzigingsvoorstel moet voldoen

zodat deze snel kan worden beoordeeld en worden opgenomen in de API.

Als beheerder wil ik kunnen werken met Git

Definition of ready

Iedereen in het team begrijpt de user story
Is klein genoeg voor een sprint
Product Owner akkoord en voorzien van prio
Voorzien van Definition of Done
Voorzien van Acceptatiecriteria
Voorzien van taken
Vastgelegd Github en in geplaatst in kolom ready for sprint

Definition of done

Kunnen werken met Github

Acceptatiecriteria

Geschikt voor alle beheerders/projectmedewerkers

Taken

Comments op tutorial Frank langs Joeri (@michielverhoef @joeribekker) Wellicht mogelijk met
Tutorial updaten en in beheer nemen
On the job

Als beheerder wil ik weten welke partijen bij de ontwikkeling van een standaard betrokken zijn geweest

zodat ik vragen kan stellen over aspecten/ontwerp beslissingen van de API

Definition of ready

Iedereen in het team begrijpt de user story
Is klein genoeg voor een sprint
Product Owner akkoord en voorzien van prio
Voorzien van Acceptatiecriteria
Voorzien van Definition of Done
Voorzien van taken
Vastgelegd Github en in geplaatst in kolom ready for sprint

Definition of done

Algemeen

Een werkwijze/middel/tools om ZDS-API goed in beheer te nemen.

Specifiek

Documentatie wie de ontwikkelaar(s) is/zijn met daarin alle informatie zodat ik vragen kan stellen.
Lijst bevat:
- contactpersoon organisatie
- namen deelnemende personen
- rol in het project van de deelnemende personen
- welke projecten zijn ze betrokken geweest

Acceptatiecriteria

Niet belemmerend werken voor beheer andere standaarden
Vindbaar en opgenomen in standaard documentatie
Informatie is actueel

Taken

Template maken online (@melsk-r )
Procedure beschrijven in beheer.md (@melsk-r )
Repository? (@michielverhoef)
PR Template (@melsk-r)
Invullen template (@joeribekker)
Voorbeeld template maken beheer.md (@TCIMEddy)

Als beheerder wil ik weten hoeveel versies van een standaard beheerd moeten worden zodat ik weet wanneer een versie de status 'eind gebruik' moet krijgen.

...zodat [vul aan].

Definition of ready

Iedereen in het team begrijpt de user story
Is klein genoeg voor een sprint
Product Owner akkoord en voorzien van prio
Voorzien van Acceptatiecriteria
Voorzien van Definition of Done
Voorzien van taken
Vastgelegd Github en in geplaatst in kolom ready for sprint

Definition of done

Algemeen

Een werkwijze/middel/tools om ZDS-API goed in beheer te nemen.

Specifiek

Oplossingsrichting

...

Acceptatiecriteria

Niet belemmerend werken voor beheer andere standaarden
...

Taken

... (@...)
... (@...)

test

Als beheerder wil ik meerdere versies van dezelfde standaard kunnen beheren

Zodat de geldige versies van een standaard ondersteund kunnen worden

Als beheerder wil ik een algemene werkwijze die voor alle API standaarden te gebruiken is

Zodat niet bij elke nieuwe standaard het wiel opnieuw uitgevonden moet worden

Definition of ready

Iedereen in het team begrijpt de user story
Is klein genoeg voor een sprint
Product Owner akkoord en voorzien van prio
Voorzien van Acceptatiecriteria
Voorzien van Definition of Done
Voorzien van taken
Vastgelegd Github en in geplaatst in kolom ready for sprint

Definition of done

Algemeen

Een werkwijze/middel/tools om ZDS-API goed in beheer te nemen.

Specifiek

Oplossingsrichting

...

Acceptatiecriteria

Niet belemmerend werken voor beheer andere standaarden
...

Taken

... (@...)
... (@...)

Als beheerder wil ik zo concreet mogelijke voorstellen voor API wijzigingen

zodat deze snel gereviewed en doorgevoerd kunnen worden.

Definition of ready

Iedereen in het team begrijpt de user story
Is klein genoeg voor een sprint
Product Owner akkoord en voorzien van prio
Voorzien van Acceptatiecriteria
Voorzien van Definition of Done
Voorzien van taken
Vastgelegd Github en in geplaatst in kolom ready for sprint

Definition of done

Algemeen

Een werkwijze/middel/tools om ZDS-API goed in beheer te nemen.

Specifiek

Acceptatiecriteria

Taken

.... (@...)
.... (@...)
.... (@...)
.... (@...)

Als beheerder wil ik weten hoe een evt. aanwezige roadmap van een standaard er uitziet zodat ik daar bij mijn planning rekening mee kan houden.

...zodat ik daar bij mijn onderhoudsplanning rekening mee kan houden.

Definition of ready

Iedereen in het team begrijpt de user story
Is klein genoeg voor een sprint
Product Owner akkoord en voorzien van prio
Voorzien van Acceptatiecriteria
Voorzien van Definition of Done
Voorzien van taken
Vastgelegd Github en in geplaatst in kolom ready for sprint

Definition of done

Algemeen

Een werkwijze/middel/tools om ZDS-API goed in beheer te nemen.

Specifiek

We moeten bepalen of het aanvaardbaar is dat een ontwikkelproject de planning van de beheerders kan afdwingen middels beloftes dan wel roadmap die zijn gedaan dan wel afgegeven tijdens het ontwikkeltraject.
Indien dat het geval is moet een eventuele roadmap en/of belofte overgedragen worden
...

Oplossingsrichting

...

Acceptatiecriteria

Niet belemmerend werken voor beheer andere standaarden
Er is een duidelijke richtlijn hoe hiermee moet worden omgegaan.
...

Taken

... (@...)
... (@...)

Als leverancier en/of gemeenten wil ik weten of er een standaard is, zodat ik weet of ik deze moet gebruiken

Als beheerder wil ik duidelijkheid over de eisen waaraan een over te dragen standaard moet voldoen.

...zodat:

een ontwikkelteam vooraf weet waaraan het toe is en weet waarin het moet voorzien.
er daarover geen discussie kan ontstaan bij overdracht van een standaard van ontwikkeling naar beheer.

Definition of ready

Iedereen in het team begrijpt de user story
Is klein genoeg voor een sprint
Product Owner akkoord en voorzien van prio
Voorzien van Acceptatiecriteria
Voorzien van Definition of Done
Voorzien van taken
Vastgelegd Github en in geplaatst in kolom ready for sprint

Definition of done

Algemeen

Een werkwijze/middel/tools om ZDS-API goed in beheer te nemen.

Specifiek

Alle eisen waaraan een standaard moet voldoen voordat tot overdracht kan worden overgegaan moeten worden vastgelegd
Indien er situaties zijn waarin niet aan een eis kan worden voldaan dan moet dat per eis worden vastgelegd zodat een ontwikkelteam zich er op kan beroepen.

Oplossingsrichting

...

Acceptatiecriteria

Niet belemmerend werken voor beheer andere standaarden
...

Taken

Stel een lijst met eisen op. (@...)
Bepaal per eis of er situaties zijn waarin niet aan die eis hoeft te worden voldaan. (@...)

Als gebruiker van de standaard wil ik een voorstel voor een aanpassing van de standaard kunnen doen

Zodat de standaard verbeterd kan worden op basis van ervaringen in de praktijk

Definition of ready

Iedereen in het team begrijpt de user story
Is klein genoeg voor een sprint
Product Owner akkoord en voorzien van prio
Voorzien van Acceptatiecriteria
Voorzien van Definition of Done
Voorzien van taken
Vastgelegd Github en in geplaatst in kolom ready for sprint

Definition of done

Algemeen

Een werkwijze/middel/tools om ZDS-API goed in beheer te nemen.

Specifiek

Acceptatiecriteria

Taken

.... (@...)
.... (@...)
.... (@...)
.... (@...)

Als beheerder wil ik dat de nog niet gerealiseerde backlog van een nieuwe standaard overgedragen wordt aan beheer

zodat deze wensen en eisen voor de roadmap/doorontwikkeling niet verloren gaan

Definition of ready

Iedereen in het team begrijpt de user story
Is klein genoeg voor een sprint
Product Owner akkoord en voorzien van prio
Voorzien van Acceptatiecriteria
Voorzien van Definition of Done
Voorzien van taken
Vastgelegd Github en in geplaatst in kolom ready for sprint

Definition of done

Er is een procedure voor gedocumenteerd in markdown op GitHub.

Algemeen

Een werkwijze/middel/tools om ZDS-API goed in beheer te nemen.

Specifiek

Het is duidelijk wat er gebeurt met deze User Stories.
Backlog blijft waar hij is. Het is niet de bedoeling om de issues in de backlog naar een andere backlog over te hevelen. Geef de beheerder(s) echter de gelegenheid om vragen te stellen en om zo nodig kennis te maken met de ontwikkelaar(s) van de standaard.

Acceptatiecriteria

Niet belemmerend werken voor beheer andere standaarden
Procedure is eenduidig.

Taken

Procedure opstellen

Als leverancier of gemeente wil ik 24*7 vragen over de standaard kunnen stellen zodat ik snel verder kan

...zodat [vul aan].

Definition of ready

Iedereen in het team begrijpt de user story
Is klein genoeg voor een sprint
Product Owner akkoord en voorzien van prio
Voorzien van Acceptatiecriteria
Voorzien van Definition of Done
Voorzien van taken
Vastgelegd Github en in geplaatst in kolom ready for sprint

Definition of done

Algemeen

Een werkwijze/middel/tools om ZDS-API goed in beheer te nemen.

Specifiek

Oplossingsrichting

...

Acceptatiecriteria

Niet belemmerend werken voor beheer andere standaarden
...

Taken

... (@...)
... (@...)

Als beheerder wil ik updates kunnen uitvoeren op de referentie-implementaties

zodat deze in lijn blijft lopen met de OAS3 specificatie zodra deze wijzigt,

Lijkt erg op #57. Volgende sprint kijken wat er nog openstaat in deze User Story
Definition of ready

Iedereen in het team begrijpt de user story
Is klein genoeg voor een sprint
Product Owner akkoord en voorzien van prio
Voorzien van Acceptatiecriteria
Voorzien van Definition of Done
Voorzien van taken
Vastgelegd Github en in geplaatst in kolom ready for sprint

Definition of done

Algemeen

Een werkwijze/middel/tools om ZDS-API goed in beheer te nemen.

Specifiek

ontwikkelomgeving moet beschikbaar zijn op laptop/desktop;

Toekomstige beheerders moeten beschikken over:

vaardigheden voor het zelf opzetten van de ontwikkelomgeving;
vaardigheden voor het uitvoeren van updates;
vaardigheden voor het uitrollen van een nieuwe versie van de referentie-implementaties;
vaardigheden voor het opnieuw kunnen genereren van de OAS3 specificaties;
autorisatierechten binnen de beheeromgeving voor het kunnen uitvoeren van de updates.
...

Acceptatiecriteria

Taken

Regelen autorisaties. (@...)
Regelen benodigde software en evt. licenties. (@...)
Opzetten traject voor kennisoverdracht (workshop, cursus, zelf-leertraject, ...) (@...)
.... (@...)

Als leverancier en gemeenten wil ik wijzigingsvoorstellen op de OAS3 kunnen doen

..zodat problemen die ik ervaar in een oplossingstraject komen en mogelijkheden voor nieuwe features ter overweging worden meegenomen voor een nieuwe versie van een standaard.

gerelateerd aan #21

Definition of ready

Iedereen in het team begrijpt de user story
Is klein genoeg voor een sprint
Product Owner akkoord en voorzien van prio
Voorzien van Definition of Done
Voorzien van Acceptatiecriteria
Voorzien van taken
Vastgelegd Github en in geplaatst in kolom ready for sprint

Definition of done

Algemeen

Een werkwijze/middel/tools om ZDS-API goed in beheer te nemen.

Specifiek

moet een gebruiksvriendelijk kanaal zijn om melding te kunnen doen
gebruiksaanwijzing van de melding
gebruiksvriendelijk format melding
kanaal en werkwijze live

Acceptatiecriteria

Niet belemmerend werken voor beheer andere standaarden
Gebruiksvriendelijk

Taken

Lijstje stellen met mogelijkheden + keuze ()
Format maken (@...)
Gebruiksaanwijzing maken (@...)
"ontvangstbevestiging maken" (@...)
kanaal inrichten (@....)

Als leverancier wil ik invloed kunnen uitoefenen op de API specificatie

Als beheerder wil ik overzicht van de onderdelen die vanuit een ontwikkeltraject in beheer genomen moeten worden

Zodat ik weet welke kennis nodig is om de API standaard in beheer te nemen.

Definition of ready

Iedereen in het team begrijpt de user story
Is klein genoeg voor een sprint
Product Owner akkoord en voorzien van prio
Voorzien van Acceptatiecriteria
Voorzien van Definition of Done
Voorzien van taken
Vastgelegd Github en in geplaatst in kolom ready for sprint

Definition of done

Algemeen

Een werkwijze/middel/tools om ZDS-API goed in beheer te nemen.

Specifiek

Oplossingsrichting

...

Acceptatiecriteria

Niet belemmerend werken voor beheer andere standaarden
...

Taken

... (@...)
... (@...)

Als beheerder wil ik over de benodigde software (met evt. licenties) kunnen beschikken.

Zodat ik het beheerwerk ook echt kan uitvoeren.

Definition of ready

Iedereen in het team begrijpt de user story
Is klein genoeg voor een sprint
Product Owner akkoord en voorzien van prio
Voorzien van Acceptatiecriteria
Voorzien van Definition of Done
Voorzien van taken
Vastgelegd Github en in geplaatst in kolom ready for sprint

Definition of done

Algemeen

Een werkwijze/middel/tools om ZDS-API goed in beheer te nemen.

Specifiek

Benodigde software of een link naar waar deze kan worden gedownload is aanwezig.
Van de software waarvoor licenties noodzakelijk zijn zijn licenties voor alle beheerders aanwezig.

Acceptatiecriteria

Niet belemmerend werken voor beheer andere standaarden
Er is een lijst van de benodigde software, waar deze verkregen kan worden en hoe deze geïnstalleerd moet worden in het geval daar speciale handelingen voor nodig zijn
De software kan bij wijze van spreken direct geïnstalleerd worden.

Taken

Inventarisatie van de benodigde software. (@joeribekker)
Bestellen van de benodigde licenties. (@...)
[ ]

Als beheerder wil ik weten hoe ik oude versies van een standaard moet uitfaseren.

...zodat ik het aantal in beheer zijnde versies van de standaarden beperkt kan houden en de beheerlast niet te hoog wordt.

Definition of ready

Iedereen in het team begrijpt de user story
Is klein genoeg voor een sprint
Product Owner akkoord en voorzien van prio
Voorzien van Acceptatiecriteria
Voorzien van Definition of Done
Voorzien van taken
Vastgelegd Github en in geplaatst in kolom ready for sprint

Definition of done

Algemeen

Een werkwijze/middel/tools om ZDS-API goed in beheer te nemen.

Specifiek

Waaraan heb ik me als beheerder te houden.
- hoeveel versies mogen er in beheer zijn?
- moet een voorgaande versie altijd in beheer blijven of zijn er situaties denkbaar dat we dit niet doen?
- hoe communiceer ik het uitfaseren van een versie van een standaard?
- wordt de oudste versie van een standaard al meteen uit beheer gehaald zodra er een nieuwe versie in beheer komt?
- betekent het uit beheer halen ook dat de deliverables van een standaard niet meer vanaf de gebruikelijke websites opgehaald kunnen worden?
Welke technische maatregelen moet ik treffen
...

Oplossingsrichting

...

Acceptatiecriteria

Niet belemmerend werken voor beheer andere standaarden
Op de hierboven gestelde vragen moet een antwoord zijn gegeven en dit moet tot een werkbare situatie leiden.

Taken

... (@...)
... (@...)

Als leverancier en gemeente moet duidelijk zijn wat ik kan verwachten van het beheer van een standaard zodat ik daar mijn proces op kan inrichten.

zodat....

Definition of ready

Iedereen in het team begrijpt de user story
Is klein genoeg voor een sprint
Product Owner akkoord en voorzien van prio
Voorzien van Acceptatiecriteria
Voorzien van Definition of Done
Voorzien van taken
Vastgelegd Github en in geplaatst in kolom ready for sprint

Definition of done

Algemeen

Een werkwijze/middel/tools om ZDS-API goed in beheer te nemen.

Specifiek

Acceptatiecriteria

Taken

.... (@...)
.... (@...)
.... (@...)
.... (@...)

Als beheerder wil ik weten wie de gebruikers zijn van een standaard

Zodat ik actief nieuws, updates en andere berichten kan versturen indien nodig

Definition of ready

Iedereen in het team begrijpt de user story
Is klein genoeg voor een sprint
Product Owner akkoord en voorzien van prio
Voorzien van Acceptatiecriteria
Voorzien van Definition of Done
Voorzien van taken
Vastgelegd Github en in geplaatst in kolom ready for sprint

Definition of done

Algemeen

Een werkwijze/middel/tools om ZDS-API goed in beheer te nemen.

Specifiek

Oplossingsrichting

...

Acceptatiecriteria

Niet belemmerend werken voor beheer andere standaarden
...

Taken

... (@...)
... (@...)

Als beheerder wil ik weten welk karakter de beheerprojecten hebben zodat ik weet hoe ik moet gaan werken

De ontwikkeling van een standaard gebeurd nu in GitHub. De inrichting van GitHub suggereert scrum als projectvorm (is dat wel zo), zo staan de nog uit te voeren ontwikkelingen in de backlog. Is het echter wel zo logisch dat het beheer weer gebruik maakt van scrum?

Definition of ready

Iedereen in het team begrijpt de user story
Is klein genoeg voor een sprint
Product Owner akkoord en voorzien van prio
Voorzien van Acceptatiecriteria
Voorzien van Definition of Done
Voorzien van taken
Vastgelegd Github en in geplaatst in kolom ready for sprint

Definition of done

Algemeen

Een werkwijze/middel/tools om ZDS-API goed in beheer te nemen.

Specifiek

Duidelijkheid over de te hanteren methodiek dan wel duidelijkheid dat dit per project wordt bepaald.
...

Oplossingsrichting

Kanban
...

Acceptatiecriteria

Niet belemmerend werken voor beheer andere standaarden
...

Taken

... (@...)
... (@...)

Als beheerder wil ik API beheerkennis op doen

zodat ik api-beheer adequaat kan uitvoeren

Definition of ready

Iedereen in het team begrijpt de user story
Is klein genoeg voor een sprint
Product Owner akkoord en voorzien van prio
Voorzien van Acceptatiecriteria
Voorzien van Definition of Done
Voorzien van taken
Vastgelegd Github en in geplaatst in kolom ready for sprint

Definition of done

Algemeen

Een werkwijze/middel/tools om ZDS-API goed in beheer te nemen.

Specifiek

Beheerders moeten over voldoende kennis kunnen beschikken die nodig is om standaarden en referentie implementaties te beheren.
Denk daarbij aan:
- Python #62
- Docker #61
- Jenkins #60
- GitHub #1
Een overzicht hebben van de onderlinge afhankelijkheden en volgordes van deze systemen/onderdelen

afhankelijk van nog te nemen beslissingen:

Enterprise Architect
Imvertor

Acceptatiecriteria

Niet belemmerend werken voor beheer andere standaarden
Beheerders dienen aantoonbaar over de noodzakelijke kennis te beschikken (hoe is mij nog even niet duidelijk).
...

Taken

Inventarisatie van de benodigde kennis. (@...)
Bepalen van de minimaal benodigde kennis voor beheeroverdracht. (@...)
Bepalen van de wijze waarop deze kennis wordt overgedragen dan wel verkregen. (@...)
Overdracht van de kennis (@...).

Als beheerder wil ik weten in welke mate een standaard backwards compatibe moet zijn zodat ik daar bij doorontwikkeling rekening mee kan houden.

...zodat voor mij duidelijk is welke aanpassingen wel en welke niet toegestaan zijn.

Definition of ready

Iedereen in het team begrijpt de user story
Is klein genoeg voor een sprint
Product Owner akkoord en voorzien van prio
Voorzien van Acceptatiecriteria
Voorzien van Definition of Done
Voorzien van taken
Vastgelegd Github en in geplaatst in kolom ready for sprint

Definition of done

Algemeen

Een werkwijze/middel/tools om ZDS-API goed in beheer te nemen.

Specifiek

Het is duidelijk binnen welke kaders een beheerder op dit gebied kan doorontwikkelen.
...

Oplossingsrichting

stel vooraf kaders die voor elk koppelvlak hetzelfde zijn
laat de koppelvlak-werkgroep (indien we er voor kiezen in de organisatievorm door te gaan) bepalen of wijzigingen acceptabel zijn
laat tijdens de sprintdemo's (indien we er voor kiezen met scrum door te gaan) bepalen of een wijziging acceptabel is
hanteer een nog andere methode

Acceptatiecriteria

Niet belemmerend werken voor beheer andere standaarden
...

Taken

Maak een overzicht alle mogelijke te hanteren methodes met daarvan de voor- en nadelen (@...)
... (@...)

Als beheerder wil ik een nieuwe versie van de API standaard kunnen uitrollen op het API testplatform

Zodat gebruikers hun implementatie kunnen testen.

Definition of ready

Iedereen in het team begrijpt de user story
Is klein genoeg voor een sprint
Product Owner akkoord en voorzien van prio
Voorzien van Acceptatiecriteria
Voorzien van Definition of Done
Voorzien van taken
Vastgelegd Github en in geplaatst in kolom ready for sprint

Definition of done

Algemeen

Een werkwijze/middel/tools om ZDS-API goed in beheer te nemen.

Specifiek

aan welke voorwaarden moet voldaan worden voordat er van een uitrol sprake kan zijn?
het moet duidelijk beschreven zijn hoe je een nieuwe versie uitrolt op het API testplatform
de oude versie van de standaard mag daar geen last van ondervinden

Acceptatiecriteria

Niet belemmerend werken voor beheer andere standaarden
De te ondernemen acties moeten goed beschreven zijn.

Taken

Beschrijf aan welke de voorwaarden moet worden voldaan. (@...)
Beschrijf de te hanteren procedure. (@...)

Als leverancier of gemeente wil ik wijzigingsvoorstellen kunnen zien/volgen en hierop kunnen reageren

zodat ik op de hoogte ben van de richting waarin een oplossing wordt gezocht en ik deze richting kan beïnvloeden en hierover een mening kan geven.

Gerelateerd aan #20

.Definition of ready

Iedereen in het team begrijpt de user story
Is klein genoeg voor een sprint
Product Owner akkoord en voorzien van prio
Voorzien van Acceptatiecriteria
Voorzien van Definition of Done
Voorzien van taken
Vastgelegd Github en in geplaatst in kolom ready for sprint

Definition of done

Algemeen

Een werkwijze/middel/tools om ZDS-API goed in beheer te nemen.

Specifiek

Er moet bepaald worden hoe leveranciers en gemeenten ingediende wijzigingsvoorstellen (voor het oplossen van problemen of het voorzien van de standaard van nieuwe features) kunnen inzien en hoe ze daarop en op de binnenkomende reacties kunnen reageren.
De gekozen oplossing moet worden ingericht.

Oplossingsrichting

...

Acceptatiecriteria

Niet belemmerend werken voor beheer andere standaarden
Het is een gebruiksvriendelijke wijze.

Taken

... (@...)
... (@...)

Als beheerder wil ik zeker weten dat aanpassingen aan de referentie implementatie werken

zodat er geen falende implementaties ontstaan.

Een wijziging in de OAS moet gevolgd worden door een wijziging van de ref. implementatie, de testsuite en het API testplatform. Deze moeten allen succesvol worden doorlopen anders is er een deel dat niet werkt. Wat niet werkt kan je ook niet beheren.

Definition of ready

Iedereen in het team begrijpt de user story
Is klein genoeg voor een sprint
Product Owner akkoord en voorzien van prio
Voorzien van Acceptatiecriteria
Voorzien van Definition of Done
Voorzien van taken
Vastgelegd Github en in geplaatst in kolom ready for sprint

Definition of done

Algemeen

Een werkwijze/middel/tools om ZDS-API goed in beheer te nemen.

Specifiek

Oplossingsrichting

...

Acceptatiecriteria

Niet belemmerend werken voor beheer andere standaarden
...

Taken

... (@...)
... (@...)

Als beheerder wil ik weten hoe ik een nieuwe versie van een standaard aan het testplatform kan toevoegen zodat gebruikers deze kunnen testen.

...zodat [vul aan].

Definition of ready

Iedereen in het team begrijpt de user story
Is klein genoeg voor een sprint
Product Owner akkoord en voorzien van prio
Voorzien van Acceptatiecriteria
Voorzien van Definition of Done
Voorzien van taken
Vastgelegd Github en in geplaatst in kolom ready for sprint

Definition of done

Algemeen

Een werkwijze/middel/tools om ZDS-API goed in beheer te nemen.

Specifiek

Oplossingsrichting

...

Acceptatiecriteria

Niet belemmerend werken voor beheer andere standaarden
...

Taken

... (@...)
... (@...)

Als beheerder wil ik een overzicht van de benodigde software incl. eventuele licenties.

...zodat:

duidelijk is welke software geïnstalleerd moet worden;
duidelijk is of er voor alle software licenties zijn;
bijgehouden kan worden wie welke software/licentie in gebruik heeft.

Definition of ready

Iedereen in het team begrijpt de user story
Is klein genoeg voor een sprint
Product Owner akkoord en voorzien van prio
Voorzien van Acceptatiecriteria
Voorzien van Definition of Done
Voorzien van taken
Vastgelegd Github en in geplaatst in kolom ready for sprint

Definition of done

Algemeen

Een werkwijze/middel/tools om ZDS-API goed in beheer te nemen.

Specifiek

Er wordt een lijst met benodigde software opgesteld;
Bij elke software wordt vastgelegd of licenties noodzakelijk zijn en zo ja wat die licenties zijn als ze al voorhanden zijn;
Er wordt vastgelegd welke licentie bij wie geïnstalleerd is/gaat worden;
...

Oplossingsrichting

...

Acceptatiecriteria

Niet belemmerend werken voor beheer andere standaarden
Er is een lijst met benodigde software;
Bij elke software is vastgelegd of licenties noodzakelijk zijn en zo ja wat die licenties zijn indien ze al aanwezig zijn;
Er is vastgelegd welke licentie bij wie geïnstalleerd is/gaat worden;
Er kan bepaald worden welke licenties besteld moeten worden;
...

Taken

Inventariseer samen met @joeribekker de benodigde software (@...)
Bepaal voor welke software een licentie nodig is en inventariseer evt. licenties (@...)

Als beheerder wil ik dat er kwalitatief goede referentie implementaties zijn

zodat deze zonder al te veel beheerslast overgenomen kunnen worden en kunnen blijven draaien.

Definition of ready

Iedereen in het team begrijpt de user story
Is klein genoeg voor een sprint
Product Owner akkoord en voorzien van prio
Voorzien van Acceptatiecriteria
Voorzien van Definition of Done
Voorzien van taken
Vastgelegd Github en in geplaatst in kolom ready for sprint

Definition of done

Algemeen

Een werkwijze/middel/tools om ZDS-API goed in beheer te nemen.

Specifiek

Oplossingsrichting

...

Acceptatiecriteria

Niet belemmerend werken voor beheer andere standaarden
...

Taken

... (@...)
... (@...)

vng-realisatie / api-beheer Goto Github PK

api-beheer's People

Contributors

Stargazers

Watchers

api-beheer's Issues

Recommend Projects

Recommend Topics

Recommend Org