Toolverse
All skills

database-documentation-gen

by jeremylongshore

Process use when you need to work with database documentation.\nThis skill provides automated documentation generation with comprehensive guidance and automation.\nTrigger with phrases like \

Installation

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

Installation

Quick info

Category
Backend
Views
9

About this skill

Process use when you need to work with database documentation.\nThis skill provides automated documentation generation with comprehensive guidance and automation.\nTrigger with phrases like \

How to use

  1. 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).

  2. 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.

  3. Wyzwól skill frazą taką jak "generate docs", "document schema" lub "create database documentation" w rozmowie z Claude lub kompatybilnym narzędziem.

  4. Podaj parametry: adres hosta bazy danych, port, nazwę bazy, login i hasło, a także katalog docelowy, gdzie mają być zapisane pliki dokumentacji.

  5. 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.

  6. 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.

Related skills