Biblioteca reutilizavelEscolha um modelo pelo tipo de decisao ou problema.
Cada modelo traz contexto, campos essenciais, um bloco preenchivel e leituras relacionadas para aprofundar a pratica.
SuporteRegistro de incidente tecnico
Modelo para transformar erro, lentidao ou falha em producao em um registro investigavel, com impacto, evidencias e proxima acao.
# Registro de incidente tecnico
Data e horario:
Ambiente:
Servico, rota ou tela afetada:
Sintoma observado:
Impacto para usuario, cliente ou operacao:
Evidencias coletadas:
- Log:
- Status HTTP:
- Tempo de resposta:
- Usuario, payload ou exemplo:
Hipotese principal:
Hipoteses descartadas:
Acao tomada:
Como foi validada:
Resultado:
Proximo passo:
Responsavel:
DeployValidacao pos-deploy
Modelo para conferir se a publicacao realmente funcionou depois que containers, proxy, DNS, SSL, API e arquivos tecnicos foram atualizados.
# Validacao pos-deploy
Projeto:
Data:
Commit ou tag:
Imagem backend:
Imagem frontend:
Rotas publicas validadas:
- /
- /artigos
- /sitemap.xml
- /robots.txt
- /ads.txt
- /feed.xml
APIs validadas:
- GET /api/public/articles
- POST /api/public/contact-requests
Itens de infraestrutura:
- DNS:
- SSL:
- Nginx/proxy:
- Containers:
- Banco/migrations:
Logs apos deploy:
Problemas encontrados:
Plano de rollback:
Responsavel pela validacao:
ArquiteturaRegistro de decisao tecnica
Um ADR simples para registrar contexto, opcoes consideradas, decisao tomada, trade-offs e criterios de revisao futura.
# Registro de decisao tecnica
Titulo:
Data:
Status: proposta | aceita | revisada | substituida
Contexto:
Qual problema esta decisao tenta resolver?
Opcoes consideradas:
1.
2.
3.
Decisao tomada:
Por que esta opcao foi escolhida?
Consequencias positivas:
Consequencias negativas:
Riscos aceitos:
Como validar se a decisao funcionou:
Quando revisar esta decisao:
Responsavel:
OperacaoPlano de rollback
Modelo para definir quando voltar uma versao, quais comandos ou acoes executar, quem decide e como validar a recuperacao.
# Plano de rollback
Mudanca:
Data prevista:
Responsavel tecnico:
Responsavel pela decisao:
Gatilhos para rollback:
- Erro critico:
- Queda de API:
- Falha em formulario:
- Perda de rota publica:
Passos para rollback:
1.
2.
3.
Cuidados com banco ou dados:
Comunicacao interna:
Comunicacao para clientes, se necessario:
Como validar recuperacao:
Tempo maximo aceitavel:
Registro final:
APIsMapa de API REST
Modelo para documentar endpoint, contrato, consumidores, validacoes, erros esperados, logs e risco de mudanca.
# Mapa de API REST
Endpoint:
Metodo:
Autenticacao/autorizacao:
Consumidores conhecidos:
Entrada esperada:
Saida esperada:
Campos obrigatorios:
Validacoes:
Erros esperados:
- 400:
- 401/403:
- 404:
- 409:
- 500:
Logs necessarios:
Dados sensiveis que nao devem aparecer:
Risco de mudanca:
Estrategia de versionamento:
Teste minimo antes de publicar:
IA aplicadaMapa de fonte para IA/RAG
Modelo para registrar origem, dono, atualidade, permissao e uso permitido de documentos antes de colocar IA sobre uma base interna.
# Mapa de fonte para IA/RAG
Nome da fonte:
Tipo: documento | planilha | sistema | pagina | base interna
Dono da informacao:
Ultima revisao:
Conteudo confiavel?
Conteudo sensivel?
Quem pode acessar?
Uso permitido:
Uso proibido:
Perguntas de validacao:
1.
2.
3.
Resposta esperada ou criterio de aceitacao:
Quando revisar esta fonte:
Observacoes:
EditorialRevisao de conteudo tecnico
Modelo para revisar utilidade, autoria, fontes, exemplos, links internos, dados estruturados e risco de pagina rasa antes de publicar.
# Revisao de conteudo tecnico
Pagina ou artigo:
Pergunta principal que o conteudo responde:
Publico esperado:
Fontes consultadas:
Analise propria adicionada:
Exemplos ou riscos praticos:
Links internos incluidos:
- Artigos:
- Hubs:
- Glossario:
- Materiais:
- Paginas de confianca:
Dados estruturados:
Titulo SEO:
Meta description:
Canonical:
CTA aparece depois de conteudo util?
Existe risco de parecer pagina rasa?
Revisor:
Data da revisao: