skip to Main Content
Documentar Ou Não Projetos ágeis - Documentação ágil

Projetos ágeis: Documentar ou não documentar, eis a questão

Ao iniciar um projeto de software baseado em metodologias ágeis, pode-se esperar que algumas pessoas acreditem que não será necessário realizar nenhum tipo de documentação. Realmente, não documentar parece economizar um grande tempo de projeto, mas seria este o melhor caminho? 

De acordo com o manifesto ágil, o software em funcionamento deve ter mais prioridade do que uma documentação abrangente, mas isso, de forma alguma, tira a importância de documentar. Construir a documentação de um projeto é fundamental para a comunicação do cliente com o time e vice-versa.  

O que uma boa documentação de projetos ágeis deve ter? 

Uma boa documentação deve facilitar o entendimento tanto do contexto como das regras a serem implementadas no software e, além disso, auxiliar no desenho da funcionalidade, tornando o projeto mais palpável para seus idealizadores, possibilitando assim, uma visão mais clara sobre sua operação e usabilidade. 

A documentação de um projeto guiado por metodologias ágeis pode ser feita em diversos modelos e formatos, isso vai depender do acordo entre o cliente e o time. Apesar das várias possibilidades, um documento ágil deve seguir alguns princípios como:  

1 – Conheça seu público 

A documentação deve ser feita para seu público-alvo e, para isso, é necessário conhecer seu perfil e linguagem. É necessário que a documentação tenha valor para quem vai utilizar, por exemplo, não seria bom que a documentação fosse escrita de forma totalmente técnica para um cliente sem este conhecimento, mas sim apresentar foco no negócio; 

2 – Tenha objetivo 

Ao fazer a documentação de um projeto ágil é necessário entender qual o objetivo desta documentação. Para que a documentação seja eficaz, é necessário que ela atenda a alguma necessidade, seja ela de definição de escopo, regras de negócio, requisitos não funcionais entre outros artefatos que podem ser necessários ao projeto; 

3 – Seja um mapa para o tesouro 

Este tipo de documentação deve trazer informações úteis para que o projeto siga o caminho certo e chegue ao objetivo esperado. Como já dito anteriormente, a documentação deve entregar valor, ou seja, não adianta escrever ou diagramar informações irrelevantes ao projeto, tudo deve ser pensado e feito de modo a apoiar e guiar o trabalho dos outros membros do time.  

4 – Seja fitness 

A documentação ágil deve ser tão magra quanto possível, ou seja, deve ser simples, clara e muito objetiva, considerando, claro, o nível de detalhes necessários para o projeto. Informações demais podem tornar o documento muito complexo e cansativo para quem irá utilizar e, também, atualizar suas informações será bem trabalhoso; 

5 – Seja antenado 

A documentação do projeto não pode parar no tempo, ela deve ser atualizada conforme os ajustes, melhorias e novas funcionalidades são incluídas no software. Uma documentação desatualizada não oferece valor nenhum ao projeto e, pode inclusive, gerar confusão ao decorrer do tempo. 

6 – Seja conectado 

Como dito anteriormente, é importante que a documentação se mantenha atualizada, mas, além disso, é de suma importância garantir que todos os impactos das alterações sejam identificados e registrados, de modo a ajudar o time a entender quais, de fato, serão os ajustes; 

7 – Fale do negócio 

Para o time que não está 100% familiarizado com o negócio do cliente, entender o objetivo das funcionalidades implementadas pode auxiliar muito na hora de desenvolver e testar, além de permitir que o time colabore com a cobertura de possíveis cenários problemáticos, agregando assim mais valor e confiabilidade ao software desenvolvido. 

Conclusão 

Tendo tais pontos em mente, pode-se iniciar a construção da documentação de um projeto ágil pela definição da estrutura para suporte destes documentos, encontre as ferramentas ideais para seu desenvolvimento e armazenamento e determine o padrão que irá seguir.  

Importante destacar que a documentação não precisa ser apenas escrita, caso acredite que vá ajudar no entendimento, utilize protótipos e diagramas, por exemplo. Lembre-se de considerar o dinamismo e facilidade de acesso aos arquivos, pois a documentação deve estar disponível a todo momento e a todos os envolvidos. Outro ponto importante a ser considerado é a rastreabilidade dos documentos, para que possam ser acompanhadas as alterações de versões. 

Mesmo ainda não sendo possível definir um modelo ideal para a documentação de um projeto ágil é possível perceber que a sua existência é importantíssima. Uma boa documentação irá auxiliar no contato com o cliente, em questões como definição de regras e comportamentos necessárias para o software. Para os desenvolvedores e testers da equipe, além de auxiliar no entendimento do projeto, a documentação trará segurança a eles, mostrando o que realmente é esperado. 

 

Julia Gomes

Julia é formada em Engenharia Elétrica pelo Centro Universitário Ingá, pós graduanda em Engenharia de Software pela PUC Minas. Atua como analista de negócios na DB1 Global Software.

This Post Has 0 Comments

Deixe uma resposta

O seu endereço de e-mail não será publicado. Campos obrigatórios são marcados com *

Back To Top