Toolverse
Wszystkie skille

document-sync

autor: ananddtyagi

Automatycznie wykryj rozbieżności między kodem a dokumentacją i utrzymuj je w synchronizacji

Instalacja

Wybierz klienta i sklonuj repozytorium do odpowiedniego katalogu skilli.

Instalacja

Szybkie info

Kategoria
Data Science
Wyświetlenia
16

O skillu

Umiejętność, która analizuje rzeczywisty kod, stos technologiczny, konfigurację i architekturę Twojej aplikacji, aby dokumentacja była zawsze aktualna i dokładna. Nigdy nie zakłada — zawsze weryfikuje, porównując system z każdym plikiem dokumentacji, aby wykryć przesunięcia kod-dokumentacja i zaproponować konkretne aktualizacje.

Jak używać

  1. Uruchom pełne skanowanie systemu, wykonując skrypt analizy: python3 .claude/skills/document-sync/scripts/system_scan.py. Skrypt automatycznie przeanalizuje języki, frameworki, API, bazy danych, zmienne konfiguracyjne i wzorce kodu w Twoim projekcie.

  2. Użyj polecenia /docs-sync, aby uruchomić analizę i otrzymać raport zawierający wszystkie nieaktualne lub niedokładne sekcje dokumentacji. Raport wskaże, które fragmenty dokumentacji nie zgadzają się z rzeczywistym kodem.

  3. Dla bezpiecznych zmian opartych wyłącznie na znalezionych dowodach w kodzie użyj /docs-update-strict. Umiejętność zaproponuje tylko te aktualizacje, które są potwierdzone faktycznym kodem lub plikami konfiguracyjnymi.

  4. Jeśli chcesz uzupełnić brakującą dokumentację dla funkcji, które istnieją w kodzie ale nie są opisane, użyj /docs-rewrite-missing. Umiejętność automatycznie wygeneruje opisy na podstawie analizy źródła.

  5. Aby bezpiecznie wdrożyć wszystkie zmiany dokumentacji, użyj /docs-patch-pr, która utworzy pull request ze wszystkimi proponowanymi aktualizacjami, umożliwiając Ci przegląd przed zatwierdzeniem.

Podobne skille