Skip to content

Latest commit

 

History

History
46 lines (28 loc) · 1.78 KB

document-objectives.md

File metadata and controls

46 lines (28 loc) · 1.78 KB
order
8

Dokumenter dine mål

Krav

  • Kodebasen SKAL indeholder dokumentation af sit mål – så som en mission og mål – som er forståelige for designere og udviklere, så de kan bruge eller bidrage til kodebasen.
  • Kodebasen BØR indeholde dokumentation af dens mål, som er forståelig for politiske beslutningstagere og ledelse.
  • Kodebasen MÅ indeholde dokumentation af dens mål, som er forståelig af den generelle offentlighed.

Hvorfor er dette vigtigt

At dokumentere dine mål:

  • Giver en lettilgængelig måde for, at andre kan beslutte, hvorvidt denne kodebase er interessant for dem nu eller i fremtiden.
  • Hjælper med at følge din egen udvikling.
  • Kommunikerer tydeligt til andre interessenter og bidragsydere, hvad kodebasen er til.

Hvad dette ikke gør

  • Garanterer at kodebasen opnår det/de opsatte mål.
  • Garanterer bidrag til din kodebase.
  • Forhindrer andre kodebaser fra at forsøge og opnå de samme mål.

Hvordan tester man

Der er en introduktion til kodebase formål, mission og mål i kodebase dokumentationen.

Politiske beslutningstagere: hvad skal du gøre

  • Tilføj et politisk mål til kodebasens dokumentation, f.eks. i README.
  • Inkluder relevante politikker, som påvirker fællesskabet, kodebasen og udviklingen, som værdier og etisk baserede politikker, f.eks. tilgængelighed eller lige muligheder.

Ledelse: hvad skal du gøre

  • Tilføj de organisatoriske og virksomhedsmål til kodebasens dokumentation, f.eks. i README.

Udviklere og designere: hvad skal du gøre

  • Tilføj de teknologiske og designmæssige mål til kodebasens dokumentation, f.eks. i README.

Yderligere læsning