Architecture Decision Record

Active theme: Light

← dokumenter

Filnavnkonvensjoner for ADR-er

Hvis du velger å lage ADR-ene dine som vanlige tekstfiler, kan du ønske å finne på en egen filnavnkonvensjon for ADR-er.

Vi foretrekker en filnavnkonvensjon med et bestemt format.

Eksempler:

  • choose-database.md

  • format-timestamps.md

  • manage-passwords.md

  • handle-exceptions.md

Vår filnavnkonvensjon:

  • Navnet er en verbfrase i presens imperativ. Det gjør det lettere å lese og passer til formatet vi bruker i commit-meldinger.

  • Navnet bruker små bokstaver og bindestreker (som dette arkivet). Det er en balanse mellom lesbarhet og bruksvennlighet i systemet.

  • Filtypen er markdown. Det kan være nyttig for enkel formatering.