Navegar na base
PADRÃOPD-DOC-001v1.4atualizado
Como documentar
Estrutura mínima e estilo de escrita para qualquer documento técnico da base G&A — claro, versionado e reutilizável.
- RESPONSÁVEL
- Autor do doc
- PÚBLICO
- Time técnico
- REVISÃO
- Semestral
- STATUS
- Vigente
Objetivo
Garantir que qualquer pessoa consiga entender, executar e manter um procedimento sem depender do autor. Documento é ativo operacional, não formalidade.
Estrutura mínima
- Cabeçalho — ID, versão, autor, data, criticidade, responsável, status e tags.
- Objetivo — Uma frase: o que o documento resolve e para quem.
- Pré-requisitos — Ambiente, acessos, ferramentas e dependências.
- Procedimento — Passos numerados, verificáveis, com comandos quando houver.
- Validação & rollback — Como confirmar sucesso e como reverter.
- Referências — Links, tickets e documentos relacionados.
Princípios de escrita
- Voz ativa
- Frases curtas
- Um passo por linha
- Comando + resultado esperado
- Sem ambiguidade
- Benefício antes do detalhe