Als developer wil ik eenduidige documentatie

VNG-Realisatie / huwelijksplanner

Other

4 stars 4 forks source link

Als developer wil ik eenduidige documentatie #189

Open matthiasoliveiro opened 4 years ago

matthiasoliveiro commented 4 years ago

zodat het duidelijk is voor elk component wat waar staat.

Epic #105

[ ] Menu bar goed benutten.
[ ] GraphQL voorzien van de juiste layout
[ ] Landings page in de layout van de VNG

JanWillemKooi commented 4 years ago

Is dit een user story die afgerond kan worden of een DoD ding?

rubenvdlinde commented 4 years ago

Deze user story is eigenlijk gekopeld aan het goedbijwerken van de readme.md

PatrickCastenmiller commented 4 years ago

Openstaande vraag: Is de documentatie die we nu opleveren duidelijk genoeg en staat deze op de goede plek? Architectuur moet een review uitvoeren.

CMasselink commented 4 years ago

Wat we nog missen is "functionele documentatie". We hebben nu alleen een API specificatie in de vorm van redoc. De vraag is of een gemeente / ontwikkelaar de huwelijksplanner aan de praat krijgt / de componenten snapt als die alleen de huidige documentatie ter beschikking heeft