TRILHA 6

๐Ÿ“ฅ Templates e Downloads

Documentos padrao, templates e prompts para iniciar seu projeto GIPM. Baixe, personalize e comece a construir com governanca.

7
Modulos
6
Templates
48
Topicos
.md
Formato

Navegacao Rapida

Conteudo Detalhado

6.1 6 topicos

๐Ÿ“‹ Visao Geral dos Templates

Entenda o fluxo de documentacao do GIPM e como cada template se conecta.

O que e:

A documentacao no GIPM nao e burocracia - e governanca. Cada documento cria um ponto de auditoria, uma decisao registrada que pode ser revisitada.

Por que aprender:

Sem documentacao, nao ha como rastrear por que decisoes foram tomadas. Quando algo quebra, voce precisa do historico.

Conceitos-chave:

Governanca documental, auditoria, rastreabilidade, decisoes registradas, compliance.

O que e:

A ordem ideal: 1) Project Brief, 2) PRD, 3) Arquitetura, 4) User Stories, 5) QA Gate. Cada documento alimenta o proximo na cadeia.

Por que aprender:

Seguir a ordem correta evita retrabalho. Arquitetura sem PRD e chute. Stories sem arquitetura sao incompletas.

Conceitos-chave:

Fluxo documental, dependencias, cadeia de valor, sequenciamento, input-output.

O que e:

Brief e estrategico (por que e o que em alto nivel). PRD e tatico (requisitos detalhados e especificos). Nunca pule o Brief.

Por que aprender:

Confundir os dois leva a PRDs sem contexto estrategico ou Briefs com detalhes tecnicos desnecessarios.

Conceitos-chave:

Estrategia vs tatica, niveis de abstracao, escopo, visao, requisitos.

O que e:

O documento de arquitetura e um contrato entre o time e a IA. Define padroes obrigatorios, stack tecnologico e estrutura.

Por que aprender:

Se a IA gerar codigo fora dos padroes definidos, o documento permite identificar a violacao e corrigir.

Conceitos-chave:

Contrato arquitetural, padroes, stack, estrutura de projeto, regras tecnicas.

O que e:

Stories GIPM sao escritas para agentes de IA. Precisam ser atomicas, especificas, com criterios de aceitacao testaveis.

Por que aprender:

Stories vagas geram codigo vago. A IA nao tem contexto implicito como humanos - precisa de tudo explicito.

Conceitos-chave:

Atomicidade, criterios de aceitacao, especificidade, contexto explicito, testabilidade.

O que e:

Cada documento referencia os anteriores. Arquitetura cita PRD. Stories citam arquitetura. QA valida stories. E uma cadeia.

Por que aprender:

Essa cadeia cria rastreabilidade total - do requisito de negocio ao codigo, passando por todas as decisoes.

Conceitos-chave:

Rastreabilidade, referencias cruzadas, cadeia de evidencias, auditoria end-to-end.

๐Ÿ“ Project Brief

O documento fundacional que define visao, problema, usuarios e escopo do projeto.

O que e:

Documento que captura a essencia do projeto: problema, solucao, usuarios, restricoes. O "elevator pitch" expandido.

Por que aprender:

E o ponto de partida de tudo. Sem Brief claro, todo o resto fica sem direcao.

Conceitos-chave:

Visao, problema, solucao, personas, escopo, restricoes, premissas.

O que e:

2-3 frases que qualquer pessoa pode ler e entender o projeto. Se nao consegue resumir, nao entendeu ainda.

Por que aprender:

Forcavoce a ter clareza. Tambem facilita comunicacao com stakeholders que nao vao ler o documento todo.

Conceitos-chave:

Sintese, comunicacao executiva, clareza, pitch.

O que e:

Descreva o problema de forma mensuravel. "Usuarios perdem tempo" e vago. "2h/dia em tarefas manuais" e especifico.

Por que aprender:

Problema mensuravel permite medir sucesso. Sem numeros, como saber se a solucao funcionou?

Conceitos-chave:

Metricas, quantificacao, baseline, impacto mensuravel, KPIs.

O que e:

Defina personas concretas. Nao "empresas", mas "gerentes de projeto em empresas de 50-200 funcionarios".

Por que aprender:

Personas guiam decisoes de UX, features e priorizacao. Construir para "todos" e construir para ninguem.

Conceitos-chave:

Personas, segmentacao, perfil de usuario, jobs-to-be-done, necessidades.

O que e:

Liste explicitamente o que esta IN e OUT do MVP. Essa lista evita scope creep e alinha expectativas.

Por que aprender:

Sem lista explicita do que esta fora, tudo pode entrar. Scope creep mata projetos.

Conceitos-chave:

MVP, escopo, IN/OUT, scope creep, priorizacao, trade-offs.

O que e:

Documente limitacoes de orcamento, timeline, tecnologia. Premissas sao apostas - se mudarem, o projeto muda.

Por que aprender:

Restricoes definem o espaco de solucao. Premissas sao riscos - se uma premissa cair, voce precisa revalidar.

Conceitos-chave:

Restricoes, premissas, riscos, constraints, validacao de hipoteses.

O que e:

Use o prompt de geracao de Brief com seu LLM. Forneca contexto maximo. Itere. O Brief final passa pelo crivo humano.

Por que aprender:

IA acelera a criacao, mas humano valida. O fluxo e: IA gera estrutura, humano refina e aprova.

Conceitos-chave:

Geracao assistida, iteracao, validacao humana, prompt engineering.

O que e:

Atualize quando premissas mudarem significativamente. Mantenha changelog. Versione o documento.

Por que aprender:

Documentos vivos precisam de gestao de versao. Sem isso, perde-se o historico de evolucao.

Conceitos-chave:

Versionamento, changelog, documento vivo, gestao de mudancas.

๐Ÿ“Š PRD - Product Requirements Document

Detalha requisitos funcionais, nao-funcionais, epicos e historias de usuario.

O que e:

O PRD traduz a visao do Brief em requisitos executaveis. E mais detalhado, mais tecnico, mais proximo da implementacao.

Por que aprender:

A transicao Brief->PRD e onde visao vira especificacao. Erros aqui propagam para todo o projeto.

Conceitos-chave:

Especificacao, requisitos, traducao, detalhamento progressivo.

O que e:

O que o sistema DEVE fazer. Use formato "O sistema deve [verbo] [objeto] [condicao]". Seja especifico e testavel.

Por que aprender:

FRs sao a base de tudo. Cada feature, cada teste, cada validacao deriva de um FR.

Conceitos-chave:

Requisitos funcionais, comportamento, acoes, testabilidade, especificidade.

O que e:

Como o sistema deve se comportar. Performance, seguranca, disponibilidade. As "-ilities" que definem qualidade.

Por que aprender:

NFRs sao frequentemente esquecidos ate ser tarde demais. Performance ruim mata produtos bons.

Conceitos-chave:

NFRs, qualidade, performance, seguranca, disponibilidade, escalabilidade.

O que e:

Epicos sao grandes blocos de trabalho sequenciais. Epico 1 sempre e fundacao (setup, CI/CD, auth basica).

Por que aprender:

Ordem de epicos define dependencias. Construir feature antes de infra e receita para retrabalho.

Conceitos-chave:

Epicos, sequenciamento, dependencias, fundacao, incrementalidade.

O que e:

Formato: Como [usuario], eu quero [acao], para que [beneficio]. Criterios de aceitacao sao OBRIGATORIOS.

Por que aprender:

Stories conectam requisitos a valor de usuario. Sem AC, nao ha definicao de done.

Conceitos-chave:

User stories, criterios de aceitacao, valor, persona, formato padrao.

O que e:

Must: sem isso nao lanca. Should: importante mas nao bloqueante. Could: nice to have. Won't: fora do escopo.

Por que aprender:

Priorizacao clara evita discussoes infinitas. MoSCoW e simples e efetivo.

Conceitos-chave:

MoSCoW, priorizacao, trade-offs, escopo, MVP, releases.

๐Ÿ—๏ธ Documento de Arquitetura

Define stack tecnico, padroes arquiteturais, componentes, APIs e infraestrutura.

O que e:

Este documento e o blueprint tecnico. Cada decisao de tecnologia, cada padrao esta aqui. E a fonte da verdade tecnica.

Por que aprender:

Sem arquitetura documentada, cada dev toma decisoes diferentes. Inconsistencia mata manutenibilidade.

Conceitos-chave:

Blueprint, fonte da verdade, decisoes tecnicas, consistencia, padronizacao.

O que e:

Liste TODAS as tecnologias com versoes especificas. "Node.js 20.11.0 LTS" nao "Node.js". Versoes evitam surpresas.

Por que aprender:

"Funciona na minha maquina" e causado por versoes diferentes. Documente tudo explicitamente.

Conceitos-chave:

Versionamento, reproducibilidade, stack, dependencias, LTS.

O que e:

Documente padroes escolhidos: Repository Pattern, DI, CQRS, etc. Inclua justificativa. Sao LEI para a IA.

Por que aprender:

IA so segue padroes se estiverem documentados. Sem isso, ela inventa solucoes inconsistentes.

Conceitos-chave:

Design patterns, arquitetura de software, DI, Repository, CQRS, Clean Architecture.

O que e:

Defina entidades, atributos, relacionamentos. Use diagramas Mermaid. Guia a criacao de banco e APIs.

Por que aprender:

Modelo de dados errado no inicio e caro de corrigir depois. Defina bem antes de codar.

Conceitos-chave:

Modelagem, entidades, relacionamentos, ERD, Mermaid, schemas.

O que e:

Documente endpoints em OpenAPI/Swagger. Request/response schemas, codigos de erro. A IA usara isso para gerar codigo.

Por que aprender:

API bem documentada permite geracao de codigo, testes, e clientes automaticamente.

Conceitos-chave:

OpenAPI, Swagger, REST, endpoints, schemas, contratos de API.

O que e:

Documente estrategias de validacao, autenticacao, autorizacao, gestao de secrets. Seguranca nao e opcional.

Por que aprender:

Seguranca pensada depois e seguranca fraca. Defina no inicio como parte da arquitetura.

Conceitos-chave:

Autenticacao, autorizacao, JWT, secrets, OWASP, validacao de input.

๐Ÿ“– User Stories

Template para historias de usuario com criterios de aceitacao e tracking de implementacao.

O que e:

Status, Story (As a/I want/So that), Criterios de Aceitacao, Tarefas, Notas de Dev, Testes, Dev Agent Record, QA Results.

Por que aprender:

Cada secao tem proposito. Pular qualquer uma compromete rastreabilidade ou qualidade.

Conceitos-chave:

Estrutura de story, AC, tarefas, tracking, registro de implementacao.

O que e:

Sao o CONTRATO de done. Cada AC deve ser testavel. "Funciona bem" nao e AC. "Resposta em menos de 200ms" e AC.

Por que aprender:

AC ambiguos geram debates infinitos sobre done. AC claros terminam discussoes.

Conceitos-chave:

Criterios de aceitacao, testabilidade, definicao de done, especificidade.

O que e:

Quebre a story em tarefas atomicas. Referencie qual AC cada tarefa atende. Facilita tracking e QA.

Por que aprender:

Tarefas atomicas permitem progresso mensuravel e facilitam code review focado.

Conceitos-chave:

Breakdown, atomicidade, rastreabilidade AC-tarefa, progresso incremental.

O que e:

Quando IA implementa, registre modelo usado, logs, notas de conclusao, arquivos modificados. Auditabilidade total.

Por que aprender:

Sem registro, nao se sabe qual modelo gerou qual codigo. Essencial para debug e melhoria de prompts.

Conceitos-chave:

Auditoria de IA, logging, rastreabilidade, modelo, arquivos modificados.

O que e:

Uma story deve ser completavel em uma sessao (2-4 horas). Se for maior, quebre em stories menores.

Por que aprender:

Stories grandes demais perdem contexto e acumulam risco. Stories pequenas entregam valor rapido.

Conceitos-chave:

Tamanho de story, atomicidade, sessao de trabalho, feedback loop curto.

โœ… QA Gate - Checklist de Qualidade

Checklist para validar que cada entrega atende aos padroes de qualidade.

O que e:

Checkpoint que toda entrega deve passar antes de ser done. Sem QA Gate aprovado, nao ha merge.

Por que aprender:

QA Gate e a ultima linha de defesa contra codigo ruim entrando em producao.

Conceitos-chave:

Quality gate, checkpoint, validacao, merge, bloqueio.

O que e:

Codigo (lint, tests, types), Funcional (ACs atendidos), Seguranca (OWASP), UX (responsivo), e Performance (metricas).

Por que aprender:

Cada categoria pega tipos diferentes de problemas. Cobrir todas garante qualidade holistica.

Conceitos-chave:

Categorias de QA, cobertura, qualidade holistica, areas de risco.

O que e:

Unitarios, integracao, E2E. Cobertura minima de 80%. Testes passando e pre-requisito de merge.

Por que aprender:

Testes automatizados sao a unica forma de escalar QA. Review manual nao escala.

Conceitos-chave:

Testes automatizados, cobertura, CI, unitarios, integracao, E2E.

O que e:

Se falhar no QA Gate, documente a falha, corrija, e submeta novamente. Loop ate passar.

Por que aprender:

Processo claro de correcao evita que problemas fiquem em limbo. Sempre ha proxima acao definida.

Conceitos-chave:

Fluxo de correcao, resubmissao, loop de qualidade, documentacao de falhas.

O que e:

Track taxa de aprovacao, falhas por categoria, tempo medio para resolver. Use dados para melhorar processo.

Por que aprender:

Sem metricas, nao ha como saber se QA esta melhorando ou piorando. Dados guiam decisoes.

Conceitos-chave:

Metricas de QA, taxa de aprovacao, tempo de resolucao, melhoria continua.

๐Ÿค– Prompts para IA

Colecao de prompts testados para gerar cada tipo de documento do GIPM.

O que e:

Prompt estruturado que guia a IA a fazer perguntas e gerar um Brief completo seguindo o template GIPM.

Por que aprender:

Prompt bem construido extrai informacao que voce nem sabia que tinha. IA como entrevistador.

Conceitos-chave:

Prompt engineering, elicitacao, entrevista estruturada, geracao guiada.

O que e:

Prompt que transforma Brief em PRD detalhado com FRs, NFRs, epicos e stories formatados corretamente.

Por que aprender:

Conversao Brief->PRD e trabalho pesado. IA acelera drasticamente com prompt certo.

Conceitos-chave:

Conversao de documentos, detalhamento, formatacao, consistencia.

O que e:

Prompt que gera documento de arquitetura com stack, padroes, diagramas Mermaid, e specs de API.

Por que aprender:

Arquitetura requer pensamento sistemico. Prompt ajuda a nao esquecer componentes criticos.

Conceitos-chave:

Geracao de arquitetura, diagramas, specs tecnicas, completude.

O que e:

Prompt que gera stories atomicas com ACs testaveis, tarefas granulares, e secoes de tracking ja formatadas.

Por que aprender:

Stories bem escritas sao a base de implementacao com IA. Prompt garante consistencia.

Conceitos-chave:

Geracao de stories, atomicidade, ACs testaveis, formatacao padrao.

O que e:

Tecnicas gerais: seja especifico, forneca exemplos, itere, use personas, defina formato de output desejado.

Por que aprender:

Prompt engineering e skill transferivel. Melhora resultados em qualquer uso de IA.

Conceitos-chave:

Especificidade, exemplos, iteracao, personas, formatacao de output.

O que e:

Como encadear prompts: Brief -> PRD -> Arquitetura -> Stories. Cada output alimenta proximo input.

Por que aprender:

Visao end-to-end mostra como as pecas se conectam. Automacao maxima do fluxo documental.

Conceitos-chave:

Encadeamento de prompts, fluxo documental, automacao, consistencia.