Community Translations of the Standard for Public Code

Contents

  1. Krav
  2. Test
  3. Offentliga beslutsfattare behöver:
  4. Chefer behöver:
  5. Utvecklare och formgivare behöver:
  6. Vidare läsning

Contribute on GitHub

Dokumentera kodbasens mål

Att tydligt dokumentera kodbasens mål kommunicerar dess syfte. Det hjälper intressenter och bidragsgivare att avgränsa utvecklingen av kodbasen. Målen ger också ett enkelt sätt för människor att avgöra om kodbasen, eller en av dess moduler, är intressant för dem nu eller i framtiden.

Krav

  • Kodbasen MÅSTE dokumentera sina mål, till exempel genom ett uppdrag och en målbeskrivning, på ett sätt som är begripligt för utvecklare och formgivare så att de kan använda eller bidra till kodbasen.
  • Kodbasens dokumentation BÖR tydligt beskriva kopplingarna mellan regelverkets mål och kodbasens mål.
  • Att dokumentera kodbasens mål för allmänheten är VALFRITT.

Test

  • Bekräfta att kodbasens dokumentation innehåller kodbasens mål, uppdrag eller målbeskrivning.
  • Kontrollera om det finns beskrivningar av kopplingarna mellan regelverkets mål och kodbasens mål.

Offentliga beslutsfattare behöver:

  • Lägga till regelverkets mål i kodbasens dokumentation, till exempel i README-filen.
  • Se till att alla era kodbasmål har länkar eller hänvisningar till regelverksdokumentation som lagts till för att uppfylla kriteriet Paketera regelverk och källkod.

Chefer behöver:

  • Lägga till organisatoriska och verksamhetsmässiga mål i kodbasens dokumentation, till exempel i README-filen.

Utvecklare och formgivare behöver:

  • Lägga till mål för teknik och formgivning i kodbasens dokumentation, till exempel i README-filen.

Vidare läsning