Documentatie afspraken

< Documentatie
 * Beweging: Beheerders

Nog vewerken
Als projectteam hebben we een gezamenlijke verantwoordelijkheid m.b.t. de documentatie. Epic owners zijn in principe verantwoordelijk voor het opleveren van de documentatie. Alle relevante documentatie wordt in Jira gedeeld. We vinden het ook relevant waarom bepaalde beslissingen zijn genomen. We zullen documenatie laten reviewen door de beheerafdeling. Het plan is om hier na 15 december mee te gaan starten.

Introductie

 * Het is een good practice om met elkaar afspraken op papier te zetten over documentatie.
 * Zorg dat documentatie onderdeel wordt van het reguliere proces. Dus maak documentatie onderdeel van de definition of done.

Good practices

 * Planning: In een project is het een good practice om NIET tot het einde te wachten met het maken van documentatie. Het is verstandiger om tijdens de ontwikkeling ook alvast te starten met de documentatie. En documentatie onderdeel te maken van de definition-of-done.
 * Soorten documentatie: Het is verstandig om iemand met een technische achtergrond verantwoordelijk te maken voor de technische documentatie. Iemand met een functionele achtergrond verantwoordelijk te maken voor de functionele documentatie. Soms kan het ook handig zijn om een apart team verantwoordelijk te maken voor de proces documentatie.
 * Reviewen: Het is een good practice om documentatie in ieder geval door een collega te laten reviewen. Soms wil beheer de documentatie ook nog reviewen voordat e.e.a. wordt opgeleverd.
 * Hoe aanleveren?: In veel organisaties wordt documentatie opgeleverd in een netwerkfolder. Sommige organisaties maken ook gebruik van een document management systeem of een content management systeem.
 * Bouwen op basis van gevalideerde FO en TO: In een Agile setting kun je besluiten om op basis van een userstory of een mail functionaliteit te gaan bouwen. Maar met het oog op toekomstige documentatie heeft het de voorkeur om pas te gaan bouwen als je een gevalideerde FO en TO hebt.

Overzicht afspraken

 * Epic verantwoordelijke: Degene op wiens naam de userstory en/of epic staat is verantwoordelijk voor de documentatie.
 * Functionele en technische documenatie: Een epic is pas afgerond als de technische en functionele documentatie is opgeleverd. Dus niet meer verwijzen naar informatie in bijvoorbeeld Jira.