Toolverse
All skills

doc-gen

by phodal

Generate comprehensive documentation from code

Installation

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

Installation

Quick info

Author
phodal
Category
Backend
Views
26

About this skill

Generate comprehensive documentation from code

How to use

  1. Zainstaluj skill doc-gen w swoim środowisku Claude/Copilot, wskazując repozytorium phodal/auto-dev.

  2. Przygotuj kod, dla którego chcesz wygenerować dokumentację — skill będzie analizować jego strukturę, metody i funkcjonalność.

  3. Uruchom skill, przekazując ścieżkę do projektu lub kodu jako argument. Skill automatycznie wczyta nazwę projektu i kontekst.

  4. Skill wygeneruje dokumentację w czterech sekcjach: Overview (cel, przypadki użycia, kluczowe cechy), API Documentation (metody, parametry, zwracane wartości, przykłady), Code Examples (podstawowe użycie, popularne wzorce, zaawansowane scenariusze) oraz Configuration (ustawienia, wartości domyślne, zmienne środowiskowe).

  5. Przejrzyj wygenerowaną dokumentację — jest napisana prostym, zrozumiałym językiem z działającymi przykładami kodu, gotowa do publikacji lub dalszych edycji.

  6. Opcjonalnie dostosuj strukturę lub dodaj szczegóły specyficzne dla Twojego projektu — skill stanowi solidną bazę, którą możesz rozbudować.

Related skills