VNG-Realisatie / VNG-R-Respec-Organization-configurations

VNG-R global configurations repository voor Respec
https://vng-realisatie.github.io/VNG-R-Respec-Organization-configurations/
Other
0 stars 0 forks source link

Willen we ‘Laatste werkversie’ tonen? #18

Closed melsk-r closed 4 months ago

melsk-r commented 7 months ago

In de documentatie kan het veld Laatste werkversie: voorkomen. Daarin wordt dan niet de url van de in de 'publicatie' repository geplaatste versie van de documentatie getoond maar juist de GitHub Pages url van de project repository. Dat betekent dat je dus steeds als er een wijziging is aangebracht aan die project repository je de resultaten daarvan kan bekijken.

ReSpec is oorspronkelijk bedoeld voor het maken van (beschrijvingen van) standaarden en ontstaan bij het W3C. Daar is de gewoonte om de werkversie van het document altijd te tonen, zodat de belanghebbenden bij de standaard altijd kunnen meekijken, tijdens het maakproces. Het open, transparant ontwikkelen van standaarden heeft als grote voordeel dat je vertrouwen wekt en belanghebbenden de gelegenheid geeft om mee te denken en kijken. Ik kan me echter ook voorstellen dat er momenten zijn dat dit niet gewenst is.

De vraag is dus wat we willen? Vinden we het toegestaan de document configuratie zo te configureren dat dit veld verborgen blijft?

hdksi commented 5 months ago

Wat mij betreft geldt een aanbeveling de laatste werkversie te tonen; verplichten zou ik zonder argumentatie dat dit in alle gevallen gewenst of nuttig is niet doen.

melsk-r commented 4 months ago

Is als zodanig opgenomen in de documentatie.