1.2. Documentar Tudo

Se tivesse a opção de instalar um servidor novinho ou escrever um documento de procedimentos sobre a execução de backups do sistema, o administrador de sistemas mediano instalaria o servidor novo toda vez. Apesar disso ser bastante comum, você deve documentar o que faz. Muitos administradores de sistemas deixam de documentar seus procedimentos por diversas razões:

"Mais tarde eu faço."

Infelizmente, isto não é verdade na maioria das vezes. Mesmo se o administrador de sistemas não estiver brincando, a natureza do trabalho faz com que as atividades do cotidiano tornem-se muito caóticas para "fazer mais tarde." Pior ainda, quanto mais a tarefa é adiada, mais é esquecida, levando à produção de um documento menos detalhado (e portanto menos útil).

"Por quê anotar? Eu vou lembrar."

A não ser que você seja uma daquelas pessoas com memória fotográfica, você não lembrará. Ou pior, lembrará somente metade, sem perceber que está esquecendo a história toda. Isto acarreta em tempo perdido na tentativa de re-aprender o que você esqueceu ou consertar o que você quebrou devido a seu entendimento incompleto da situação.

"Seu eu manter na minha mente, eles não poderão me despedir — terei estabilidade no emprego!"

Apesar disto poder funcionar por um tempo, invariavelmente acarreta em menor — e não maior — estabilidade de emprego. Por um momento, pense no que pode ocorrer durante uma emergência. Você pode não estar disponível; sua documentação pode salvar o dia se instruir alguém a resolver o problema durante sua ausência. E lembre-se que as emergências tendem a ocorrer com mais frequência quando a alta gerência presta atenção. Nestes casos, é melhor sua documentação ser parte da solução do que sua ausência ser parte do problema.

Além disso, se você faz parte de uma pequena empresa em expansão, pode surgir a necessidade de outro administrador de sistemas. Como esta pessoa pode aprender a te cobrir se está tudo na sua cabeça? Pior ainda, sem documentação, você pode ser tão indispensável a ponto de não poder avançar na sua carreira. Você pode acabar trabalhando para aquela pessoa que contratou para ajudá-lo.

Esperamos que agora você esteja convencido dos benefícios da documentação de sistemas. Isto nos leva à questão seguinte: O quê você deve documentar? Aqui está uma lista parcial:

Normas

As normas são elaboradas para formalizar e clarificar sua relação com a comunidade de usuários. Elas explicam aos seus usuários como você lida com seus pedidos de recursos e/ou assistência. A natureza, o estilo e o método de disseminação das normas para sua comunidade variam de empresa a empresa.

Procedimentos

Os procedimentos são qualquer sequência passo-a-passo das ações para realizar uma determinada tarefa. Os procedimentos a serem documentados podem incluir procedimentos de backup, procedimentos para administração de contas de usuários, procedimentos para relatório de problemas e assim por diante. Como na automação, se um procedimento é seguido mais de uma vez, é uma boa idéia documentá-lo.

Alterações

Uma grande parte da carreira de um administrador de sistemas é dedicada às alterações — configurar sistemas para o máximo desempenho, ajustar scripts, modificar arquivos de configuração e assim por diante. Todas estas alterações devem ser documentadas de alguma forma. Caso contrário, você pode encontrar-se numa situação muito confusa devido uma alteração feita há vários meses.

Algumas empresas utilizam métodos mais complexos para registrar as alterações, mas, muitas vezes, basta apenas ter uma revisão da história no início do arquivo sendo modificado. Cada entrada da história revisada deve conter, no mínimo:

  • O nome ou as iniciais da pessoa efetuando a alteração

  • A data da alteração

  • A razão da alteração

Isso resulta em entradas concisas, porém úteis:

ECB, 12-Junho-2002 — Item atualizado para a nova impressora de Contabilidade (para suportar a substituição da habilidade em imprimir duplex)