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

Over welke specStatus waardes willen wij in Respec documenten kunnen beschikken? #3

Open melsk-r opened 7 months ago

melsk-r commented 7 months ago

In het organisatie configuratie bestand worden in de property 'localizationStrings' op dit moment de volgende specificatie statussen gedefinieerd:

wv: "Werkversie",
cv: "Consultatieversie",
vv: "Versie ter vaststelling",
def: "Vastgestelde versie",
eo: "Verouderde versie",
tg: "Teruggetrokken versie",
tst: "Test versie",
ig: "In Gebruik versie",
io: "In Ontwikkeling versie"

De laatste 2 zijn er door mijzelf al aan toegevoegd. Niet al deze codes zijn van toepassing binnen VNG-R en we kunnen afspreken welke codes we wel en welke we niet gebruiken. Het is n.m.m. echter beter deze lijst op te schonen zodat de niet van toepassing zijnde codes geen invloed hebben op de document generatie.

De codes 'wv', 'def' kunnen n.m.m. worden verwijderd, deze komen overeen met 'io' en 'ig'. De vraag is of we verwachten dat de codes 'cv', 'vv', 'eo', 'tg' en 'tst' wel gebruikt zullen worden. Zo niet dan kunnen ook die verwijderd worden.

De teksten achter de codes worden in onze Respec documentatie opgenomen in de subtitel of in het label linksboven (zie hieronder).

image

In de property 'sotdText/nl' wordt op basis van de codes ook gedefinieerd welke teksten in het hoofdstuk 'Status van dit document' moeten worden opgenomen. Dit zijn:

basis: "Dit is een document zonder officiële status.",
wv: `Dit is een werkversie die op elk moment kan worden gewijzigd, verwijderd of vervangen door andere documenten. Het is geen door het TO goedgekeurde consultatieversie.`,
cv: `Dit is een door het TO goedgekeurde consultatieversie. Commentaar over dit document kan gestuurd worden naar `,
vv: `Dit is een definitief concept van de nieuwe versie van dit document. Wijzigingen naar aanleiding van consultaties zijn doorgevoerd.`,
def: `Dit is de definitieve versie van dit document. Wijzigingen naar aanleiding van consultaties zijn doorgevoerd.`,
ig: "Dit document is 'In Gebruik'.",
io: "Dit document is nog 'In Ontwikkeling'."

Ik heb over beide properties de volgende vragen:

hdksi commented 5 months ago

De codes 'wv', 'def' kunnen n.m.m. worden verwijderd, deze komen overeen met 'io' en 'ig'.

Mee eens.

De vraag is of we verwachten dat de codes 'cv', 'vv', 'eo', 'tg' en 'tst' wel gebruikt zullen worden.

Ik kan me het gebruik van deze codes in ieder geval voorstellen. Maar wellicht het idee van #5 volgen en toevoegen waar nodig? Immers hoe minder verschillende statussen we toepassen, hoe minder verwarring daarover kan ontstaan.

melsk-r commented 4 months ago

De specificatie-statussen 'wv', 'def', 'eo', en 'tst' zijn verwijderd en 'tg' is uitbecommentarieerd. De statussen 'cv' (Consultatieversie) en 'vv' (Versie ter vaststelling) heb ik naast 'io' en 'ig' behouden. De eerste heb ik nl. nu al in gebruik bij het MBG metamodel en het lijkt me handig ook al over 'vv' te kunnen beschikken. De Engelstalige varianten van deze codes zijn eveneens uit becommentarieerd en ook de configuratie properties 'sotdText' en 'labelColor' zijn hierop aangepast.