PRODUCT KNOWLEDGE

Dokumentation uden støj.

Start med den del af systemet, du arbejder med. Offentlig dokumentation beskriver produktet; kunde- og driftsmateriale udleveres via kontrolleret adgang.

Teknisk dokumentation og systemarbejde
PRODUCT KNOWLEDGE

Dokumentation

Start med den del af systemet, du arbejder med. Offentlig dokumentation beskriver produktet; kunde- og driftsmateriale udleveres via kontrolleret adgang.

DOCUMENTATION MODEL

Dokumentation skal følge den måde produktet bruges på.

Offentlig dokumentation bør forklare begreber og arbejdsgange. Kundespecifik drift, credentials og følsomme integrationsdetaljer hører hjemme bag kontrolleret adgang.

01

Product

Funktioner og sammenhænge dokumenteres offentligt, hvor det giver mening.

02

Drift

Deployment, maintenance og kundespecifik runbook kan kræve adgang.

03

Release

Klient- og versionsdokumentation knyttes til den konkrete release.

01Start med flow

Dokumentér fra brugerens opgave frem for intern arkitektur.

02Vis grænser

Krav, afhængigheder og kendte begrænsninger skal fremgå.

03Versionér

Ændringer i klienter og integrationer skal kunne spores over tid.

04Adgangsstyr

Følsomt eller kundespecifikt materiale skal ikke ligge offentligt.

Docs-indekset er nu struktureret; artikelbiblioteket kan udvides i takt med at verificeret produktdokumentation færdiggøres.