O “Manifesto Ágil” afirma o seguinte: software funcional em vez de documentação abrangente. No entanto, o objetivo dessa frase não é dizer que você precisa rejeitar toda a documentação do projeto.
Sim, de fato, a documentação comum em outras abordagens é muito rígida para o Agile. No entanto, ainda é necessária. Abaixo listamos as principais razões pelas quais as os colaboradores e clientes precisam do documento de design técnico para seu trabalho:
- As partes interessadas exigem os relatórios;
- Os clientes precisam se sentir mais seguros;
- Para manter o controle de tudo no projeto;
- Para auditoria; e
- Como um material de treinamento para novas pessoas na equipe.
No Agile, alguns desses documentos são necessários, mas o conteúdo é totalmente diferente. Apresentamos algumas regras básicas para documentação ágil, que irão ajudar sua empresa a reduzir a carga de trabalho e poupar tempo, dinheiro e desperdício de papel.
Conteúdo
Apenas as informações relevantes
Agile sugere que apenas as informações mais necessárias devem ser documentadas. Faça sempre a seguinte pergunta: Qual é a necessidade de documentar algo que todos sabem?
Crie uma visão, se isso ajudá-lo a obter fundos. Escreva apenas os documentos do cliente que seus clientes exigem. Documente suas decisões apenas se houver alternativas e você precisar de um lembrete do que está por trás dessas decisões.
Aguarde antes de documentar
Espere até que a decisão seja implementada e não há como voltar até que você realmente a coloque no papel. A informação é estabilizada e confiável. Você economiza custo, tempo e esforço gastos ao refazer seus documentos.
Busque um especialista em documentação
Se você puder pagar, peça a uma pessoa especial para cuidar de sua documentação. Em primeiro lugar, você saberá que sempre haverá alguém no comando. Em segundo lugar, isso será feito corretamente. Os desenvolvedores são bons na parte técnica, mas muitas vezes ficam desamparados quando se trata de descrevê-la.
Seja específico
Tenha em mente que cada projeto tem seus próprios requisitos e especificações. Você não pode aplicar os modelos de documento para um projeto enquanto trabalha com outro. Alguns campos podem nem existir em um projeto enquanto alguns importantes estão faltando.
Além disso, os clientes são diferentes e o que funciona com um simplesmente não é suficiente para o outro. Deixe os clientes decidirem sobre o conteúdo e a quantidade de sua documentação. Isso vai lhe poupar algum trabalho extra e nervos.
Mantenha tudo em um só lugar
Os documentos de projeto técnico devem ser acessíveis e transparentes. Você precisa tê-los disponíveis para qualquer pessoa que precise deles. Aqui na RockApps utilizamos Wiki para essa função 🙂
Vamos compartilhar algumas dicas para utilizar o Wiki da melhor forma:
- Todo desenvolvedor deve contribuir para o seu Wiki;
- Todas as informações devem ser divididas em seções para sua conveniência;
- Atualizações regulares devem ser feitas se alguma informação estiver desatualizada ou simplesmente não for mais relevante;
- Todos os funcionários devem consultar os wikis de vez em quando. Isso os ajudará a se lembrar de seus objetivos principais. Além disso, os manterá informados sobre todas as reformas;
- Existem links e referências para suas outras peças de documentação. Assim, você sempre poderá encontrar o que precisa.
Conclusões
O Agile possui como boa prática focar em um sistema funcional ao invés de uma documentação extensa e complexa. No entanto, foi possível verificar que é necessário criar alguns documentos para servir de base para seus colabores e clientes.
A principal dica desses post é: Sempre se questione sobre a real necessidade de um documento e foque em uma comunicação oral e escrita efetiva.
Se estiver enfrentando algum problema relacionado ao tema em seus projetos, conte com a RockApps para te ajudar nesse desafio. Nosso time possui grande experiência em desenvolvimento e documentação de projetos ágies.
