Genereren van documentatie voor een eenvoudige userstory.
Voorbeeld van een eenvoudige userstory
Deze userstory is in het model aangemaakt,
De userstory wordt in de documentatie getoond volgens de 3C structuur.
C = Card: Korte omschrijving van userstory volgens het bekende template.
C = Conversation: De reden om de userstory te benoemen.
C = Confirmation: De acceptatie criteria om het resultaat de accepteren.
In de userstory kunnen attributen en operaties worden opgenomen. Zulke definities worden gebruikt om de omvang van een userstory groter te maken.
In de gegenereerde documentatie wordt dit getoond als uit te voeren taken.
Elementen met een relatie worden als links in de documentatie getoond.
Model voor deze userstory
In het model heeft deze userstory relaties met:
De feature "Website casus samenstellen". Deze relatie heeft de naam "context". Hiermee is bedoeld dat de userstory in de omgeving voor deze feature zit.
De conditie "Model voor de casus is beschikbaar". Deze relatie heeft de naam "post-condition". Hiermee wordt bedoeld dat wanneer de userstory is gerealiseerd aan deze conditie wordt voldaan.
De relatie met de "persona" is afgeleid uit de relatie tussen de feature en de persona. In de generator is ingeregeld dat de relatie tussen de persona en de feature met de naam "starts" wordt gebruikt als de persona voor de userstory.
Operaties in de userstory
De operaties van de userstory komen terug in de beschrijving.
De operaties zijn benoemd als eigenschappen van de userstory.
Deze worden meegenomen voor het bepalen van de storypoints
Configuratie documentatie userstory
Voor elk type element kan in een configuratie bestand worden vastgelegd wat moet moet worden getoond en hoe elementen met een relatie worden genoemd.
De configuratie staat in een XML bestand.
Het voorbeeld hiernaast laat zien dat achter de kop "Conversation" elementen worden getoond die een relatie hebben met de naam "conversation" of "context"..
Achter de kop "Confirmation" komen elementen die een relatie hebben met de naam "post-condition".
In de configuratie kun je aangeven of je een uitgebreide of korte beschrijving wilt laten zien in de documentatie door de waarde achter het attribuut "description" in te vullen.. Het is mogelijk om de omschrijving helemaal weg te laten.
documentatie userstory eenvoudig
documentatie userstory eenvoudig
Maak het model
Plaats de relevante elementen met de relaties in het model
Exporteer het model als XMI
Exporteer het package om documentatie te genereren naar XMI.
Genereer documentatie
Start de model export enhancer om documentatie te genereren.
We brengen ruim 30 jaar ervaring in voor
informatieanalyse en software architectuur.