aitormf/agent-skills

Cria ou atualiza os arquivos de contexto de um projeto (AGENTS.md, docs/ARCHITECTURE.md com seus princípios inegociáveis, CONTRIBUTING.md, ADRs, SECURITY.md e template de PR) através de uma entrevista guiada. Use ao iniciar um projeto, ao adotar agentes em um projeto existente, ou quando for solicitada uma 'constituição', princípios do projeto, regras de arquitetura ou documentação para agentes.

O que é agent-skills?

Esta skill guia você na criação ou atualização dos arquivos de contexto essenciais para que agentes de IA (como Claude Code, Cursor, Codex) e colaboradores humanos trabalhem de forma alinhada e produtiva. Ela substitui a antiga abordagem de um único `constitution.md`, distribuindo cada tipo de regra para o arquivo mais adequado: `docs/ARCHITECTURE.md` para princípios inegociáveis e decisões estruturais, `CONTRIBUTING.md` para processos de qualidade e contribuição, ADRs para documentar o 'porquê' de cada decisão, `AGENTS.md` (lido pelos agentes em toda sessão) para comandos e convenções críticas, `SECURITY.md` para políticas de segurança, e um template de PR. O processo é interativo: a skill primeiro lê o repositório (manifestos, configs, estrutura), identifica se o projeto é greenfield (prescritivo) ou brownfield (descritivo), e então conduz uma entrevista por rodadas (propósito, stack, princípios, qualidade, segurança, processo, dependências e configuração do agente). Para cada pergunta, oferece opções concretas (A, B, 'deixar em aberto'), e só escreve os arquivos após sua aprovação. O resultado é um conjunto de documentos coesos, sem duplicação, com regras verificáveis por ferramentas, e que mantêm o `AGENTS.md` enxuto (menos de 150 linhas) — funcionando como um mapa que referencia os demais arquivos. Ideal para times que desejam estabelecer uma 'constituição' prática e sustentável para o desenvolvimento assistido por IA.

Funciona com✓Claude Code~Codex CLI~Cursor
npx skills add https://github.com/aitormf/agent-skills/tree/HEAD/skills/generate-project-context

Installed? Explore more Produtividade e Colaboração skills: steipete/gemini, steipete/gh-issues, steipete/skill-creator · View all 6 →

Perguntar na sua IA favorita

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

Documentação

Contexto do projeto

Ajude a pessoa a decidir e escrever as regras estáveis do projeto, cada uma no arquivo onde pertence. A pessoa toma as decisões: você lê, propõe opções concretas e rascunha.

Substitui o constitution.md do Spec Kit. Todo o seu conteúdo tem um lar melhor:

ConteúdoArquivoLido por
Stack, camadas, regras de dependência, princípios inegociáveis, glossáriodocs/ARCHITECTURE.mdPessoas e agentes; spec-to-plan e review-spec verificam os princípios
Qualidade, branches, commits, PRs, revisão, uso de IACONTRIBUTING.mdPessoas (e agentes, via link)
O porquê de cada decisão estrutural e as alternativas descartadasdocs/adr/NNNN-*.mdAmbos, sob demanda
Comandos, limites, convenções não óbvias, mapa da documentaçãoAGENTS.md (+ CLAUDE.md com @AGENTS.md)Agentes, em toda sessão
Como reportar vulnerabilidades, política do agenteSECURITY.mdPessoas

Templates em assets/en/ (Inglês) e assets/es/ (Espanhol). Use o idioma em que o projeto está documentado; pergunte se não estiver claro. Cada template explica em seu comentário de abertura como preenchê-lo.

Regras

  • Não duplicar. Se algo já está em pyproject.toml, no CI ou em um linter, faça um link; não copie. Se um princípio aparecer em dois arquivos, eles acabarão se contradizendo: princípios vivem apenas em ARCHITECTURE.md.
  • AGENTS.md curto: menos de 150 linhas. É um mapa que referencia; não contém. Para cada linha: "se eu remover, o agente erraria?". Se não, fora.
  • O que pode ser verificado com uma ferramenta, é verificado com uma ferramenta. Para cada princípio, pergunte como é verificado (lint, import-linter, teste, CI, revisão) e anote em sua coluna.
  • Nada volátil: nenhum status de sprint ou TODOs. Estes vão no gerenciador de tarefas ou em docs/plans/.
  • Mostre cada arquivo na íntegra (ou o diff, se já existir) e escreva somente após a pessoa aprová-lo.

Processo

1. Leia o projeto

Antes de perguntar qualquer coisa, leia: manifestos (pyproject.toml, package.json, go.mod…), README.md, quaisquer arquivos de contexto existentes, .github/workflows/, configuração de linter e a estrutura de pastas. Use o que encontrar para propor respostas em vez de fazer perguntas abertas.

Decida o modo e informe a pessoa:

  • Greenfield (sem código ou quase nenhum): ARCHITECTURE.md é prescritivo, como será.
  • Brownfield: ARCHITECTURE.md é descritivo, como é hoje. O ideal vai para os ADRs e as 'catracas' das ferramentas. Se os arquivos de contexto já existirem, pergunte apenas sobre as lacunas e proponha diffs.
  • Migração de um constitution.md: distribua seu conteúdo de acordo com a tabela acima e proponha deletá-lo ou reduzi-lo a um link.

2. Entrevista por rodadas

Uma categoria de cada vez. Para cada pergunta, ofereça opções concretas (A, B, "deixar em aberto", "outro"). Se os arquivos já responderem a pergunta, peça confirmação em vez de perguntar. Se uma categoria não se aplicar (ex.: não há banco de dados), pule-a e avise. Ao final de cada rodada, resuma o que foi decidido.

RodadaO que é decididoDestino
1. PropósitoO que o projeto é e o que está fora; tipo (app, serviço, biblioteca, CLI)ARCHITECTURE.md §1, README.md
2. Stack e arquiteturaLinguagem, framework, persistência, infraestrutura; camadas ou módulos e o que pode importar o quêARCHITECTURE.md §2–4, um ADR por decisão estrutural
3. Princípios inegociáveis5–10 regras estáveis e verificáveis: por que e como cada uma é verificadaARCHITECTURE.md §5
4. QualidadeTeste primeiro ou depois, cobertura mínima, tipagem, o que nunca é mockadoCONTRIBUTING.md §5; se inegociável, também um princípio
5. SegurançaAutenticação, dados sensíveis, validação de entrada, conformidade regulatóriaARCHITECTURE.md §10, SECURITY.md
6. ProcessoBranches, Conventional Commits, merge ou squash, aprovações, tamanho do PR, ferramentas de IA permitidasCONTRIBUTING.md §4, §6–7
7. DependênciasPolítica para adicioná-las, bibliotecas proibidas, construir ou comprarPrincípio (se inegociável) ou CONTRIBUTING.md
8. Para o agenteComandos (o de verificação é obrigatório), convenções não óbvias, áreas críticas ou frágeis (brownfield), limites (sempre / perguntar / nunca)AGENTS.md

Na rodada 8, o comando de verificação é o contrato com as outras skills (plan-to-tasks, implement, revisão). Se ele não existir, proponha setup-guardrails-python (ou um equivalente para a linguagem) ou deixe como uma pergunta em aberto em AGENTS.md. Se o projeto for usar review-prepush ou review-pr, ofereça também a seção opcional ## Code review (template em review-context/assets/AGENTS-code-review.md): branch base, caminhos de alto risco, idioma do relatório…

3. Rascunhe e escreva

Ordem: ARCHITECTURE.md → ADRs → CONTRIBUTING.md → SECURITY.md → AGENTS.md. AGENTS.md vai por último porque referencia todos os anteriores.

  • Comece pelo template em assets/. Exclua as seções que ainda não se aplicam; não as deixe vazias.
  • ADRs: copie ADR.md como docs/adr/0000-template.md (0000-plantilla.md em espanhol) e adr-README.md como docs/adr/README.md. Crie um ADR por decisão estrutural das rodadas 2–3. Brownfield: apenas 3–5 retroativos, para o que é mais questionado, com as alternativas descartadas.
  • AGENTS.md deve incluir:
    • a linha "Planning": verifique o plano contra os princípios em docs/ARCHITECTURE.md antes de implementar;
    • um link para CONTRIBUTING.md para o processo.
  • CLAUDE.md contém apenas @AGENTS.md, a menos que já tenha conteúdo. Nesse caso, proponha movê-lo para AGENTS.md.
  • pull_request_template.md vai em .github/. Ofereça, não imponha.

4. Conclusão

Liste os arquivos criados ou alterados e as perguntas que ficaram em aberto. Lembre a pessoa:

  • AGENTS.md é revisado mensalmente e podado, especialmente ao mudar de modelos.
  • ARCHITECTURE.md é verificado contra o código a cada trimestre.
  • Todo erro que o agente repete se torna uma regra de ferramenta ou, como último recurso, uma linha em "Armadilhas conhecidas".

Individual skills in this repo

This repo contains 3 individual skills — each has its own dedicated page.

Habilidades Relacionadas