Resposta curta
Documentação técnica avalia se o conhecimento registrado permite ao público certo operar, manter ou alterar um sistema.
Sobre Documentação técnica
Capacidade de registrar conhecimento técnico com clareza suficiente para que o público pretendido opere, mantenha ou altere um sistema.
Use esta competência para
- Papéis que criam decisões, interfaces, procedimentos ou sistemas usados por outras pessoas.
- Functions em que conhecimento ausente ou desatualizado gera dúvidas repetidas ou mudanças inseguras.
Não use esta competência para
- Trabalho que não produz conhecimento técnico necessário para outra pessoa usar ou manter.
Diferenças importantes
Comunicação
Comunicação cobre troca de informação no momento certo. Documentação técnica preserva conhecimento para uma tarefa definida.
Design de sistemas
Design de sistemas toma decisões estruturais. Documentação técnica mantém o contexto e as instruções para usar essas decisões.
Expectativas por nível
IC1
Contribuidor individual 1
Atualiza com orientação uma documentação de escopo definido para que outra pessoa siga o procedimento atual ou entenda a mudança.
Comportamentos observáveis
- Atualiza o documento junto com o comportamento afetado.
- Usa o formato existente e aponta para o artefato relevante.
- Executa as instruções uma vez para encontrar passos ausentes.
Exemplos
- Atualizou a configuração inicial depois de incluir uma variável obrigatória.
- Corrigiu um comando do guia operacional e o verificou fora de produção.
IC2
Contribuidor individual 2
Cria e mantém com autonomia a documentação de um sistema do time, resolvendo lacunas para leitores com contextos diferentes.
Comportamentos observáveis
- Define leitor, tarefa, pré-requisitos e resultado esperado.
- Registra decisões, alternativas e consequências.
- Remove ou sinaliza orientação antiga quando o comportamento muda.
Exemplos
- Escreveu um guia que permitiu tratar uma falha conhecida sem escalonamento.
- Documentou uma mudança de interface para consumidores atuais e em migração.
IC3
Contribuidor individual 3
Define práticas de documentação entre times para sistemas compartilhados e torna donos e atualização visíveis sem ser a única pessoa autora.
Comportamentos observáveis
- Define o mínimo necessário para limites técnicos compartilhados.
- Atribui donos e gatilhos de revisão a documentos críticos.
- Usa dúvidas recorrentes para melhorar o padrão.
Exemplos
- Criou um formato de registro de decisões adotado pelos times de uma plataforma.
- Incluiu revisão periódica nos guias de recuperação depois que passos antigos atrasaram exercícios.