order |
---|
8 |
- 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.
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.
- 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.
Der er en introduktion til kodebase formål, mission og mål i kodebase dokumentationen.
- 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.
- Tilføj de organisatoriske og virksomhedsmål til kodebasens dokumentation, f.eks. i
README
.
- Tilføj de teknologiske og designmæssige mål til kodebasens dokumentation, f.eks. i
README
.
- How to write project objectives af Marek Hajduczenia.