Skip to content
docs

Doc From Code

Generate API or library documentation from source comments, types and exported symbols.

/doc-from-code

Install this skill

  1. 1. Copy the SKILL.md content (button above)
  2. 2. Create a folder for the skill:
    # Mac/Linux
    mkdir -p ~/.claude/skills/doc-from-code
    
    # Windows (PowerShell)
    mkdir $env:USERPROFILE\.claude\skills\doc-from-code
  3. 3. Save the content as ~/.claude/skills/doc-from-code/SKILL.md
  4. 4. Restart Claude Code (or open a new session)
  5. 5. Type /doc-from-code to invoke it
documentationapimarkdown

/doc-from-code

Convierte código en docs sin perder horas.

Usage

/doc-from-code <file-or-folder> /doc-from-code src/lib --output docs/api.md /doc-from-code --format=mdx # para Docusaurus/Nextra

Qué extrae

Para cada export

  • Signature con tipos
  • Description del docstring/JSDoc
  • Parameters con descripciones
  • Returns con tipo y significado
  • Throws / Errors posibles
  • Example (genera uno realista si no existe)

Para módulos

  • Overview (1 párrafo)
  • Lista de exports con links
  • Ejemplo end-to-end de uso típico

Formatos

  • Markdown (default)
  • MDX (con código embebido)
  • HTML (vía pandoc)
  • JSON (para procesar después)

Convenciones detectadas

  • JSDoc / TSDoc (TypeScript/JavaScript)
  • Docstrings (Python — Google, NumPy, Sphinx)
  • Doc comments (Rust, Go, Swift)
  • KDoc (Kotlin)

Heurísticas

  • Si una función no tiene comments, infiere descripción del nombre + tipos
  • Marca con ⚠️ las que necesitan revisión manual
  • Genera un coverage.json con qué exports tienen docs y cuáles no