Capítulo 27 — Documentação e passagem de trabalho
Mapa da aula
Aula 27 publicada. Mapa, exemplo, EX079.
flowchart TD
N0["27.1 O que documentar"]
N1["27.2 Praticando a passagem"]
N2["27.3 Reduzindo a dependência"]
N3["27.4 Mantendo a documentação viva"]
N0 --> N1 --> N2 --> N3
N3 --> EX["Exemplo resolvido"]
EX --> Q["Exercício EX079"]
Desenho lógico
flowchart LR
N0["27.1 O que documentar"]
N1["27.2 Praticando a passagem"]
N2["27.3 Reduzindo a dependência"]
N3["27.4 Mantendo a documentação viva"]
N0 --> N1 --> N2 --> N3 --> Q["EX079"]
[27.1 O que documentar]
|
v
[27.2 Praticando a passagem]
|
v
[27.3 Reduzindo a dependência]
|
v
[27.4 Mantendo a documentação viva]
|
v
[Exemplo resolvido] --> [Exercício EX079]
Objetivos de aprendizagem
Você vai (1) documentar o trabalho técnico de governança; (2) preparar a passagem de trabalho para colegas; (3) reduzir a dependência de pessoas específicas.
27.1 O que documentar
Ravi lista o que outras pessoas precisariam se ele saísse: o repositório com scripts e testes, a biblioteca de verificações com seus propósitos, a agenda, os procedimentos, o dicionário, as notas de linhagem, os painéis e seus donos, e os problemas conhecidos. Ele escreve uma página de visão geral com links para cada item. A Sra. Moreau explica que a documentação é um controle de governança, porque as organizações dependem de trabalho técnico que ninguém consegue manter se só uma pessoa o entende. A Sra. Okonjo pede que ele apresente a visão geral a toda a equipe de dados.
27.2 Praticando a passagem
Para testar a documentação, Ravi tira uma semana de folga enquanto uma colega de turma, também estagiando na Calder Valley, cobre seu trabalho usando apenas a documentação. Ela dá conta da maioria das tarefas, mas tem dificuldade com um arquivo retido de prestadora, porque o procedimento não explica como liberar o arquivo depois que a prestadora o reenvia. Ravi acrescenta os passos que faltavam quando volta. Ele observa que testes reais de passagem revelam lacunas que a autorrevisão deixa escapar. A colega também sugere um índice das tarefas mais comuns, que ele acrescenta à página de visão geral.
27.3 Reduzindo a dependência
Ravi faz dupla com um colega nas tarefas mensais, como as execuções de descarte e as revisões de acesso, para que duas pessoas saibam fazer cada uma. Também grava vídeos curtos de tela mostrando os passos mais complexos. A Sra. Okonjo inclui as tarefas técnicas de governança na matriz de competências da equipe, para acompanhar quem sabe fazer o quê. Ele observa que depender de uma só pessoa é um risco que a governança deve gerenciar, como qualquer outro risco aos dados. Ao fim do estágio, toda tarefa mensal tem pelo menos duas pessoas capazes de executá-la sem ajuda.
27.4 Mantendo a documentação viva
A documentação se deteriora à medida que os sistemas mudam. Ravi liga cada documento aos scripts ou processos que ele descreve e acrescenta a cada mudança um lembrete para atualizar a documentação. Ele agenda uma revisão trimestral em que a equipe confere uma amostra de documentos com a realidade. A Sra. Moreau observa que atualizações pequenas e regulares mantêm a documentação útil, enquanto grandes reescritas acontecem raramente e deixam os documentos desatualizados por longos períodos. A primeira revisão trimestral encontra três documentos que precisam de pequenas mudanças, feitas na mesma semana.
Exemplo resolvido
Ravi documenta seu trabalho com uma página de visão geral, testa-a com uma semana de passagem que expõe um passo de liberação ausente, faz dupla nas tarefas mensais e mantém a documentação atualizada com lembretes a cada mudança e revisões trimestrais.
Caso sintético. A documentação é sintética.
Erros e limites
Documentação não testada esconde lacunas até alguém precisar dela com urgência.
Exercícios
- EX079 — Lacuna na passagem. Que lacuna a passagem de trabalho revelou? Rubrica: 3 = como liberar um arquivo retido depois do reenvio;; 2 = parcialmente correto;; 1 = vago;; 0 = nenhuma.
- EX080 — Acompanhamento de competências. Como a Sra. Okonjo acompanha quem sabe fazer cada tarefa? Rubrica: 3 = com uma matriz de competências;; 2 = parcialmente correto;; 1 = vago;; 0 = nenhuma.
- EX081 — Revisão da documentação. Com que frequência uma amostra de documentos é conferida? Rubrica: 3 = a cada trimestre;; 2 = parcialmente correto;; 1 = errado;; 0 = nenhuma.
Continue estudando — aula 27 (capítulo 27 de 30)
← Capítulo 26 · Índice das aulas · Capítulo 28 →
Continue para a próxima aula já escrita.