Fala pessoal, tudo bem?
Sou o
Andreson Brito e estou aqui finalizando esse post da semana.
Hoje gostaria de falar sobre a documentação do projeto. Assim, logo de cara eu já deixo um conselho: Comece cedo!
Quando falamos de um projeto de software, a maioria das pessoas lembra de coisas como: "
quais tecnologias vamos utilizar?" ou "
como vamos construir o banco de dados?", porém, com o passar do tempo, fica difícil responder de cabeça algumas perguntas: "
Quem está documentando isso tudo? Porque optamos pela estratégia 'A' e não pela estratégia 'B'? De onde tiramos essa informação (fontes) ?". Se a documentação não for construída desde o inicio acompanhando a evolução do desenvolvimento, fica difícil de responder, né?
Pois é galera, e quando falamos de documentar tudo, é para REALMENTE DOCUMENTAR TUDO! Lembre-se que num projeto, além dos itens "standard", como os citados anteriormente, existem muito mais coisas que precisam ser documentadas, como:
- Qual foi a motivação do projeto?
- Quantas vezes o time se reuniu para discutir o projeto?
- Nas vezes em que o grupo se reuniu, o que foi decidido?
- Como foi feita a divisão de tarefas entre os membros do time?
- O que planejamos fazer?
- Onde acertamos mais?
- Onde falhamos mais?
- O que ainda precisa ser revisto?
- Quantas vezes o projeto foi revisto e o que mudou após cada revisão?
- Muitos outros itens que não foram lembrados ao descrever essa lista...
Então, meu caro leitor, deu para perceber que a documentação vai muito além do que é "pedido", mas é algo que serve é um material que serve para o grupo consumir e tomar decisões.
USE A DOCUMENTAÇÃO A SEU FAVOR!!!
A gente sabe que nem tudo são flores, e que a gente acaba tendo que reescrever muita coisa (cansei de reescrever se seções inteiras por mudanças na estratégia de desenvolvimento ¬¬"). Isso da trabalho, mas você passa perceber a evolução do trabalho e ao mesmo tempo que você desenvolve os textos, você pensa em melhores soluções de desenvolvimento e vai retroalimentando todo o time.
OUTRA DICA: REVISE TUDO! E GARANTA QUE TODOS REVISEM!
Tudo bem dividir as tarefas e, inevitavelmente, alguém vai focar mais na documentação, mas isso não é desculpa para que as pessoas "larguem" as coisas para que alguém faça. Todos devem ler, entender, criticar e revisar o que está escrito, afinal, os professores não darão uma nota por parágrafo que cada um escreveu, não é mesmo?
E não deixe para revisar na última hora, vá validando o documento a medida que ele é produzido. Acredite em mim, isso vai ajudar a reduzir muuuuuuuito o estresse da entrega.
Isso ai galera, aqui chegamos ao fim. Espero que você tenha tido uma boa e divertida leitura. Nos vemos novamente em breve!
Até+
