
Documentação de TI: o que registar antes de alguém sair
A documentação de TI é o trabalho que espera até ser tarde demais. Enquanto o seu técnico de TI está presente, basta perguntar; no dia em que está doente, de férias ou já saiu, descobre o que só existia na cabeça dele. Aqui fica o que deve constar, onde deve estar e quem a mantém atual.
O verdadeiro risco não é a demissão, é a ausência que ninguém anuncia. Alguém mais conseguiria amanhã entrar na firewall, renovar o domínio e restaurar uma cópia de segurança?
Uma boa documentação de TI não é um manual, é um conjunto fixo de partes: diagrama de rede, plano de IP, direitos de administrador, um cofre de palavras-passe, licenças, fornecedores, cópias de segurança e procedimentos.
Não está no sistema que descreve, tem um responsável e só está concluída quando outra pessoa executou uma tarefa a partir dela.
A dependência de um único técnico de TI
O fator autocarro é o número de pessoas que têm de desaparecer para algo deixar de funcionar. Em muitas pequenas e médias organizações é exatamente um para a TI: um colaborador que sabe como a rede se liga, onde estão as palavras-passe de administrador e que registador detém o domínio.
O momento perigoso raramente é a saída anunciada. Um pré-aviso dá-lhe semanas para a passagem de testemunho. O que dói é a ausência que ninguém vê chegar: doença, um acidente, umas férias sem rede no dia em que a firewall recusa uma atualização.
Por isso um bom teste para a administração não é uma pergunta sobre documentação, mas sobre hoje: se o nosso técnico de TI estiver incontactável nas próximas duas semanas, quem consegue recuperar uma conta de administrador, renovar um certificado e restaurar uma pasta apagada? Se a resposta for «ninguém» ou «não sei», é esse o mandato.
O que deve constar da documentação de TI
A documentação de TI não precisa de ser um manual volumoso. É um conjunto fixo de partes, cada uma tão curta quanto possível sem obrigar ninguém a adivinhar.
- Diagrama de rede. Que locais, que ligações, onde estão a firewall, os switches e os pontos de acesso e como se ligam. Um esboço etiquetado chega, desde que esteja certo.
- Plano de IP. Que gamas e VLAN existem, o que tem endereço fixo (impressoras, servidores, câmaras) e onde corre o DHCP. Sem ele, redescobre o plano observando equipamentos a cair.
- Contas e direitos de administrador. Quem tem que função de administrador no Microsoft 365, na firewall, no registador de domínios e na plataforma de cópias de segurança. Incluindo as contas que não pertencem a nenhuma pessoa.
- Licenças e contratos. O que utiliza, em nome de quem, quando expira e qual o pré-aviso. Remeta aqui para o seu inventário de ativos de TI em vez de manter uma segunda cópia.
- Fornecedores e contactos. Internet, telefonia, impressoras, software, manutenção da sala de servidores: a quem ligar, com que número de cliente e o que o contrato cobre.
- Configuração das cópias de segurança e teste de restauração. O que é copiado, com que frequência, para onde, por quanto tempo é guardado e quando foi a última restauração.
- Procedimentos. As tarefas que surgem raramente, pelo que ninguém as sabe de cor: preparar um novo colaborador, encerrar a conta de quem sai, renovar o domínio, substituir um certificado, arrancar depois de um corte de energia.
As palavras-passe pertencem a um cofre, não a uma folha de cálculo
A folha de cálculo de palavras-passe é a forma mais comum de documentação de TI e a pior. Quem abre o ficheiro tem tudo, não se vê quem o consultou e a cópia no ambiente de trabalho de alguém está desatualizada há meses.
Um cofre de palavras-passe resolve três coisas de uma vez. Partilha-se por cofre em vez de tudo ou nada, vê-se quem abriu o quê e, quando alguém sai, revoga-se o acesso sem ter de mudar todas as palavras-passe nessa mesma tarde. Se tem a gestão de identidades e acessos em mente, veja também IAM.
Duas armadilhas que vemos com frequência. A primeira é a conta de administrador em nome do próprio técnico de TI, com a autenticação multifator no telemóvel pessoal: o acesso sai com o telemóvel. A segunda é a falta de uma conta de emergência: uma conta de administrador não ligada a nenhuma pessoa, com uma palavra-passe longa guardada em dois locais seguros, cuja utilização é detetada.
Uma cópia de segurança sem teste de restauração é uma suposição
Quase toda a gente sabe que uma cópia de segurança está a correr. O que raramente está escrito é a parte de que precisa no dia em que corre mal: onde está a cópia, quem tem acesso e como se recupera um ficheiro, uma caixa de correio ou um servidor inteiro.
Por isso registe o teste de restauração, não apenas a cópia. A data, o que foi restaurado, quanto tempo demorou e o que não correu como previsto. Um estado «bem-sucedido» na plataforma de cópias diz-lhe que algo foi escrito, não que se consegue ler de volta.
É também o que os referenciais pedem. A NIS2 refere a gestão de cópias de segurança e a gestão de ativos entre as suas medidas, e a ISO/IEC 27001 espera procedimentos operacionais documentados. Se o escreve para si, tem-no também para o auditor.
Onde guardar: não no sistema que descreve
O erro mais comum é também o mais lógico: a documentação está no servidor de ficheiros ou no SharePoint. Até o servidor de ficheiros ser cifrado ou a conta Microsoft 365 não abrir. Então o guia de recuperação fica trancado atrás daquilo mesmo que precisa de ser recuperado.
- Guarde uma cópia fora do próprio ambiente, por exemplo no cofre de palavras-passe, que funciona como serviço separado dos seus sistemas, ou junto de uma segunda entidade.
- Garanta que pelo menos duas pessoas lhe conseguem aceder, uma das quais não é o técnico de TI. Muitas vezes é um administrador, que não precisa de a compreender mas precisa de a conseguir abrir.
- Guarde também o essencial offline: a conta de emergência, o número de suporte do operador de internet, os passos para abrir o próprio cofre. Um envelope num cofre-forte é antiquado e funciona.
Quem a mantém atual e como sabe que está certa
Documentação escrita uma vez está desatualizada em menos de um ano. O que funciona não é uma grande limpeza, é um hábito: uma alteração só está concluída quando a documentação está atualizada. Novo switch, novo fornecedor, nova conta de administrador: o pedido só fecha quando está no plano.
Dê-lhe um responsável. Normalmente é o técnico de TI, mas a administração deve sabê-lo e perguntar uma vez por trimestre quando foi verificada pela última vez.
O verdadeiro teste é fazer, não ler. Peça a outra pessoa que execute um procedimento apenas com a documentação na mão: criar um utilizador, restaurar um ficheiro. Onde ficar parada, falta uma linha. Um exercício destes por ano diz-lhe mais do que um documento que parece completo.
Nas semanas antes de alguém sair
Quando a pessoa que sustentava a TI vai sair, o pré-aviso é a última oportunidade para passar para o papel o que está na sua cabeça. Use essas semanas para a passagem de testemunho, não para concluir projetos.
- Faça o sucessor executar o trabalho enquanto quem sai observa, e não o contrário. O que quem sai demonstra parece claro; o que o sucessor tem de fazer sozinho mostra o que falta.
- Transfira todas as contas em seu nome: o registador, os portais de fornecedores, as contas das lojas de aplicações, a autenticação multifator. É diferente de encerrar a própria conta da pessoa, que vem depois.
- Pergunte pelo que não está escrito em lado nenhum: a tarefa anual, a impressora que só funciona depois de reiniciada, o fornecedor a quem é preciso telefonar em vez de escrever.
Se não há ninguém a quem passar, é o momento de decidir se o conhecimento regressa a um novo colaborador ou a uma equipa.
Onde termina o nosso trabalho
O que fazemos. Num ambiente que gerimos, escrevemos e mantemos a documentação de TI como parte do trabalho: diagrama de rede, plano de IP, direitos, fornecedores, cópias de segurança e procedimentos. Quando assumimos um ambiente, começamos por mapear o que existe e, a partir daí, a dependência de uma pessoa passa a ser uma equipa.
A documentação e o cofre são seus, não nossos. Estão no seu ambiente ou num cofre de que é titular, com acesso para alguém da sua própria organização. Um prestador de serviços geridos que seja o único a ter as palavras-passe é a dependência de uma pessoa com outro casaco.
O que não fazemos. Não escrevemos processos de negócio fora da TI nem um manual de qualidade para toda a organização. Não revemos contratos do ponto de vista jurídico: registamos o que está em funcionamento e quando termina, mas o que uma cláusula significa compete a um advogado. E não certificamos ninguém: se a documentação cumpre a ISO/IEC 27001 decide-o o organismo de certificação.
Perguntas que recebemos sobre este tema
As cinco que mais surgem.
O que deve incluir a documentação de TI?
No mínimo um diagrama de rede, um plano de IP, uma lista de contas e direitos de administrador, um cofre de palavras-passe, licenças e contratos com as datas de fim, fornecedores com contactos, a configuração das cópias de segurança com o último teste de restauração e procedimentos para as tarefas que raramente surgem. Curto serve, desde que ninguém tenha de adivinhar.
Onde deve ser guardada a documentação de TI?
Não no sistema que descreve. Se o guia de recuperação está no servidor de ficheiros que acabou de ser cifrado, não lhe serve de nada. Guarde uma cópia fora do seu próprio ambiente, garanta que duas pessoas lhe conseguem aceder e guarde também offline a conta de emergência e os passos para abrir o cofre.
As palavras-passe devem constar da documentação?
Não num documento nem numa folha de cálculo. As palavras-passe pertencem a um cofre de palavras-passe, onde se partilha por secção, se vê quem abriu o quê e se pode revogar o acesso. A documentação remete para o cofre; não contém as palavras-passe.
Com que frequência se deve atualizar a documentação de TI?
A cada alteração, como parte fixa dessa alteração, mais uma verificação curta por trimestre. O melhor teste é pedir a outra pessoa que execute um procedimento uma vez por ano, usando apenas a documentação.
Escrevem a nossa documentação de TI e de quem é?
Num ambiente que gerimos, escrevemos e mantemos a documentação. Continua a ser sua: está no seu ambiente ou num cofre de que é titular. Não escrevemos processos de negócio fora da TI, não revemos contratos do ponto de vista jurídico e não certificamos ninguém.
Onde isto se enquadra connosco
As partes que se juntam na sua documentação.
Vemos quão grande é a sua dependência de uma pessoa?
Diga-nos como a TI é gerida hoje e quem sabe o quê. Mostramos que partes da documentação existem, quais faltam e o que tem de vir primeiro se o seu único técnico de TI estiver incontactável amanhã.
Conhecimento prático de TI na sua caixa de correio
Novos guias sobre gestão, segurança e postos de trabalho, escritos por quem faz o trabalho. Sem conversa comercial, e pode cancelar a subscrição com um clique.