diff --git a/README.md b/README.md index 13e28cae..b28bf9ff 100644 --- a/README.md +++ b/README.md @@ -7,12 +7,12 @@ Deze repository is de locatie voor technische documentatie en het inbrengen en o * [Beheerorganisatie NLCS](https://www.bimloket.nl/p/434/Organisatie-beheer) * [Beheerhandleiding NLCS](https://nl-digigo.github.io/NLCS/managementmanual) * [Releaseprotocol NLCS](https://nl-digigo.github.io/NLCS/releaseprotocol) -* [Gebruikerswens indienen](https://github.com/nl-digigo/NLCS/issues) -* [Protocol afhandelen gebruikerswensen](https://github.com/nl-digigo/NLCS/blob/main/instructies/RASCI%20Github%20issues%20NLCS.pdf). +* [Gebruikerswens / issue indienen](https://github.com/nl-digigo/NLCS/issues) +* [Protocol afhandelen gebruikerswensen](https://nl-digigo.github.io/NLCS/protocolissues) ## Voor ontwerpers en tekenaars -* [Uitleg standaard](https://nl-digigo.github.io/NLCS/functionalspecification): Functionele specificatie van NLCS met daarin de toelichting op het beoogd doel en de werking van de standaard -* [Tekeningen en modellen maken](https://nl-digigo.github.io/NLCS/requirementscadmodels/) +* [Uitleg standaard](https://nl-digigo.github.io/NLCS/functionalspecification): De uitleg van de standaard met daarin de toelichting op het beoogd doel en de werking van de standaard +* [Eisen aan tekeningen en modellen](https://nl-digigo.github.io/NLCS/requirementscadmodels/) * [Voorbeeldtekeningen](https://www.nl-digigo.nl/p/432/Leren-van-anderen) ### Zelf applicatie inrichten diff --git a/docs/functionalspecification/h/0-samenvatting.md b/docs/functionalspecification/h/0-samenvatting.md index 304ebb36..f2bfc946 100644 --- a/docs/functionalspecification/h/0-samenvatting.md +++ b/docs/functionalspecification/h/0-samenvatting.md @@ -1,13 +1,12 @@ -Dit document bevat de uitleg van de standaard, de functionele specificatie van NLCS met daarin de toelichting op het beoogd doel en de werking van de standaard. +Dit document bevat de uitleg van de standaard met daarin de toelichting op het beoogd doel en de werking van de standaard. Dit document sluit aan op de volgende documenten: -* [Toelichting informatiemodel](https://bimloket.github.io/NLCS/code_documentation/): De toelichting op de uitgangspunten en modelleringswijze van het informatiemodel in linked data -* [Toelichting code, datasets, query's](https://bimloket.github.io/NLCS/howtoquery/): Een gebruikershandleiding om -* [Relaties tot andere standaarden](https://bimloket.github.io/NLCS/ontologyalignments/): documentatie van de ontology alignments (mappings waar een computer mee kan redeneren) of voorbereidingen daartoe met andere standaarden, waaronder IMGeo (voor BGT kaartinformatie) en het GWSW (Gemeentelijk woordenboek stedelijk water) -* [Uitwisselafspraken](https://bimloket.github.io/NLCS/representations/): Nu nog slechts een gebruikerswens. Een nader te bepalen set afspraken over de uitwisseling van modellen en tekeningen in open formaten, met daaraan toegevoegd objectinformatie -* [Eisen aan tekeningen en modellen](https://bimloket.github.io/NLCS/requirementscadmodels/) -* [Eisen aan software-implementatie](https://bimloket.github.io/NLCS/requirementssoftware/) + +* Uitleg standaard: voorliggend document +* [Eisen aan tekeningen en modellen](https://nl-digigo.github.io/NLCS/requirementscadmodels/) +* [Voorbeeldtekeningen](https://www.nl-digigo.nl/p/432/Leren-van-anderen) +
diff --git a/docs/managementmanual/h/0-samenvatting.md b/docs/managementmanual/h/0-samenvatting.md index 7bf90ab7..1ee9194c 100644 --- a/docs/managementmanual/h/0-samenvatting.md +++ b/docs/managementmanual/h/0-samenvatting.md @@ -1 +1,9 @@ -Dit document bevat de beheerhandleiding van NLCS \ No newline at end of file +Dit document bevat de beheerhandleiding van NLCS en is onderdeel van de volgende documentenreeks: + + +* [Beheerdocument DigiGO](https://www.bimloket.nl//documents/Beheerdocument_open_BIM-standaarden_v1_8.pdf) +* [Beheerorganisatie NLCS](https://www.bimloket.nl/p/434/Organisatie-beheer) +* Beheerhandleiding NLCS: voorliggend document +* [Releaseprotocol NLCS](https://nl-digigo.github.io/NLCS/releaseprotocol) +* [Gebruikerswens / issue indienen](https://github.com/nl-digigo/NLCS/issues) +* [Protocol afhandelen gebruikerswensen](https://nl-digigo.github.io/NLCS/protocolissues) \ No newline at end of file diff --git a/docs/managementmanual/h/1.md b/docs/managementmanual/h/1.md index 9926fbd8..631a42e5 100644 --- a/docs/managementmanual/h/1.md +++ b/docs/managementmanual/h/1.md @@ -7,19 +7,9 @@ Dit document beschrijft de beheerhandleiding van de diff --git a/docs/protocolissues/config.js b/docs/protocolissues/config.js new file mode 100644 index 00000000..0c5218f0 --- /dev/null +++ b/docs/protocolissues/config.js @@ -0,0 +1,24 @@ +var respecConfig = { + // => https://github.com/stichting-crow/respec/wiki + specStatus: "DEF", + shortName: "NLCS/protocolissues", + specType: "beheerdocumentatie", // vrije tekst, kleine letter + imprint: "bimloket", + editors: [ + // alleen `name` is verplicht, https://respec.org/docs/#person + { + name: "Elisabeth de Vries", + company: "DigiGO", + }, + ], + authors: [ + // alleen `name` is verplicht, https://respec.org/docs/#person + { + name: "Elisabeth de Vries", + company: "DigiGO", + }, + ], + github: "https://github.com/nl-digigo/NLCS", + license: "cc-by", + lint: { "no-unused-dfns": false }, +}; diff --git a/docs/protocolissues/h/0-samenvatting.md b/docs/protocolissues/h/0-samenvatting.md new file mode 100644 index 00000000..8b58ba14 --- /dev/null +++ b/docs/protocolissues/h/0-samenvatting.md @@ -0,0 +1,12 @@ +Dit document beschrijft het protocol voor het afhandelen gebruikerswensen. + +Dit protocol is onderdeel van een reeks documenten over het beheer van NLCS: + +## Beheer + +* [Beheerdocument DigiGO](https://www.bimloket.nl//documents/Beheerdocument_open_BIM-standaarden_v1_8.pdf) +* [Beheerorganisatie NLCS](https://www.bimloket.nl/p/434/Organisatie-beheer) +* [Beheerhandleiding NLCS](https://nl-digigo.github.io/NLCS/managementmanual) +* [Releaseprotocol NLCS](https://nl-digigo.github.io/NLCS/releaseprotocol) +* [Gebruikerswens indienen](https://github.com/nl-digigo/NLCS/issues) +* Protocol afhandelen gebruikerswensen: voorliggend document \ No newline at end of file diff --git a/docs/protocolissues/h/1.md b/docs/protocolissues/h/1.md new file mode 100644 index 00000000..9c125b38 --- /dev/null +++ b/docs/protocolissues/h/1.md @@ -0,0 +1,209 @@ +# Inleiding + + +Dit document beschrijft het protocol voor het afhandelen van gebruikerswensen die starten met binnenkomende issues. +Het doel van het protocol is de beschrijving van hoe issues op de GitHub van NLCS leiden tot besluiten over de standaard. + + +## Protocol + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Protocol afhandelen issues
Input: informatie in issueProcesstapIssue komt op naam van:Comments, op te nemen bij de issue
0. Issue komt binnen op GitHub
↓
GitHub issue waar nog geen naam bij staat voor verwerking en geen labels1. Wekelijkse controle op binnenkomende issues@indiener, bedankt voor je vraag, we gaan ermee aan de slagRSI
↓
2. Vraag om aanpassing informatiemodel of documentatieElisabethRSI
↓
3. Vraag om aanpassen of toevoegen objecten in NLCSNielsSRI
↓
Nee
naar 6 ↓
4. Besluit: moet om opheldering of besluit worden gevraagd?Elisabeth@indiener, kun jij mij dit nader toelichten?RSI
Ja ↓
5. Ophelderen gebruikersvraagElisabethDuidelijker beschreven gebruikersvraag opgenomen bij de issueRSI
↓
Nee
naar 9 ↓
6. Besluit: moet de issue worden uitgewerkt naar een oplossing?ElisabethInschatting impact: hoog / middel / laag, op basis daarvan toekennen aan Milestone voor een release, of opnemen als onderdeel van een ontwikkelprojectRSI
Ja ↓
7. Uitwerken voorstel aanpassing informatiemodel of documentatieElisabethBij de issue staat hoe dit wordt meegenomen in een volgende release van NLCSRSI
↓
8. Uitwerken voorstel aanpassen of toevoegen objecten in NLCSNielsBij de issue staat hoe dit wordt meegenomen in een volgende release van NLCSSRI
↓
Nee
naar 11 ↓
9. Besluit volgens het Releaseprotocol: wordt NLCS aangepast?Elisabeth "Issue wordt opgenomen in versie N + 1
Issue wordt niet opgenomen in NLCS vanwege besluit X" 		RSI
↓
10. Issue wordt verwerktElisabeth/NielsDe issue is gesloten. De issue verwerkt in de beheeromgeving en in de documentatie en wordt gepubliceerd in de eerstvolgende release + RSI
↓
11. Issue wordt afgeslotenElisabeth/NielsIssue wordt afgesloten met een meldingRSI
+ + + +## Toeliching RASCI +Het protocol geeft een invulling aan RASCI. RASCI is een acroniem dat wordt gebruikt om de rollen en verantwoordelijkheden van individuen binnen een team of organisatie te definiëren met betrekking tot een specifieke taak of proces. RASCI is een handige tool voor het helder definiëren van rollen en verantwoordelijkheden, waardoor teamleden beter begrijpen wie wat doet in een bepaald project of proces. + +De volgende RASCI-afkortingen worden gebruikt om de rol van de product manager, beheercommissie NLCS en de Expertcommissie NLCS aan te duiden in de 5e, 6e en 7e kolom van de tabel: +* R (Responsible): De persoon of personen die verantwoordelijk zijn voor het uitvoeren van de taak. Deze personen zijn direct betrokken bij de uitvoering en voltooiing van de activiteit. +* A (Accountable): De persoon die uiteindelijk verantwoordelijk is voor het resultaat van de taak. Deze persoon wordt vaak aangeduid als de "eigenaar" en neemt de eindbeslissingen. +* S (Support): Individuen die ondersteuning bieden aan degenen die verantwoordelijk zijn voor de uitvoering van de taak. Ze kunnen advies geven, middelen verstrekken of betrokken zijn bij bepaalde aspecten van het proces. +* C (Consulted): Personen die geraadpleegd moeten worden voordat beslissingen worden genomen of acties worden ondernomen. Hun input en expertise zijn waardevol voor het proces. +* I (Informed): Personen die op de hoogte moeten worden gehouden van de voortgang van de taak, maar die geen directe betrokkenheid hebben bij de uitvoering ervan. Ze worden op de hoogte gesteld van beslissingen en resultaten. \ No newline at end of file diff --git a/docs/protocolissues/index.html b/docs/protocolissues/index.html new file mode 100644 index 00000000..c8e8c478 --- /dev/null +++ b/docs/protocolissues/index.html @@ -0,0 +1,20 @@ + + + + + + + + Protocol afhandelen issues / gebruikerswensen + + + + + + +
+
+
+ + + diff --git a/docs/releaseprotocol/h/0-samenvatting.md b/docs/releaseprotocol/h/0-samenvatting.md index 165e044d..cf0d568d 100644 --- a/docs/releaseprotocol/h/0-samenvatting.md +++ b/docs/releaseprotocol/h/0-samenvatting.md @@ -2,10 +2,11 @@ Dit document beschrijft het releaseprotocol van NLCS, de stappen die worden onde Dit protocol is onderdeel van een reeks documenten over het beheer van NLCS: +## Beheer * [Beheerdocument DigiGO](https://www.bimloket.nl//documents/Beheerdocument_open_BIM-standaarden_v1_8.pdf) * [Beheerorganisatie NLCS](https://www.bimloket.nl/p/434/Organisatie-beheer) * [Beheerhandleiding NLCS](https://nl-digigo.github.io/NLCS/managementmanual) -* [Releaseprotocol NLCS](https://nl-digigo.github.io/NLCS/releaseprotocol) -* [Gebruikerswens indienen](https://github.com/nl-digigo/NLCS/issues) +* Releaseprotocol NLCS: voorliggend document +* [Gebruikerswens indienen](https://nl-digigo.github.io/NLCS/protocolissues) * [Protocol afhandelen gebruikerswensen](https://github.com/nl-digigo/NLCS/blob/main/instructies/RASCI%20Github%20issues%20NLCS.pdf). \ No newline at end of file