Przejdź do treści

STD-PROC-005 · Norma dyscypliny

1. Cel

Zdefiniować minimalny, weryfikowalny kształt każdego dokumentu normatywnego (STD) w repozytorium dyscypliny — tak by normy były spójne dla czytelnika i gotowe do automatycznej weryfikacji.

2. Zakres

Dotyczy każdego folderu standardu (standards/**/STD-*/) w repozytorium dyscypliny. Nie dotyczy standards/template/ (wzorzec, nie norma).

3. Wymagania (normatywne)

  • R1. Folder standardu MUSI zawierać plik README.md z dokumentem normatywnym.
  • R2. Plik README.md MUSI zawierać blok frontmatter YAML (między ---) z polami: id, title, domain, status, conformance, since, owner.
  • R3. Pole id MUSI pasować do wzorca STD-[A-Z]+-[0-9]{3} i MUSI być unikalne w repozytorium.
  • R4. Pole domain MUSI mieć jedną z wartości: proces, bezpieczenstwo, infrastruktura, jakosc.
  • R5. Pole status MUSI mieć jedną z wartości: active, deprecated, retired.
  • R6. Pole conformance MUSI mieć jedną z wartości: mandatory, recommended, optional.
  • R7. README.md MUSI zawierać wszystkie sześć sekcji w kolejności: ## 1. Cel, ## 2. Zakres, ## 3. Wymagania, ## 4. Minimum of Done, ## 5. Implementacja, ## 6. Referencje.
  • R8. Folder standardu MUSI zawierać wykonywalny plik bin/checks.sh weryfikujący kryteria normy.

4. Minimum of Done

  • Czy README.md zawiera poprawny frontmatter z wymaganymi polami?
  • Czy README.md zawiera wszystkie 6 sekcji w poprawnej kolejności?
  • Czy folder standardu zawiera wykonywalny bin/checks.sh?
  • Czy id normy jest unikalne w repozytorium?

Weryfikacja: bash standards/proces/STD-PROC-005/bin/checks.sh

5. Implementacja — dobra praktyka (informacyjne, niewiążące)

Nowe normy tworzy się z szablonu standards/template/. Walidacja lokalna przed MR:

# sprawdź wszystkie normy
bash standards/proces/STD-PROC-005/bin/checks.sh

# sprawdź konkretną normę
bash standards/proces/STD-PROC-005/bin/checks.sh --file standards/proces/STD-PROC-002/README.md

Sekcja ## 3. Wymagania powinna być sucha i niezależna od narzędzi. Sekcja ## 5. Implementacja zawiera wszystkie opinie o narzędziach i konfiguracji.

6. Referencje

standards/template/ · STD-PROC-002 Strategia gałęzienia · schema/ (JSON Schema norm, planowane).