Digite para filtrar as páginas da documentação.

    Specsfy

    Como funciona a metodologia do Specsfy na prática diária

    Como o Specsfy organiza definição, plano, testes e implementação em uma única especificação, através dos três atos e seus gates de evidência real.

    O Specsfy ajuda você a transformar uma necessidade em uma entrega comprovada. Você explica o que precisa, e o agente organiza a definição, o plano, os testes e a implementação na mesma especificação.

    A metodologia existe para responder, durante todo o trabalho, a três perguntas:

    1. O que será entregue?
    2. O que comprova que o plano está pronto?
    3. Qual evidência comprova que a entrega funciona?

    Você não precisa decorar comandos nem escolher cada skill. O agente identifica a etapa atual, anuncia as transições e mantém o trabalho na mesma conversa.

    Uma única especificação

    Cada mudança escolhida possui uma única fonte normativa. O caminho permite que você reconheça a sequência e o assunto ao listar o diretório de specs:

    specs/specs/<NNNN>-<slug>/spec.md

    NNNN é o número da spec, como 0001. O slug identifica o assunto, como recuperar-senha. Assim, o caminho 0001-recuperar-senha pode ser localizado sem abrir o arquivo.

    Ao abrir a spec.md, você encontra o comportamento esperado, o plano e as provas que permitem conferir o estado atual:

    • o problema e o resultado esperado.
    • as pessoas afetadas e as regras que precisam ser respeitadas.
    • histórias, requisitos e limites.
    • exemplos de comportamento escritos em BDD.
    • as escolhas registradas, as possíveis falhas e o plano técnico.
    • tarefas, testes e evidências da execução.
    • gates e estado atual da entrega.

    O plano e as tarefas ficam dentro da própria spec. O Specsfy não cria plan.md ou tasks.md, então a explicação da entrega não se divide entre arquivos com estados diferentes.

    Da Inbox até o código

    Nem todo texto precisa virar uma entrega imediatamente. Você escolhe o destino de acordo com o quanto já definiu:

    • A Inbox preserva seu texto em specs/inbox/ sem perguntas e sem autorizar implementação.
    • O backlog guarda uma proposta que merece organização e refinamento, mas ainda não foi escolhida para entrega. Ela vive em specs/backlog/.
    • A spec representa uma entrega escolhida. A partir dela, definição, plano, testes, código e evidências passam a seguir o mesmo contrato.

    O percurso mais completo preserva a entrada, aprofunda as definições e só chega ao código depois do plano e do RED:

    Inbox → Backlog → spec → plano e RED → código → validação

    Você também pode começar com “implemente recuperação de senha”. O agente só altera o código depois de verificar as definições ausentes e conduzir as etapas correspondentes.

    Os três atos

    Os atos são grupos de trabalho. Cada um termina com um gate, que é um ponto de controle baseado em evidência. Um gate aprovado não significa apenas “parece bom”: significa que as condições daquela etapa foram verificadas.

    Escolha o destino da entrada

    Objetivo: preservar a entrada sem transformá-la imediatamente em spec.

    Sua participação: você informa a entrada e escolhe quando vale refiná-la ou promovê-la. Se solicitar apenas a captura, o agente não inicia o refinamento.

    Prova técnica: a captura recebe um arquivo próprio em specs/inbox/. Se você escolher o refinamento, ela segue para o backlog. A spec.md normativa só aparece depois de uma promoção explícita.

    Essa separação mantém a caixa de entrada leve e impede que toda observação se transforme em código ou em uma especificação extensa.

    Ato I — Definir o que precisa mudar

    Objetivo: entender o problema e transformar a intenção em comportamento que possa ser conferido.

    Sua participação: você responde apenas às dúvidas que realmente mudam a entrega. O agente reaproveita o que já foi informado, pergunta sobre uma lacuna importante por vez e não inventa requisitos quando falta uma definição.

    Prova técnica: a spec registra a finalidade, as pessoas afetadas, os requisitos, os limites e os cenários BDD. A validação procura contradições, definições em aberto e dúvidas que impedem o planejamento.

    O Ato I termina quando a validação registra este gate na spec.md:

    Definition Gate: Passed

    Esse estado permite que o agente organize o plano a partir dos requisitos e cenários já conferidos. O código ainda não foi alterado, e o Plan Gate continua pendente.

    Ato II — Planejar e preparar o RED

    Objetivo: definir como a mudança será construída e demonstrar que os testes conseguem detectar a ausência do novo comportamento.

    Sua participação: você confirma escolhas de produto ou estratégia que alteram o resultado. Os detalhes técnicos que o repositório consegue comprovar podem ser derivados do código, da stack e das regras do projeto.

    Prova técnica: o agente registra as tarefas, os contratos, as informações afetadas, as possíveis falhas e a reversibilidade na spec. Depois, transforma os cenários BDD em testes TDD executáveis e observa o RED, uma falha causada pela funcionalidade que ainda não existe.

    O Ato II termina quando as tarefas e os testes permitem registrar:

    Plan Gate: Passed

    O RED precisa falhar pelo motivo esperado. Erro de sintaxe, dependência ausente ou ambiente quebrado não prova que o teste protege o comportamento.

    Ato III — Entregar e conferir o resultado

    Objetivo: implementar cada tarefa e reunir evidências atuais de que o resultado atende à definição.

    Sua participação: você acompanha novas escolhas ou mudanças de escopo. O agente registra cada comando executado e apresenta o resultado verificável, sem exigir que você conduza os ciclos de teste.

    Prova técnica: cada tarefa de código parte de um teste que falha pelo motivo esperado, recebe a menor implementação capaz de deixá-lo verde e termina com refatoração protegida pela suíte:

    RED → GREEN → REFACTOR
    • RED: o teste falha pela razão esperada.
    • GREEN: a menor implementação faz o teste passar.
    • REFACTOR: o código é melhorado sem mudar o comportamento.

    Depois, o agente executa o aceite e a regressão completa, verifica a ligação entre cada requisito e seu teste, atualiza os registros permanentes do projeto e reconstrói a documentação aplicável.

    O Ato III termina quando o aceite, a regressão e a documentação permitem registrar:

    Delivery Gate: Passed
    Status: Complete

    Complete significa que a entrega possui código e evidência atual. Você pode abrir a spec e localizar os comandos, os resultados e os testes que comprovam esse estado.

    Como BDD e TDD trabalham juntos

    O BDD (desenvolvimento orientado por comportamento) descreve o resultado que produto e desenvolvimento precisam discutir. O TDD (desenvolvimento orientado por testes) transforma esse comportamento em uma prova executável no projeto.

    O BDD descreve o comportamento em uma linguagem que produto, desenvolvimento e testes conseguem discutir. Por exemplo:

    Cenário: cliente solicita recuperação de senha
    Dado que existe um cadastro para o e-mail informado
    Quando o cliente solicita a recuperação
    Então o sistema confirma a solicitação sem revelar informações privadas

    Esse cenário mostra a regra e o resultado esperado, mas o texto Gherkin não é executado como uma suíte separada pelo Specsfy.

    O TDD transforma o comportamento em testes executáveis na ferramenta já usada pelo projeto. Primeiro o teste falha pelo motivo correto. Depois, a implementação faz o teste passar. Em resumo:

    • BDD ajuda a definir o comportamento que importa.
    • TDD comprova que o código apresenta esse comportamento.

    Essa ligação evita uma descrição clara sem prova automática e também impede que um teste técnico seja aceito sem representar a necessidade registrada.

    O agente conduz as transições

    As skills dividem responsabilidades, mas você não precisa operar o fluxo como uma lista de comandos. Quando uma etapa depende de outra, o agente:

    1. informa de qual skill está saindo e para qual está indo.
    2. explica a pendência que motivou a transição.
    3. resolve a pendência na skill responsável.
    4. retorna à etapa anterior quando necessário.

    Por exemplo, se a implementação encontrar um teste ausente, o agente volta ao planejamento e à preparação TDD, obtém um RED válido e só então retoma o código. Ele não aprova um gate apenas para contornar a pendência.

    Mudanças durante o trabalho

    Se a necessidade mudar depois que a spec já existe, explique a alteração em linguagem normal. O novo requisito entra na mesma spec.md, sem criar uma segunda especificação.

    O Specsfy reabre somente as provas que perderam validade:

    • Uma mudança de comportamento reabre definição, plano e entrega.
    • Uma mudança apenas na estratégia técnica reabre plano e entrega.
    • Uma evidência desatualizada exige somente a repetição da validação correspondente.

    Use specsfy-update-spec para incorporar a nova instrução. A skill informa quais gates perderam validade e retoma a primeira etapa afetada.

    Informações que permanecem entre entregas

    Além da spec de cada entrega, o projeto mantém informações que valem para o sistema inteiro:

    • PROJECT.md: finalidade, capacidades e limites do projeto.
    • .specsfy/STACK.md: tecnologias estruturais e suas evidências.
    • .specsfy/RULES.md: regras confirmadas para o trabalho.
    • .specsfy/DATABASE.md: visão da persistência e das relações.

    O agente consulta esses arquivos antes de planejar e os revisa durante a implementação. Assim, uma nova entrega começa com a arquitetura, as convenções e o banco já documentados.

    O que você encontra ao final

    Uma mudança completa deixa na spec.md um caminho auditável entre requisito, teste, tarefa e evidência:

    • a intenção e as escolhas estão na spec.
    • cada requisito aponta para condições de aceite.
    • os cenários BDD explicam o comportamento.
    • os testes TDD demonstram o resultado no código.
    • as tarefas registram execução e evidências.
    • os gates mostram quais etapas foram realmente comprovadas.
    • a documentação reflete o sistema implementado.

    Para consultar esse estado sem alterar arquivos, use specsfy-progress.

    Limites do método

    O método não define requisitos importantes sem você, não transforma toda ideia em spec e não trata pesquisa como requisito aprovado. Também não aceita erro de ambiente como RED nem substitui os testes e as ferramentas do seu projeto.

    Justificativa de tamanho

    Este guia mantém os três atos, os gates e a relação entre BDD e TDD na mesma página para que você possa comparar o percurso completo sem alternar entre explicações parciais.

    O guia de instalação prepara o CLI e o framework. Depois, o primeiro projeto aplica os três atos a uma página de boas-vindas e mostra os gates na spec.md.

    Planos Promovaweb

    Tire seus projetos do papel

    O Plano Martech cobre automação e atendimento. O Plano IA Makers acrescenta desenvolvimento com IA, enquanto o Plano Founders trata de gestão de negócios. Todos são anuais.

    Plano Martech

    Para conectar automação, marketing e atendimento com infraestrutura própria.

    R$ 897

    R$ 597/ano

    • Grade de automação, atendimento, marketing e análise de indicadores
    • Instalador Exclusivo Promovaweb
    • n8n, Evolution API, Chatwoot e Mautic
    • Trilha DevOps incluída
    • Encontros ao vivo (terça e quinta)
    • Comunidade e acompanhamento
    Conhecer o plano

    Plano Founders

    Gestão, contratos e precificação para fundadores de tecnologia.

    R$ 1.997/ano

    • Plano independente de gestão
    • Precificação por Valor (ROI)
    • Direito Digital e Contratos Prontos
    • FinOps e Gestão Financeira
    • Clube Founders (Networking)
    • Mentoria Semanal de Negócios
    Conhecer o plano