Documentação fornece trilhas de auditoria para o trabalho que foi concluída

# 13: Documento Everything

A importância da documentação boa, sólida simplesmente não pode ser exagerada. Documentação oferece trilhas de auditoria para o trabalho que foi concluída. Ele fornece guias para os futuros administradores de sistema, para que possam ter sobre os sistemas que existia antes deles chegarem. Ele pode fornecer o administrador do sistema e sua gestão com os registros da realização. (Estes podem ser muito úteis na hora de revisão pessoal.) Boa documentação também pode ajudar na solução de problemas.

1. A primeira audiência é o próprio autor. Documentação visando o autor do software torna muito mais fácil para o autor para voltar e depurar problemas em seu próprio código que pode ocorrer anos mais tarde. Quando você olha para trás em sua própria dois ou três anos de trabalho antigo sistema (ou projeto de rede ou de programas, por exemplo), pode ser quase impossível de se lembrar por que você fez algo de uma maneira particular, e não de outra maneira, apesar de ter excelentes razões, ao mesmo tempo. Escrever comentários no seu código. Escreve manuais, mesmo que sejam apenas um par de páginas.

2. A segunda audiência está algures no futuro. As pessoas que manter os sistemas e as aplicações de hoje não vão ser para sempre. E você não pode assumir que qualquer pessoal experiente será em torno de novos mentor. Você deve se preparar para um êxodo maciço de sua equipe experiente. Um sinal popular nas mesas dos muitos administradores de sistema "diz:" Lembre-se, daqui a 100 anos, todas as pessoas de novo! "

3. A audiência terceiro é a gestão. Manter boas notas e documentar o seu trabalho ajuda a demonstrar a gestão que tem sido diligente e mostra que medidas foram tomadas para manter os sistemas de funcionamento e produtividade. Se um sistema não atende os requisitos estabelecidos na documentação, que deve ser fácil descobrir o porquê e para determinar o que deve ser feito para tornar o sistema compatível. Mesmo que a sua gestão não compreendem o valor dos serviços que você fornece para a organização, eles normalmente vão entender o valor quando é apresentado como uma espessa pilha de documentação.

Certifique-se que a documentação é armazenada em papel também. Se o sistema é baixo quando você precisa dos manuais, você não vai ser capaz de chegar até eles. Mantenha-os em pastas, para que possam ser facilmente alterados e atualizados. Depois que a documentação está escrito, não se esqueça de revisá-lo e atualizá-lo em uma base regular. Documentação Bad é pior do que nenhuma. Em uma crise, especialmente se as pessoas mais conhecedoras não estão por perto, a documentação é susceptível de ser seguida na íntegra. Se estiver errado, as coisas podem ir de mal a pior. Uma pergunta comum sobre a preparação de documentação é a que nível técnico deve ser escrito. Uma escola de pensamento diz que a documentação deve ser escrito de forma que qualquer pessoa na organização, de um faxineiro ao CEO, pode segui-lo e, se necessário, apresentará o sistema após uma catástrofe. Afinal de contas, o sistema de pessoal administrativo podem não estar disponíveis no momento, e alguém tem de fazê-lo. Enquanto que é um objetivo nobre, que é um um pouco prático. O estado das mudanças dos sistemas críticos de todo o tempo. Quanto mais detalhe que está incluída no que a documentação, o mais rápido, torna-se fora da data. Para escrever a documentação para que uma pessoa inexperiente poderia trazer de sistemas inteligentes para cima ou para fazer um trabalho crítico sobre os outros em tempo de crise, teria que ser tão detalhado quanto a ser incontrolável. Se a tarefa é editar um arquivo para uma variável de mudança para outro, por um administrador do sistema adequadamente treinados, a documentação só precisa dizer: "Mudança de XYZ em ABC / diretório / arquivo.txt." Para uma pessoa inexperiente inteligente, a documentação seria preciso dizer:

1. Altere o diretório para o diretório / digitando "cd / diretório".

2. Abra o editor de texto vi, digitando "vi arquivo.txt".

3. Move o cursor para a linha 300, digitando "300G".

e assim por diante (em qualquer ambiente operacional é o caso). Cada vez que o número de linha no arquivo alterado, a documentação teria que ser mudado. Várias condições de erro que precisa ser tratado para que a pessoa inexperiente, bem como, por exemplo, se o tipo de terminal ou contagem da linha é errado, o editor vi pode ter dificuldade para lidar com ele. Nesse caso, qual deve ser a pessoa inexperiente fazer? A resposta certa é, portanto, a escrever documentação para que um administrador de sistemas experiente pode utilizá-lo. Não espere que o administrador tenha uma grande experiência em sua loja, apenas a experiência geral. Em um ambiente Windows, alvo um Microsoft Certified Engineer (MSCE). Em ambientes Unix, alvo administradores de sistemas experientes. Se algo acontecer com o actual sistema pessoal administrativo, você pode razoavelmente supor que eles serão substituídos por pessoas experientes. A documentação é muito parecido com um belo pedaço de literatura. Todo mundo quer dizer que eles leram Moby Dick, mas ninguém quer realmente sentar e ler Moby Dick.

# 12: Empregar Service Level Agreements

# 11: Plan Ahead

um artigo submetido por Ben Smeider

Isenção de responsabilidade:O nosso site não se responsabiliza pelo conteúdo deste artigo. Webarticles é uma fonte de informação livre.
Importante: Este artigo "Documentação oferece trilhas de auditoria para o trabalho que foi concluída" foi traduzida por um software automático. Nós sentimos muito por quaisquer erros de ortografia que pode ter ocorrido. Obrigado pela sua compreensão.