CommunityProductividad y colaboracióngithub.com

gen-docs

Escanea la estructura de un proyecto Go y genera o actualiza el README.md con resúmenes de paquetes, dependencias y notas de uso.

¿Qué es gen-docs?

Esta habilidad permite escanear automáticamente un proyecto Go y generar o actualizar su documentación principal (README.md). Es útil cuando un desarrollador necesita un resumen rápido de la estructura del proyecto, los paquetes, dependencias y uso básico sin tener que escribirlo manualmente. Funciona listando los archivos del proyecto, leyendo go.mod para capturar el nombre del módulo, versión de Go y dependencias, y analizando archivos fuente clave de cada paquete para resumir APIs y comportamiento. Finalmente, actualiza o crea el README.md incluyendo título, resumen, estructura de directorios, descripciones de paquetes con funciones/tipos clave, binarios/CLI y requisitos. Soporta proyectos Go y puede usarse con asistentes de IA como Claude Code, Cursor o Codex.

Compatible con~Claude Code~Codex CLI~Cursor
Part ofAgent Workflows
npx skills add https://github.com/karrot0195/agent-skills-/tree/HEAD/.agents/skills/gen-docs

Installed? Explore more Productividad y colaboración skills: steipete/gemini, steipete/gh-issues, steipete/skill-creator · View all 6 →

Ver original→Ver todas las habilidades

Preguntar en tu IA favorita

Abre un nuevo chat con esta habilidad de agente ya precargada.

OpenAIChatGPTClaudeClaudeGeminiGeminiGrokGrokPerplexityPerplexityDeepSeekDeepSeek

Documentación

¿Qué hace gen-docs?

Usa esta habilidad cuando el usuario pida escanear un proyecto y actualizar la documentación (por ejemplo, README.md).

Pasos

  1. Listar la raíz del proyecto e identificar paquetes, binarios, assets y archivos de configuración.
  2. Leer go.mod para capturar el nombre del módulo, la versión de Go y las dependencias.
  3. Leer los archivos fuente clave en cada paquete para resumir las APIs y el comportamiento.
  4. Actualizar o crear README.md con:
    • Título del proyecto y resumen de una línea
    • Estructura de directorios (árbol o lista)
    • Descripciones de paquetes con funciones/tipos clave
    • Descripciones de binarios/CLI
    • Dependencias y requisitos
  5. Confirmar la ruta del archivo y preguntar si se necesita más detalle (ejemplos, uso).

Cuándo usarlo

  • El usuario dice "actualiza el readme con un resumen del proyecto"
  • El usuario pide "escanear el proyecto y actualizar la documentación"
  • El usuario quiere generar documentación a nivel de proyecto a partir del código fuente

Individual skills in this repo

This repo contains 1 individual skill — each has its own dedicated page.

karrot0195/agent-skills-

Commit workflow that runs doc-gen first, stages only needed files (asking for confirmation on uncertain ones), suggests a message from the actual diff, commits, shows a summary, and asks about pushing.

Skills relacionados

steipete/gemini

Gemini CLI one-shot prompts, summaries, generation, skills, hooks, MCP, or Gemma routing.

community

steipete/gh-issues

Fetch GitHub issues, select candidates, spawn background fix agents, open PRs, and optionally process PR review comments.

community

steipete/skill-creator

Create, edit, audit, tidy, validate, or restructure AgentSkills and SKILL.md files.

community

steipete/clawhub

Search, install, update, sync, or publish agent skills with the ClawHub CLI and registry.

community

steipete/coding-agent

Delegate coding work to Codex, Claude Code, or OpenCode as background workers; not simple edits or read-only code lookup.

community

steipete/mcporter

List, configure, authenticate, call, and inspect MCP servers/tools with mcporter over HTTP or stdio.

community
← More Productividad y colaboración skills