CommunityProdutividade e Colaboraçãogithub.com

karrot0195/agent-skills-

Analisar a estrutura de um projeto Go e gerar/atualizar o README.md com visão geral dos pacotes, dependências e notas de uso.

O que é agent-skills-?

Esta skill automatiza a geração e atualização de documentação de projetos Go, especificamente o arquivo README.md. Ao receber um comando para escanear um projeto e atualizar sua documentação, a skill executa uma série de etapas: lista a estrutura do projeto para identificar pacotes, binários, ativos e arquivos de configuração; lê o arquivo `go.mod` para capturar o nome do módulo, a versão do Go e as dependências; e analisa os arquivos-fonte chave de cada pacote para resumir as APIs e o comportamento. Com base nessas informações, a skill atualiza ou cria o README.md, incluindo título, visão geral, estrutura de diretórios, descrições dos pacotes com funções/tipos principais, descrições de binários/CLIs, e dependências e requisitos. Por fim, ela confirma o caminho do arquivo e pergunta se o usuário precisa de mais detalhes, como exemplos e instruções de uso. É útil para desenvolvedores Go que desejam manter a documentação do projeto atualizada com o mínimo esforço manual.

Funciona com~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 Produtividade e Colaboração skills: steipete/gemini, steipete/gh-issues, steipete/skill-creator · View all 6 →

Ver original→Navegar por todas as habilidades

Perguntar na sua IA favorita

Abre um novo chat com esta habilidade de agente já pré-carregada.

ChatGPT Claude Gemini Grok Perplexity DeepSeek

Documentação

gen-docs

Use esta skill quando o usuário solicitar escanear um projeto e atualizar a documentação (por exemplo, README.md).

Etapas

Liste a raiz do projeto e identifique pacotes, binários, ativos e arquivos de configuração.
Leia go.mod para capturar o nome do módulo, a versão do Go e as dependências.
Leia os arquivos-fonte chave em cada pacote para resumir as APIs e o comportamento.
Atualize ou crie README.md com:
- Título do projeto e visão geral em uma linha
- Estrutura de diretórios (árvore ou lista)
- Descrições dos pacotes com funções/tipos principais
- Descrições de binários/CLI
- Dependências e requisitos
Confirme o caminho do arquivo e pergunte se mais detalhes (exemplos, uso) são necessários.

Quando usar

O usuário disser "atualizar readme com visão geral do projeto"
O usuário solicitar "escanear projeto e atualizar documentação"
O usuário quiser uma documentação de nível de projeto gerada a partir do código-fonte

Individual skills in this repo

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