Toolverse
All skills

document-sync

by ananddtyagi

A robust skill that analyzes your app's actual codebase, tech stack, configuration, and architecture to ensure ALL documentation is current and accurate. It never assumes—always verifies and compares the live system with every documentation file to detect code-doc drift and

Installation

Pick a client and clone the repository into its skills directory.

Installation

Quick info

Category
Data Science
Views
16

About this skill

A robust skill that analyzes your app's actual codebase, tech stack, configuration, and architecture to ensure ALL documentation is current and accurate. It never assumes—always verifies and compares the live system with every documentation file to detect code-doc drift and generate actionable updates.

How to use

  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.

Related skills