Templates Blocos de Conteúdo
Templates de blocos/seções reutilizáveis para compor páginas.
[SEÇÃO] Objetivo
Objetivo Descrever, de forma clara e concisa, as práticas recomendadas para <tema/área> a fim de ...
[SEÇÃO] Contexto
Contexto Contexto e objetivo do guia.
[SEÇÃO] Pré-requisitos
Pré-requisitos <Pré-requisito 1> <Pré-requisito 2>
[SEÇÃO] Materiais/Recursos
Materiais/Recursos <Recurso 1> <Recurso 2>
[SEÇÃO] Passos
Passos Passo 1- Explicação passo 1 <Texto de exemplo.> Passo 2 - Explicação passo 2 <Texto de exe...
[SEÇÃO] Critérios de Aceitação
Critérios de aceitação <Critério de aceitação 1> <Critério de aceitação 2> <Critério de aceitação 3>
[SEÇÃO] Dicas
Dicas <Dica 1> <Dica 2
[SEÇÃO] Riscos e Mitigações
Riscos e Mitigações Risco Probabilidade Impacto Mitigação <risco 1> Baixa/Média/Alta Baixo/Médio/...
[SEÇÃO] FAQ (Perguntas frequentes)
FAQ (Perguntas frequentes) Pergunta 1 Resposta 1 Pergunta 2 Resposta 2
[SEÇÃO] Contatos de suporte
Contatos de suporte Sender25 — Whatsapp
[SEÇÃO] Controle de Mudanças
Controle de Mudanças Informações de controle de versão Última revisão <DD-MM-YYYY> Próxima revisã...
[SEÇÃO] Notas adicionais
Notas adicionais <Observações adicionais>
[SEÇÃO] Referências
Referências (Interno) [POP: Renovação de Certificado TLS] — Infra > TLS. (Externo) [Guia: LGPD pa...
[SEÇÃO] Considerações de segurança
Considerações de segurança Impactos de segurança, boas práticas e controles.
[SEÇÃO] Escopo e Público
Escopo e Público Aplica-se a: <processos/serviços/atividades> Não cobre: <limites e exceções> Púb...
[SEÇÃO] Diretrizes Gerais (Do / Don’t)
Diretrizes Gerais (Do / Don’t) Faça (Do) Use linguagem clara, objetiva e respeitosa. Registre dec...
[SEÇÃO] Exceções e Desvios
Exceções e Desvios Registre motivo, risco/impacto, medidas provisórias e prazo de regularização. ...
[SEÇÃO] Tabela
Tabela Contexto para a tabela (comparação, análise...) Coluna 1 Coluna 2 Coluna 3 <linha 1> <linh...
[SEÇÃO] Imagem
Figura n - <Explicação da figura>
[SEÇÃO] Imagem com Passos
Passos Figura n - <Explicação da figura> Passo 1 Texto de exemplo. Passo 2 Texto de exemplo. Pass...
[SEÇÃO] Estrutura de Pastas
Estrutura de Pastas my-app/ ├─ node_modules/ ├─ public/ │ ├─ favicon.ico │ ├─ index.html │ ├─ ...
[SEÇÃO] Bloco de código
Bloco de código Descrição do código #include <stdio.h> int main(){ printf("Hello World!); }
[INTERNO] Citação
Citação - Autor
[INTERNO] Informação
Informação sobre algo
[INTERNO] Sucesso
Sucesso sobre algo
[INTERNO] Aviso
Aviso de algo
[INTERNO] Perigo
Perigo sobre algo
[INTERNO] Imagem
Figura n - Explicação da figura
[INTERNO] Tabela
Tabela Contexto para a tabela (comparação, análise...) Coluna 1 Coluna 2 Coluna 3 <linha 1> <linh...
[SEÇÃO] Contexto de Ambiente
Contexto de Ambiente Ambiente-alvo Objetivo neste ambiente Descrição curta <Produção | Homologaçã...
[SEÇÃO] Rollback
Rollback Procedimentos de rollback depois da alteração. Passo 1 <Texto de exemplo> Passo 2 <Texto...
[SEÇÃO] Validação pós-configuração
Validação pós-configuração <Validação 1> <Validação 2> <Validação 3>
[SEÇÃO] Versão da ferramenta
Versão da ferramenta Nome Versão/Build Descrição curta Responsável (owner) Observações <Ferrament...
[SEÇÃO] Problema/Solução
Problema/Solução Problema Solução <Problema A> <Solução A>