documenting-code
Maintain project documentation synchronized with code. Keep feature specs, API contracts, and README current with init-project standards. Use when updating docs after code changes, adding new features, or ensuring documentation completeness.
Installation
Pick a client and clone the repository into its skills directory.
Installation
About this skill
Maintain project documentation synchronized with code. Keep feature specs, API contracts, and README current with init-project standards. Use when updating docs after code changes, adding new features, or ensuring documentation completeness.
How to use
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 plikiproduct-requirements.yaml,api-contracts.yaml,system-design.yamlidesign-spec.yaml.Przed wprowadzeniem zmian przejrzyj obecny stan dokumentacji: otwórz
docs/product-requirements.yamlaby zobaczyć listę funkcji i ich status, sprawdź istniejące pliki wdocs/feature-specs/oraz przeskanujdocs/api-contracts.yamlw poszukiwaniu uszkodzonych linków lub nieaktualnych przykładów.Gdy aktualizujesz istniejącą funkcję, zmodyfikuj odpowiadający jej plik
docs/feature-specs/F-##-*.yamlz nowymi wymaganiami, zaktualizuj punkty końcowe API wdocs/api-contracts.yamli zmieńdocs/product-requirements.yamljeśli zmienił się zakres projektu.Dla nowych funkcji utwórz nowy plik
docs/feature-specs/F-##-slug.yamlz unikatowym identyfikatorem F-##, wymaganymi polami front-matter (title,status,last_updated) i powiązaniami do dokumentu wymagań produktu.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-##.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.