Ter a documentação em dia

Como praticante e defensor do Agile e Lean, eu sou um crente forte em fazer as coisas por um motivo, e somente aquelas coisas que acrescentam valor. Assim, quando se trata de documentação, muitos básicas de exposição para Agile, pode pensar-se que a metodologia significa que a documentação do projeto não é criado.

Em vez disso, ele deve ser mais sobre a criação de significado planos e se isso significa que a documentação, então, também deve adicionar valor e ser a quantidade adequada. Eu não acredito na produção de documentação (a menos que o contrato exige especificamente determinados documentos) para fins de documentação.

Enquanto muitos técnicos indivíduos recusam o pensamento e a menção de documentação, eu, pessoalmente, veja alguns benefícios reais. Abaixo está o meu top pensamentos sobre a documentação determinar o Que os Outros Precisam Saber pensar em todos os aspectos do projeto, implementação e posterior lançamento de apoio e de manutenção para determinar o que esses dentro da equipa de projecto e auxiliares equipes pode precisar.

Os documentos

Se a equipe de implementação, não é a equipe de apoio do projeto, certamente haverá necessidade de algum grau de documentação. Cuidadosamente analisar e consultar os outros sobre o que eles podem precisar de te assegurar que o seu tempo é bem gasto.

Uma vez que você tem uma alça sobre o conteúdo e o tipo de documentação necessária, você pode olhar para o público-alvo do material. Não é necessário ser construída em um banco de página da web, como uma página Wiki ou algo mais formal? O estilo de escrita e método de entrega deve ser com base no público-alvo, que por sua vez é determinado pelo conteúdo do material.

Esta é a parte mais difícil. Manter a corrente com documentação requer um arregimentada processo. Dentro do nosso cronograma do projeto devemos plano contínuo de atualizações de documentação e garantir que nós tomamos o tempo para estes pontos de verificação. Uma vez que você entrar em um ritmo com documentação, trabalhar duro para mantê-lo ir. Reiniciar este comportamento e atividade após um período de inatividade pode ser um desafio e difícil de recuperar.

Benefícios

Enquanto os três primeiros pontos de foco em fornecer a documentação para apoiar um projeto, ou comunicação com os outros, o processo de documentação é muito mais um exercício de planejamento. Apenas passando por um processo de documentação requer o nosso cérebro esquerdo, analítico chapéu e pensando em todos os aspectos. Isso, em si, pode ser muito útil.

Eu sugiro a identificação das principais incógnitas, e áreas de alto risco e determinar documentação de tarefas para selecionar partes. Isso pode ser útil para se obter a análise passou. A documentação é uma forma de comunicação. Tomar boas decisões sobre o que, para o documento, o método, o estilo e o processo referente a documentação é importante. Todas as tarefas dentro de nossos projetos requer uma análise cuidadosa e a documentação não é diferente. Para ser eficaz, você deve ter um objetivo específico e público-alvo para o material.

Comments are Disabled