Feeds:
Posts
Comentários

Posts Tagged ‘Documentação’

Vou falar um pouquinho sobre documentação de software, que muitas empresas fazem “demais” e muitas empresas não fazem nada… E como todo extremo… Não é bom.

Documentar demais é ruim pelo tempo que se gasta criando o documento, alterando, revisando e dando manutenção. Esse assunto manutenção é engraçado. Se você documentar um software, por mais completo e detalhado que esteja o documento, se este não acompanhar a evolução do sistema… Para que servirá? E outra, para quem servirá? E não documentar nada, dependendo da situação também pode ser um problema…

Sempre tive dúvidas quanto a documentação, mas no final de tudo, sempre me respondi a mesma coisa: “Documente o que for necessário”. E partindo deste princípio, cada empresa ou até mesmo cada projeto poderá gerar documentações diferentes, em momentos e para pessoas diferentes.

Por exemplo, quando algum desenvolvimento ou processo for muito complexo, vale a pena documentar. Use desenhos e fluxos simples para explicar o que deseja. Pontue os principais detalhes e informações em “tópicos” (uma ideia). Pode ajudar no debate sobre a ideia ou nas futuras manutenções.

Outro momento legal de documentar, mas aí vejo que é uma documentação mais “temporária”, são os esboços iniciais do projeto. Ideias, fluxos e “rabiscos” (feitos normalmente no quadro branco da sala de reunião) que terão uma seqüencia de debate. Mas não perca tempo, tire uma foto! (celular) Simples assim.

Algo que já senti muita dificuldade foi de “entender o processo”. Entendendo o processo, o código fica fácil. Um fluxo mesmo que macro do processo cairia bem. Ajuda também no momento que este processo precisar ser revisado e alterado. As mudanças sofrerão menos riscos.

E, por fim, outra “documentação” que eu acho que deveria ser uma documentação ESSENCIAL para todo projeto é algo parecido com WIKI. Já pensou que legal? Primeiro, se você alimentar esta Wiki com explicações referentes a cada mensagem de erro que o sistema possa mostrar para o usuário, já conseguirá explicar boa parte do seu sistema! Outra coisa que, cada dúvida que se torne frequente entre os usuários, pode ser postada ali, com uma explicação do processo, desenhos… Seria o primeiro nível de suporte ao usuário, e muitas vezes o suficiente! O grande “problema” é: Alguém precisa alimentar! Mas… Melhor que um documento sem valor, que fica amarelando na gaveta e “não serve pra ninguém”.

Ah, vai uma dica de “documentação ágil”: NÃO CRIE DOCUMENTAÇÃO COMO ÚNICA FORMA DE COMUNICAÇÃO. Prefira a face-a-face.

Read Full Post »