Modelos de Documetação para a Prática

A documentação da infraestrutura de uma rede é uma boa prática e contribui para melhorar o gerenciamento da rede e para que os profissionais sejam mais produtivos. O ideal seria que ela fosse elaborada e atualizada automaticamente por alguma ferramenta. Caso isto não seja possível, uma documentação básica inicial deverá ser feita, e aos poucos ela deverá ser incrementada, até atender as necessidades em sua totalidade.

Uma boa sugestão de ferramenta para documentação é o wiki (“software colaborativo que permite a edição coletiva dos documentos usando um sistema que não necessita que o conteúdo tenha que ser revisto antes da sua publicação”). Ele é um software voltado a web, possui histórico de tudo que é alterado e várias outras vantagens. Mas existem várias outras ferramentas que podem ser usadas em uma documentação. A escolha vai do gosto e da necessidade de cada um.

Toda a documentação do projeto deverá ser feita no Dokuwiki instalado na rede de cada sede. Apenas o relatório Técnico é que deverá ser feito seguindo o modelo disponibilizado ao final desta página.Todo modelo de documentação apresentado aqui é somente uma referência para a confecção dos documentos necessários ao Projeto, podendo sofrer alterações durante o decorrer do mesmo.

Estrutura básica do Dokuwiki

A organização do conteúdo disponibilizado no Dokuwiki é de responsabilidade de cada grupo. A organização apresentada abaixo é o mínimo que cada grupo deve ter de documentação.

  1. A Empresa
  2. Estrutura da rede (DMZ e Lan)
    1. Diagrama da Rede (Topologia)
    2. Plano de numeração IP
    3. Nomenclatura dos servidores
  3. Documentação dos servidores (detalhada a seguir)
  4. Documentação dos serviços (detalhada a seguir)
  5. Prestadores de serviços
  6. Políticas e procedimentos
  7. Referências

Documento do Servidor

  • Dados do Servidor
    • Nome do servidor
    • IP
    • Finalidade
    • S.O. instalado
  • Informações de hardware do servidor
  • Serviços instalados
  • Estratégia de Particionamento do Disco
  • Documentação da instalação

Documento dos Serviços

  • Dados do Serviço
    • Nome do serviço
    • Finalidade do serviço
    • Versão do serviço
  • Lista de dependências
  • Roteiro seguido durante a instalação
  • Configurações realizadas para o correto funcionamento do serviço
  • Extrato dos arquivos de configuração

Relatório Técnico

O relatório técnico deverá ser escrito seguindo o formato de artigo completo disponibilizado pela SBC. Clique Aqui e obtenha o arquivo contendo o modelo para MS Office, OpenOffice e Latex. A seguir uma proposta de tópicos que devem constar no artigo:

  1. Resumo
  2. Introdução
  3. A Empresa Redes Asa
  4. Serviços Oferecidos
  5. A Infraestrutura de Rede
  6. A Implantação da Rede
  7. Conclusão
  8. Referências
ensino/semestres/2011.2/soredes/pratica/modelos/inicio.txt · Última modificação: 2011/08/22 20:08 (edição externa)