Skip to content

Sistema Playbooks

Nota: Esta página descreve a implementação técnica de nossa filosofia Constitutional Engineering. Se você ainda não leu sobre a fundação filosófica, recomendamos começar lá para entender o "porquê" por trás dos playbooks.

O sistema Playbooks é a solução de segunda geração do Hatcher para o problema de contexto no desenvolvimento com IA. Onde arquivos estáticos como Claude.md fornecem um ponto de partida, Playbooks oferecem um sistema dinâmico, centralizado e governável que atua como uma verdadeira Constituição Corporativa para seus agentes de IA.

O Que São Playbooks?

Playbooks são arquivos de configuração estruturados que capturam:

  • Padrões de Codificação: Formatação, convenções de nomenclatura e preferências de estilo
  • Decisões Arquitetônicas: Padrões de componentes, abordagens de gerenciamento de estado
  • Especificidades de Framework: Melhores práticas e padrões específicos de biblioteca
  • Regras de Negócio: Lógica e restrições específicas do domínio

Estrutura de Playbook

Um Playbook básico segue esta estrutura:

json
{
  "name": "Vue 3 Component Standards",
  "version": "1.0.0",
  "framework": "vue",
  "rules": [
    {
      "category": "components",
      "type": "naming",
      "pattern": "PascalCase",
      "description": "All Vue components must use PascalCase naming"
    },
    {
      "category": "composition",
      "type": "api",
      "preference": "composition-api",
      "description": "Prefer Composition API over Options API"
    }
  ],
  "examples": [
    {
      "title": "Standard Component Structure",
      "code": "..."
    }
  ]
}

Playbooks Integrados

Hatcher vem com Playbooks curados para frameworks populares:

Playbooks Vue.js

  • Vue 3 + TypeScript: Padrões de composition modernos
  • Nuxt.js: Convenções SSR e roteamento baseado em arquivos
  • Pinia: Melhores práticas de gerenciamento de estado

Playbooks React

  • React + TypeScript: Componentes funcionais e hooks
  • Next.js: App Router e server components
  • Zustand: Gerenciamento de estado leve

Playbooks Universais

  • TypeScript Standards: Definições de tipo e genéricos
  • CSS-in-JS: Padrões de Styled-components e emotion
  • Testing: Convenções Jest e Cypress

Criando Playbooks Customizados

Regras Específicas da Equipe

Crie Playbooks que capturam as convenções únicas da sua equipe:

json
{
  "name": "Acme Corp Standards",
  "extends": ["vue3-typescript"],
  "rules": [
    {
      "category": "api",
      "type": "structure",
      "pattern": "services/api/*.service.ts",
      "description": "All API calls must go through service layer"
    },
    {
      "category": "components",
      "type": "props",
      "requirement": "interfaces",
      "description": "Component props must use TypeScript interfaces"
    }
  ]
}

Contexto Específico do Projeto

Adicione conhecimento específico do projeto:

json
{
  "name": "E-commerce Dashboard",
  "extends": ["acme-corp-standards"],
  "context": {
    "domain": "e-commerce",
    "entities": ["Product", "Order", "Customer"],
    "apis": [
      {
        "name": "OrdersAPI",
        "baseUrl": "/api/orders",
        "methods": ["GET", "POST", "PUT", "DELETE"]
      }
    ]
  }
}

Herança de Playbook

Playbooks suportam herança para configuração escalável:

Universal TypeScript

Vue 3 + TypeScript

Acme Corp Standards

Project-Specific Rules

Integração com IA

Hatcher automaticamente injeta contexto de Playbook relevante em prompts de IA:

Seleção de Contexto

  • Automática: Baseada em tipos de arquivo e estrutura do projeto
  • Manual: Especifique explicitamente quais Playbooks usar
  • Inteligente: Aprenda com suas preferências ao longo do tempo

Aprimoramento de Prompt

Engines de IA recebem contexto estruturado como:

CONTEXT: Vue 3 Component Creation
PLAYBOOK: vue3-typescript, acme-corp-standards
RULES:
- Use Composition API with <script setup>
- Props must use TypeScript interfaces
- Components must be PascalCase
- API calls go through service layer

Marketplace & Compartilhamento

Playbooks da Comunidade

Navegue e instale Playbooks criados pela comunidade:

  • Específicos de Framework: Padrões otimizados para bibliotecas populares
  • Específicos de Indústria: Conhecimento de domínio para diferentes setores
  • Testados por Equipes: Convenções do mundo real de projetos bem-sucedidos

Publicando Seus Playbooks

Compartilhe a expertise da sua equipe:

bash
hatcher playbook publish acme-corp-standards

Gerenciamento de Versão

  • Versionamento Semântico: Rastreie mudanças e compatibilidade
  • Notificações de Atualização: Mantenha-se atualizado com melhorias da comunidade
  • Suporte a Rollback: Reverta atualizações problemáticas com segurança

Configuração

Playbooks Globais

Defina Playbooks padrão para todos os projetos:

json
{
  "globalPlaybooks": ["typescript-standards", "git-conventions"]
}

Override de Projeto

Especifique Playbooks específicos do projeto em hatcher.config.json:

json
{
  "playbooks": ["vue3-typescript", "team-standards", "./custom-playbook.json"]
}

Carregamento Condicional

Carregue diferentes Playbooks baseado em contexto:

json
{
  "conditional": {
    "**/*.test.ts": ["testing-standards"],
    "src/components/**": ["component-standards"],
    "src/api/**": ["api-standards"]
  }
}

Melhores Práticas

Comece Simples

Comece com os básicos do framework e adicione gradualmente regras específicas da equipe:

  1. Instale Playbook de Framework: Obtenha 80% de cobertura instantaneamente
  2. Adicione Regras da Equipe: Capture convenções únicas
  3. Refine ao Longo do Tempo: Atualize baseado no uso real

Mantenha Atualizado

  • Revisões Regulares: Atualize Playbooks conforme padrões evoluem
  • Feedback da Equipe: Envolva toda a equipe na manutenção de Playbooks
  • Controle de Versão: Rastreie mudanças de Playbook junto com código

Meça Impacto

  • Métricas de Consistência: Rastreie aderência a padrões definidos
  • Melhorias de Velocidade: Meça ganhos de velocidade de desenvolvimento
  • Indicadores de Qualidade: Monitore redução de feedback de code review

Features Futuras

Playbooks Gerados por IA

Gere automaticamente Playbooks analisando codebases existentes.

Validação em Tempo Real

Feedback ao vivo enquanto você codifica, garantindo conformidade com Playbook.

Colaboração em Equipe

Workflows de edição colaborativa e aprovação para atualizações de Playbook.

O sistema Playbooks transforma IA de um gerador de código genérico em um membro especializado da sua equipe que entende seus requisitos e convenções exatos.

Crie Seu Primeiro Playbook

Transforme IA em um membro de equipe especializado que segue seus padrões exatos