design-doc-mermaid

name	design-doc-mermaid
description	Bruk når Copilot skal lage Mermaid-diagrammer for dokumentasjon, flytbeskrivelser, sekvensdiagrammer eller designnotater basert på tekst, user stories, testcases eller kildegrunnlag.

Design doc Mermaid

Lag Mermaid-diagrammer som er enkle å lese, enkle å lime inn i Markdown og nyttige som dokumentasjon.

Denne repo-lokale skillen er inspirert av spillwavesolutions/design-doc-mermaid på skills.sh. Den er forenklet for Workshop 2.

Arbeidsmåte

1. Les grunnlaget før du tegner.
2. Velg diagramtype:
   • flowchart TD for brukerflyt eller testflyt.
   • sequenceDiagram for samspill mellom kunde, app og system.
   • stateDiagram-v2 for statuser som aktivt, sperret eller feilet.
3. Hold diagrammet kort.
4. Bruk norske, forståelige node-tekster.
5. Marker antakelser utenfor diagrammet, ikke som skjulte fakta.
6. Avslutt med en kort forklaring av hva diagrammet viser.

Regler

• Ikke legg inn ekte persondata.
• Ikke finn på systemer eller integrasjoner som ikke står i grunnlaget.
• Ikke gjør diagrammet mer teknisk enn målgruppen trenger.
• Ikke bruk Mermaid-syntaks du ikke er trygg på.
• Hvis diagrammet blir stort, lag heller to små diagrammer.

Kvalitetssjekk

Sjekk at:

• diagrammet har start og slutt
• viktigste beslutningspunkt er synlig
• feilhåndtering er med hvis grunnlaget beskriver det
• tekstene er korte
• risikoer og antakelser er forklart ved siden av diagrammet

Valgfri rendering med Mermaid CLI

Hvis Mermaid CLI er tilgjengelig, kan diagrammer renderes med mmdc.

Hvis diagrammet ligger i en Markdown-fil, be brukeren kopiere selve Mermaid-koden til en egen .mmd-fil før rendering.

Eksempel:

mmdc -i 05-output/mermaid-diagram.mmd -o 05-output/mermaid-diagram.svg

Mermaid CLI er et valgfritt hjelpemiddel i workshopen. Diagrammet skal også kunne leses som tekst.