Community Translations of the Standard for Public Code

Contents

  1. Krav
  2. Hur du testar
  3. Offentliga beslutsfattare: vad ni behöver göra
  4. Chefer: vad ni behöver göra
  5. Utvecklare och formgivare: vad ni behöver göra
  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 innehålla dokumentation av sina mål, såsom ett uppdrag och en målbeskrivning, som är begriplig 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.

Hur du testar

  • 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: vad ni behöver göra

  • Lägg 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 underbyggande regelverksdokument som lagts till för att uppfylla kriteriet Paketera regelverk och källkod.

Chefer: vad ni behöver göra

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

Utvecklare och formgivare: vad ni behöver göra

  • Lägg till tekniska mål och designmål i kodbasens dokumentation, till exempel i README-filen.

Vidare läsning