convez.ai
SkillAutomaçãoIntermediário
jonameron

Docs-Driven Agents

jonameron/docs-driven-agents

Documentação como fonte de verdade para agentes de código confiáveis

Ver no GitHub
InicialPluginScore · de 0 a 100

Metodologia documentação-first para construir software com agentes de código, usando Claude Code. Fornece um playbook completo, template CLAUDE.md e skills reutilizáveis que tratam a documentação como fonte de verdade, codificam procedimentos e criam um loop de aprendizado contínuo que melhora a confiabilidade a cada uso.

Instalação

$npx convez-ai jonameron/docs-driven-agents

1 comando no terminal: detecta o formato do repositório (marketplace ou plugin avulso) e instala via Claude Code. Requer Node 18+ e o Claude Code instalado.

Métricas

Estrelas
0
Forks
0
Acompanhando
0
Saúde
42%
Último commit
há 5 meses
Versão
—
Issues abertas
0
Contribuidores
1

Casos de uso

  • Estruturar projetos para trabalhar com Claude Code de forma consistente
  • Criar skills reutilizáveis a partir de procedimentos e lições aprendidas
  • Manter documentação e código sincronizados automaticamente
  • Implementar deploys autônomos com verificação contínua

Veredito

Uma abordagem sólida e pragmática para estruturar trabalho com agentes de código, especialmente útil em ambientes de produção onde confiabilidade e conhecimento acumulado importam. O foco em convenções adaptáveis e na documentação como verdade única reduz drift e acelera aprendizado do agente.

README

A tradução para o português deste README ainda está na fila.

docs-driven-agents

A documentation-first way of building software with coding agents, distilled from running it on real production systems. The idea is simple: treat the docs as the source of truth, codify procedures as reusable skills, and wire the whole thing into a loop that gets more reliable the more you use it.

It is written for Claude Code, but the structure carries over to any agent setup that supports a project manifest and a skills directory.

The three pillars

            CLAUDE.md  (read first every session)
            ·  three pre-action checks
            ·  routes work to the right skill / doc
            ·  "if this file is wrong, fix it"
                 |                       |
        .claude/skills/             docs/  (MkDocs)
        codified, learned-          the primary
        from-mistakes procedures    knowledge source
                 |                       |
            Autonomous deployment + verification loop
            feature → develop → main → deploy → verify

The point of connecting them is that knowledge compounds. A bug you fix once becomes a skill check. A behaviour you change ships its doc update in the same commit, so the docs never drift. The project manifest is editable by every session, so it sharpens over time.

What's here

FileWhat it is
playbook.mdThe full manual — foundation, docs-driven development, autonomous deployment, and the loop harnesses, with a bootstrap checklist at the end
templates/CLAUDE.mdThe copy-verbatim project-manifest skeleton (the three checks + the skills table)
skills/The docs-driven-development skill and the registry format it follows

Getting started

  1. Copy templates/CLAUDE.md into a new project and fill in the project-specific sections.
  2. Create .claude/skills/ with the registry from skills/README.md; add skills lazily, one per recurring procedure or post-mortem.
  3. Stand up MkDocs and adopt the docs-in-every-commit rule.
  4. Layer on the deployment and loop pieces from the playbook when you need them.

Everything is conventions, not rules — adapt it to whatever a given project actually has. The invariants worth keeping are in the playbook's closing section.

License

MIT — see LICENSE.

Ver o original no GitHub

Bom para

Relacionados