documenting-code

Skill do utrzymania dokumentacji projektu w zgodzie z kodem. Zarządzaj specyfikacjami funkcji, kontraktami API i plikami README zgodnie ze standardami init-project. Używaj go podczas aktualizacji dokumentacji po zmianach w kodzie, dodawaniu nowych funkcji lub zapewnianiu kompletności dokumentacji. Automatyzuje śledzenie zmian poprzez unikalne identyfikatory (F-##, US-###) i wymusza powiązania między dokumentami.

1. Zainstaluj skill documenting-code w swoim projekcie Claude. Upewnij się, że struktura katalogów zawiera folder docs/ z podfolderami: feature-specs/, user-stories/, user-flows/, oraz pliki product-requirements.yaml, api-contracts.yaml, system-design.yaml i design-spec.yaml.

2. Przed wprowadzeniem zmian przejrzyj obecny stan dokumentacji: otwórz docs/product-requirements.yaml aby zobaczyć listę funkcji i ich status, sprawdź istniejące pliki w docs/feature-specs/ oraz przeskanuj docs/api-contracts.yaml w poszukiwaniu uszkodzonych linków lub nieaktualnych przykładów.

3. Gdy aktualizujesz istniejącą funkcję, zmodyfikuj odpowiadający jej plik docs/feature-specs/F-##-*.yaml z nowymi wymaganiami, zaktualizuj punkty końcowe API w docs/api-contracts.yaml i zmień docs/product-requirements.yaml jeśli zmienił się zakres projektu.

4. Dla nowych funkcji utwórz nowy plik docs/feature-specs/F-##-slug.yaml z unikatowym identyfikatorem F-##, wymaganymi polami front-matter (title, status, last_updated) i powiązaniami do dokumentu wymagań produktu.

5. Dla każdej funkcji utwórz odpowiadające jej historie użytkownika w docs/user-stories/US-###-slug.yaml, upewniając się że każdy US-### jest powiązany z odpowiadającą mu funkcją F-##.

6. Dodaj komentarze JSDoc w kodzie dla złożonej logiki i zweryfikuj że wszystkie dokumenty zawierają wymagane pola front-matter oraz że identyfikatory są unikalne i śledzone konsekwentnie we wszystkich plikach.