kadaster-labs / sensrnet-home

Home of the SensRNet - The Dutch National Sensor Registry Network
Other
15 stars 7 forks source link

Schrijven beheerdershandleiding #263

Closed CelineJansen closed 2 years ago

CelineJansen commented 2 years ago

Hoe beheer je apparaten, sensoren, en datastromen in het sensorenregister (SensRNet)? Gemeente Eindhoven wil een handleiding opleveren om beheerders van sensoren te ondersteunen bij het opvoeren, updaten en verwijderen van gegevens in SensRNet. Let op, dit betreft dus niet per definitie alle functionaliteiten van de tool en de API, puur degene relevant voor het beheer van de vakinhoudelijke gegevens.

Voorzetje (let op: nog niet af, zwaar conceptueel en puur voor het idee): HandleidingSensRNet_NIETAF.pdf

marcvanandel commented 2 years ago

Super input, @CelineJansen !!! @kad-bloemy is hier ook al mee bezig in #250.

@kad-bloemy , neem je de input van Celine mee in jouw PR?

kad-bloemy commented 2 years ago

Goede aanzet! Zie ook Gebruikerdoc Ik hoop dat je erbij kunt. Open de file DocumentationNL

marcvanandel commented 2 years ago

Wat is de beheerdershandleiding anders dan #160 (gebruikershandleiding)?

CelineJansen commented 2 years ago

De beheerdershandleiding heeft als scope te ondersteunen bij wat de beheerders nodig hebben om hun sensoren actueel te houden in SensRNet. Er zal behoorlijk wat overlap zijn met andersoortig gebruik, maar de focus kan anders zijn. Een gebruiker die puur wil weten waar allerlei sensoren zich op dit moment bevinden heeft andere dingen nodig dan een beheerder die de velden daadwerkelijk bij wil werken. De beheerdershandleiding is dus eigenlijk een gebruikershandleiding met als scope het specifieke type gebruik "beheren van sensoren".

marcvanandel commented 2 years ago

Aha. Beheerdershandleiding is de Registry Node gebruikershandleiding, right? Ik denk dat wij met #160 hetzelfde bedoelden ... 😄 Dat maakt niet uit, maar dan weten we dat we aan hetzelfde werken ... en wellicht goed om dat dus duidelijker te maken! 👍

CelineJansen commented 2 years ago

Nieuwe versie van de beheerdershandleiding, nog steeds niet volledig (ik wil nog een stuk toevoegen over het wijzigen van gegevens met de API). Methodiek en scripts voor bulk opvoer en bulk verwijderingen wordt nu wel beschreven (vanaf pagina 14). Scripts + templates staan in https://github.com/kadaster-labs/sensrnet-home/issues/176.

Feedback is welkom.

HandleidingSensRNet_NIETAFv2.pdf

marcvanandel commented 2 years ago

Eerste versie is 'merged' in de documentatie ... maar er komen nog updates 😉

CelineJansen commented 2 years ago

Zie ook https://kadaster-labs.github.io/sensrnet-home/UserManualNL/ voor de documentatie.

marcvanandel commented 2 years ago

De handleiding is opgeleverd (en van hoge kwaliteit !!) Het laatste stukje dat nog moet gebeuren is de handleiding die @kad-bloemy aan het maken was ín deze handleiding toe te voegen. Met name de waardelijsten zijn van toegevoegde waarde

CelineJansen commented 2 years ago

De eerste complete versie van de beheerdershandleiding inclusief scripts en waardelijsten is terug te vinden onder: https://kadaster-labs.github.io/sensrnet-home/UserManualNL/.