Toolverse
Wszystkie skille

update-doc

autor: TokenRollAI

Automatycznie synchronizuj dokumentację z zmianami w kodzie

Instalacja

Wybierz klienta i sklonuj repozytorium do odpowiedniego katalogu skilli.

Instalacja

Szybkie info

Kategoria
Backend
Wyświetlenia
1

O skillu

Skill do aktualizacji dokumentacji llmdoc w odpowiedzi na zmiany w kodzie projektu. Analizuje ostatnie commity, identyfikuje zmienione pliki, mapuje je na odpowiednie dokumenty i aktualizuje je automatycznie. Utrzymuje spójność dokumentacji z rzeczywistym stanem kodu, minimalizując ręczną pracę nad synchronizacją. Idealny dla zespołów, które chcą mieć zawsze aktualną dokumentację bez dodatkowego wysiłku.

Jak używać

  1. Zainstaluj skill update-doc w swoim projekcie, upewniając się, że masz dostęp do narzędzi Read, Glob, Grep, Write, Edit, Bash i Task.

  2. Wyzwól skill, gdy chcesz zaktualizować dokumentację — możesz to zrobić, pisząc "update docs", "sync documentation" lub "refresh docs". Skill automatycznie przeanalizuje ostatnie 3 commity i zidentyfikuje zmienione pliki.

  3. Opcjonalnie przekaż argument opisujący zmiany — jeśli go nie podasz, skill sam przeanalizuje git diff, aby zrozumieć, co się zmieniło.

  4. Skill mapuje zmienione pliki na odpowiednie dokumenty w strukturze llmdoc. Na przykład zmiany w plikach konfiguracyjnych trafiają do reference/coding-conventions.md, a zmiany w autoryzacji do dokumentów architekturowych.

  5. Dla każdego zmienionego dokumentu skill automatycznie aktualizuje zawartość, stosując zasadę minimalności — używa jak najmniej słów potrzebnych do opisania zmian.

  6. Po zaktualizowaniu wszystkich dokumentów skill synchronizuje index.md, skanując katalog llmdoc i zapewniając spójność całej dokumentacji. Na koniec otrzymasz raport ze wszystkimi utworzonymi, zmienionymi lub usuniętymi dokumentami.

Podobne skille