database-documentation-gen
Automatyczne generowanie dokumentacji schematów baz danych PostgreSQL i MySQL
Instalacja
Wybierz klienta i sklonuj repozytorium do odpowiedniego katalogu skilli.
Instalacja
O skillu
Skill do automatycznego tworzenia dokumentacji baz danych. Analizuje strukturę tabel, kolumn, relacje, indeksy i ograniczenia w PostgreSQL lub MySQL, a następnie generuje czytelną dokumentację w formacie Markdown. Wystarczy podać dostęp do bazy danych i wskazać katalog docelowy — reszta odbywa się automatycznie. Dokumentacja zawiera słownik danych, opisy pól i metadane na poziomie kolumn.
Jak używać
Upewnij się, że masz zainstalowane narzędzia CLI: psql dla PostgreSQL lub mysql dla MySQL, oraz dostęp do bazy danych z uprawnieniami do odczytu tabel systemowych (information_schema, pg_catalog).
Przygotuj bazę danych: jeśli chcesz poprawić jakość dokumentacji, dodaj komentarze do kolumn za pomocą COMMENT ON COLUMN (PostgreSQL) lub UPDATE information_schema (MySQL). Skill wykorzysta te opisy w generowanej dokumentacji.
Wyzwól skill frazą taką jak "generate docs", "document schema" lub "create database documentation" w rozmowie z Claude lub kompatybilnym narzędziem.
Podaj parametry: adres hosta bazy danych, port, nazwę bazy, login i hasło, a także katalog docelowy, gdzie mają być zapisane pliki dokumentacji.
Skill automatycznie wyodrębni listę wszystkich tabel, a następnie dla każdej tabeli pobierze szczegóły kolumn: nazwy, typy danych, długości, nullable, wartości domyślne i komentarze.
Wygenerowana dokumentacja w formacie Markdown będzie zawierać opis relacji między tabelami, słownik danych i metadane — gotowe do udostępnienia zespołowi lub umieszczenia w repozytorium projektu.