Gerador de PRD para Ralph TUI
Crie Documentos de Requisitos de Produto detalhados e otimizados para execução por agentes de IA via ralph-tui.
O Trabalho
- Receber uma descrição de funcionalidade do usuário
- Fazer de 3 a 5 perguntas esclarecedoras essenciais (com opções de letras) - um conjunto de cada vez
- Sempre perguntar sobre os portões de qualidade (quais comandos devem passar)
- Após cada resposta, fazer perguntas de acompanhamento, se necessário (exploração adaptativa)
- Gerar um PRD estruturado quando tiver contexto suficiente
- Gerar o PRD encapsulado nos marcadores
[PRD]...[/PRD]para análise pela TUI
Importante: Não comece a implementar. Apenas crie o PRD.
Etapa 1: Perguntas Esclarecedoras (Iterativo)
Faça perguntas um conjunto de cada vez. Cada resposta deve orientar suas próximas perguntas. Concentre-se em:
- Problema/Objetivo: Que problema isso resolve?
- Funcionalidade Principal: Quais são as ações principais?
- Escopo/Limites: O que NÃO deve fazer?
- Critérios de Sucesso: Como saberemos que está pronto?
- Integração: Como isso se encaixa com as funcionalidades existentes?
- Portões de Qualidade: Quais comandos devem passar para cada história? (OBRIGATÓRIO)
Formate as Perguntas Assim:
1. Qual é o objetivo principal desta funcionalidade?
A. Melhorar a experiência de integração do usuário
B. Aumentar a retenção de usuários
C. Reduzir a carga de suporte
D. Outro: [especifique]
2. Quem é o usuário alvo?
A. Apenas novos usuários
B. Apenas usuários existentes
C. Todos os usuários
D. Apenas usuários administradores
Isso permite que os usuários respondam com "1A, 2C" para iteração rápida.
Pergunta sobre Portões de Qualidade (OBRIGATÓRIA)
Sempre pergunte sobre os portões de qualidade - eles são específicos do projeto:
Quais comandos de qualidade devem passar para cada história de usuário?
A. pnpm typecheck && pnpm lint
B. npm run typecheck && npm run lint
C. bun run typecheck && bun run lint
D. Outro: [especifique seus comandos]
Para histórias de UI, devemos incluir verificação no navegador?
A. Sim, use a habilidade dev-browser para verificar visualmente
B. Não, os testes automatizados são suficientes
Questionamento Adaptativo
Após cada resposta, decida se:
- Fazer perguntas de acompanhamento (se as respostas revelarem complexidade)
- Perguntar sobre um novo aspecto (se a área atual estiver clara)
- Gerar o PRD (se tiver contexto suficiente)
Normalmente, são necessárias de 2 a 4 rodadas de perguntas.
Etapa 2: Estrutura do PRD
Gere o PRD com estas seções:
1. Introdução/Visão Geral
Breve descrição da funcionalidade e do problema que ela resolve.
2. Objetivos
Objetivos específicos e mensuráveis (lista com marcadores).
3. Portões de Qualidade
CRÍTICO: Liste os comandos que devem passar para cada história de usuário.
## Portões de Qualidade
Estes comandos devem passar para cada história de usuário:
- `pnpm typecheck` - Verificação de tipos
- `pnpm lint` - Linting
Para histórias de UI, inclua também:
- Verificar no navegador usando a habilidade dev-browser
Esta seção é extraída pelas ferramentas de conversão (ralph-tui-create-json, ralph-tui-create-beads) e anexada aos critérios de aceitação de cada história.
4. Histórias de Usuário
Cada história precisa de:
- Título: Nome descritivo curto
- Descrição: "Como um [usuário], quero [funcionalidade] para que [benefício]"
- Critérios de Aceitação: Lista de verificação do que significa "pronto"
Cada história deve ser pequena o suficiente para ser implementada em uma sessão focada de agente de IA.
Formato:
### US-001: [Título]
**Descrição:** Como um [usuário], quero [funcionalidade] para que [benefício].
**Critérios de Aceitação:**
- [ ] Critério verificável específico
- [ ] Outro critério
Nota: NÃO inclua comandos de portão de qualidade nos critérios de histórias individuais - eles são definidos uma vez na seção Portões de Qualidade e aplicados automaticamente durante a conversão.
Importante:
- Os critérios de aceitação devem ser verificáveis, não vagos
- "Funciona corretamente" é ruim
- "O botão mostra uma caixa de diálogo de confirmação antes de excluir" é bom
- Cada história deve ser concluível de forma independente
5. Requisitos Funcionais
Lista numerada de funcionalidades específicas:
- "FR-1: O sistema deve permitir que os usuários..."
- "FR-2: Quando um usuário clicar em X, o sistema deve..."
Seja explícito e inequívoco.
6. Não-Objetivos (Fora do Escopo)
O que esta funcionalidade NÃO incluirá. Crítico para gerenciar o escopo.
7. Considerações Técnicas (Opcional)
- Restrições ou dependências conhecidas
- Pontos de integração com sistemas existentes
- Requisitos de desempenho
8. Métricas de Sucesso
Como o sucesso será medido?
9. Perguntas em Aberto
Perguntas remanescentes ou áreas que precisam de esclarecimento.
Escrevendo para Agentes de IA
O PRD será executado por agentes de IA de codificação via ralph-tui. Portanto:
- Seja explícito e inequívoco
- As histórias de usuário devem ser pequenas (concluíveis em uma sessão)
- Os critérios de aceitação devem ser, sempre que possível, verificáveis por máquina
- Inclua caminhos de arquivo específicos, se você os conhecer
- Faça referência a padrões de código existentes no projeto
Formato de Saída
CRÍTICO: Encapsule o PRD final nos marcadores para análise pela TUI:
[PRD]
# PRD: Nome da Funcionalidade
## Visão Geral
...
## Portões de Qualidade
...
## Histórias de Usuário
...
[/PRD]
Nomeação de arquivo: A TUI salvará em ./tasks/prd-[nome-da-funcionalidade].md
Exemplo de Fluxo de Conversa
Usuário: Crie um PRD para adicionar modo escuro à TUI
Assistente: Vou ajudá-lo a criar um PRD para o modo escuro. Deixe-me fazer algumas perguntas:
-
Qual é o objetivo principal? A. Reduzir o cansaço visual em sessões longas B. Corresponder à preferência de tema do sistema C. Fornecer personalização visual D. Outro
-
A configuração deve persistir? A. Sim, salvar no arquivo de configuração B. Não, apenas na sessão C. Seguir a preferência do sistema
Usuário: 1A, 2A
Assistente: Ótimo! Mais algumas perguntas:
-
Quais componentes precisam de suporte ao modo escuro? A. Todos os componentes da TUI B. Apenas a visualização principal de execução C. Visualização principal + configurações D. Outro
-
Quais comandos de qualidade devem passar para cada história? A. pnpm typecheck && pnpm lint B. npm run typecheck && npm run lint C. bun run typecheck D. Outro: [especifique]
-
Para histórias de UI, incluir verificação no navegador? A. Sim, use a habilidade dev-browser B. Não, testes automatizados são suficientes
Usuário: 3A, 4A, 5A
Assistente: Perfeito, tenho informações suficientes para gerar o PRD.
[PRD]
PRD: Modo Escuro para Ralph TUI
Visão Geral
Adicionar suporte a modo escuro ao ralph-tui para reduzir o cansaço visual durante sessões longas de orquestração. A funcionalidade será aplicada a todos os componentes da TUI e persistirá a preferência do usuário no arquivo de configuração.
Objetivos
- Fornecer uma experiência de visualização confortável em ambientes com pouca luz
- Persistir a preferência de tema entre sessões
- Aplicar estilo consistente a todos os componentes da TUI
Portões de Qualidade
Estes comandos devem passar para cada história de usuário:
pnpm typecheck- Verificação de tipospnpm lint- Linting
Para histórias de UI, inclua também:
- Verificar no navegador usando a habilidade dev-browser
Histórias de Usuário
US-001: Adicionar configuração de tema
Descrição: Como um usuário, quero definir meu tema preferido (claro/escuro) para que ele persista entre as sessões.
Critérios de Aceitação:
- Adicionar campo
themeao esquema de.ralph-tui.yaml - Suportar valores: "light", "dark", "system"
- Padrão para "light" para compatibilidade reversa
US-002: Criar paleta de cores do tema escuro
Descrição: Como um usuário, quero um tema escuro de contraste suave que seja agradável aos olhos.
Critérios de Aceitação:
- Definir paleta escura com tons de cinza (não preto puro)
- Garantir taxas de contraste suficientes (WCAG AA)
- Cores funcionam bem para todos os estados da UI (selecionado, hover, desabilitado)
US-003: Aplicar tema aos componentes da TUI
Descrição: Como um usuário, quero que todos os componentes da TUI respeitem minha preferência de tema.
Critérios de Aceitação:
- Componente de cabeçalho usa cores do tema
- Lista de tarefas usa cores do tema
- Painéis de detalhes usam cores do tema
- Barra de progresso usa cores do tema
- Diálogos usam cores do tema
US-004: Adicionar alternância de tema nas configurações
Descrição: Como um usuário, quero alternar temas a partir das configurações da TUI.
Critérios de Aceitação:
- Opção de tema visível na visualização de configurações
- Alterações aplicam-se imediatamente sem reinicialização
- Alterações persistem no arquivo de configuração
Requisitos Funcionais
- FR-1: A configuração de tema deve ser legível a partir de
.ralph-tui.yaml - FR-2: O tema deve ser aplicado na inicialização da TUI
- FR-3: As alterações de tema nas configurações devem ser aplicadas imediatamente
- FR-4: Todo o texto deve manter a legibilidade em ambos os temas
Não-Objetivos
- Detecção automática do tema do sistema (melhoria futura)
- Esquemas de cores personalizados além de claro/escuro
- Substituições de tema por componente
Considerações Técnicas
- Usar capacidades de theming do OpenTUI existentes, se disponíveis
- Considerar criar um ThemeContext para componentes React
- Minimizar re-renderizações quando o tema for alterado
Métricas de Sucesso
- Todos os componentes renderizam corretamente no modo escuro
- Nenhum problema de contraste de acessibilidade
- O tema persiste entre sessões
Perguntas em Aberto
- Devemos detectar automaticamente a preferência de tema do sistema na v2? [/PRD]
Lista de Verificação
Antes de gerar o PRD:
- Fez perguntas esclarecedoras com opções de letras
- Perguntou sobre os portões de qualidade (OBRIGATÓRIO)
- Fez perguntas de acompanhamento quando necessário
- Seção Portões de Qualidade incluída com comandos específicos do projeto
- Histórias de usuário são pequenas e concluíveis de forma independente
- Histórias de usuário NÃO incluem comandos de portão de qualidade (eles estão na seção Portões de Qualidade)
- Requisitos funcionais são numerados e inequívocos
- Seção de Não-Objetivos define limites claros
- PRD está encapsulado nos marcadores
[PRD]...[/PRD]