Alguns leitores pediram se eu poderia disponibilizar modelo de documentação para que pudessem utilizar como ponto de partida. Disponibilizo abaixo um template que pode ser utilizado, mas note que é um modelo simples (elaborado num editor de texto) e sem grandes pretensões.

Download: Modelo Documentação da Infra de Rede (formato OpenOffice)

Download: Modelo Documentação da Infra de Rede (PDF)

Se alguém quiser melhorar o documento e me enviar as alterações fique a vontade.

Na empresa onde trabalho utilizo um conjunto de ferramentas para gerenciar as informações da rede:

• OCS-NG (para inventário de hardware… semelhante ao CACIC)
• Wiki (Trac)
• Nagios
• Cacti
• GLPI (para registro dos chamados do helpdesk)

O ideal seria utilizar uma ferramenta open source que automaticamente fizesse o mapeamento da rede e dos servidores mantendo essas informações sempre atualizadas.

Caso alguém conheça uma ferramenta assim, por favor me avise 

O ideal seria que a documentação fosse elaborada e atualizada automaticamente por alguma ferramenta. Caso isto não seja possível, inicie com uma documentação básica e vá incrementando até atender as suas necessidades.

No meu trabalho iniciei a documentação utilizando Openoffice e o software Dia para criar os diagramas (caso você conheça um Software Livre mais apropriado para desenho dos diagramas de topologia, favor compartilhe nos comentários).

Com o crescimento da rede o modelo de documentação inicial mostrou-se inviável. Procurei ferramentas mais adequadas e optei por implantar um wiki como respositório de documentação da rede e defini que cada membro da equipe DEVE registrar todas as alterações realizadas. Um wiki facilita a tarefa de realizar uma modificação e torná-la imediatamente disponível para toda a equipe.

Existem inúmeras ferramentas de wiki… Optei por utilizar o Trac, que possui um wiki básico integrado, recursos como controle de mudanças em projetos de desenvolvimento de software e também funciona como um brower do repositório Subversion.

O que documentar?
Não é simples elaborar e, principalmente, manter atualizada a documentação da rede. Os itens que compõe a documentação variam muito de acordo com a complexidade do ambiente de  rede e da metodologia de trabalho adotada.

A seguir sugestão de um modelo de documentação de rede contendo uma lista mínima de itens que, em minha opinião, deveriam constar em uma boa documentação de rede:

Além do wiki, agregamos informações da infra nos softwares de monitoramento Nagios e Cacti. No Nagios, todos os servidores são monitorados e para cada servidor foi adicionado link apontando para a sua respectiva página de documentação no wiki.

Não esqueça de definir uma Política de Atualização da documentação para que esta não se torne desatualizada e inútil. Liste quem são os responsáveis pela atualização, periodicidade mínima de revisão e padrões que devem ser utilizados.

Em caso de falhas em serviços críticos, as informações de configuração contidas no repositório podem ajudar a minimizar o tempo de recuperação destes serviços.

Conscientize sua equipe sobre a importância da documentação e com o passar do tempo o wiki da rede se tornará um verdadeiro repositório de informações sobre o ambiente de TI.

Caso algum profissional deixe a empresa o conhecimento acumulado estará registrado nessa base de conhecimento e a tarefa de treinar um novo profissional será bem mais fácil, economizando tempo e dinheiro.

E você? utiliza quais ferramentas e metodologias para manter a documentação da sua rede?

Sua sugestão é bem vinda!

UPDATE: Publiquei um novo artigo onde disponibilizo para download um modelo de documentação de Infra de Rede.

]]> http://www.silvio.me/documentacao-da-infra-de-rede/feed/ 8