Documentar: tire o conhecimento da cabeça de poucos
Para a equipe que diz:
“Dependemos de poucas pessoas que sabem como isto funciona.”
Levanto e documento um ambiente ou fluxo de trabalho junto com as pessoas que o operam, para que o conhecimento concentrado em poucas cabeças vire material que toda a equipe consegue ler, conferir e manter.
Como o trabalho é feito
A documentação é construída a partir do próprio ambiente e de quem o opera: configurações, material existente, demonstrações guiadas e sessões de trabalho. Os responsáveis técnicos da sua equipe revisam o conteúdo à medida que ele é escrito, para que reflita a realidade, e não a intenção original do projeto.
Antes de começar, a proposta define quantos documentos serão produzidos, com que nível de detalhe, e quais materiais e acessos ficam por sua conta. Isso mantém o esforço sob controle e o resultado previsível.
O que você recebe
- Diagramas de arquitetura e de dependências do estado atual.
- Um inventário ou mapa de informações do ambiente escolhido.
- Procedimentos operacionais (runbooks) selecionados, escritos para quem vai executá-los.
- Uma matriz de responsabilidades e escalonamento: quem responde por quê e quem é acionado quando algo falha.
- Uma lista de lacunas para a equipe resolver, mantida à vista em vez de escondida.
Quando faz sentido
- De forma avulsa, quando o conhecimento está concentrado em poucas pessoas.
- Para apoiar a chegada de novos engenheiros ou de um novo parceiro de operação.
- Para preparar uma migração, de modo que a mudança parta de um retrato fiel do ambiente.
- Depois de uma avaliação, para transformar os achados em documentação que a equipe mantém.
O que não faz parte
- A documentação nunca é apresentada como completa quando faltam acesso ou evidências. As lacunas ficam listadas, com responsável sempre que houver.
- Não é um inventário completo dos ativos da empresa, a menos que esse seja o escopo combinado.
- Não substitui suas ferramentas de documentação ou de gestão de configuração; fornece a elas um conteúdo confiável.
Critério de aceite
A documentação é aceita quando os artefatos combinados foram revisados pelos responsáveis indicados e deixam claras as lacunas que permanecem.
Contratação avulsa ou combinada
A documentação pode ser contratada de forma avulsa ou entrar como módulo do Sprint de Mapeamento da Infraestrutura ou de uma Parceria de Modernização. Combina naturalmente com Capacitar: os novos procedimentos viram o material da sessão com a equipe.
O que dizem sobre o meu trabalho
O Rodolfo fez um trabalho extraordinário ao criar a Biblioteca Técnica da Riverstone. A base de conhecimento que ele criou se tornou o repositório central de toda a documentação técnica da Riverstone (pública e confidencial), permitindo não apenas que toda a empresa encontrasse com facilidade qualquer documento técnico, mas também introduzindo uma cultura de documentar tudo e deixar disponível para todos.
Ver o original
Rodolfo did a tremendous job creating the Technical Library at Riverstone. The knowledge base created by him became the central repository for all technical documentation inside Riverstone (both public and confidential), not only allowing the whole organization to easily find any technical document, but also introducing a culture of documenting everything to make it available to everyone.
Rodolfo é um profissional muito atento e responsável no desenvolvimento e implementação dos seus projetos. Extremamente técnico, além de uma exemplar habilidade de escrever documentos.