Documentação é inversamente proporcional às suas boas práticas ágeis

O volume de documentação que uma empresa precisa é inversamente proporcional ao número de boas práticas ágeis que pratica, desde a relação de confiança com o cliente, interação entre as pessoas, auto-organização, qualidade, especificação tardia e excelência técnica.

No século XX tínhamos contratos rígidos, escopo prévio, preditivo e extensivo, muita desconfiança, bônus e penalidades, comando-controle e muito tempo em change management. Isso gerava baixa efetividade e qualidade, decorrente do stress e zonas de conforto gerados por isso.

No século XXI temos orientação à relacionamento, equilibrando valor e excelência, buscando eliminar todos os desperdícios visíveis em prol de valor entregue no tempo e custo, com documentação mínima, necessária e viva, valorizando boas práticas em engenharia de SW.

Confiança é a base

A mudança de paradigma faz com que clientes e usuários apropriem-se de seus projetos, participando ativamente ao invés de terceirizar o trabalho com a TI. A TI ao invés de se ver como fornecedor, assume o papel de parceiro, colaborando ativamente para seu sucesso.

O vetor mais relevante é a retirada do teatro das relações interpessoais e comerciais, assumindo-se uma posição cooperativa, mitigando a Lei do Gerson (tirar vantagem), a Lei Ricúpero (enganação), na troca de uma relação pautada na desconfiança por uma de confiança e sinergia.


imagem – http://nathandonaldson.com

Temporário ou Perene

É importante saber distinguir para si o que é documentação temporária ou documentação perene, pois usamos documentos, quadros e mapas mentais no dia-a-dia, a maioria deles de utilidade volátil a medida que o projeto segue adiante, então: Descarte o descartável.

Quanto a necessidade, é preciso entender o problema, ao invés de perguntar o que se quer, usar de empatia para colocar-se no lugar do cliente, usuários, stakeholders e equipe, entender o 5W2H dos desafios, a cada passo, temos um entendimento, alternativas e best choice.

Se você não usa conceitos convergentes, tal como domain driven design (DDD), behave driven development (BDD), Service-Oriented Architecture (SOA), código limpo e auto-documentado, … é pouco provável que documentação mínima e mapas mentais sejam suficiente;

O que vejo por aí? Documento de visão, termo de abertura, inception, casos de usos, histórias do usuário, product backlog, mapa de arquitetura, integrações, regras de negócio, protótipos com principais regras funcionais, plano e cenários de testes, mapas mentais, canvas, etc.

Novos Paradigmas

O método, tanto quanto documentação trabalham para o valor a ser gerado, jamais o contrário. O contrato e combinações é para serem usados como baliza do trabalho do time e partes interessadas, empenhadas em fazer o seu melhor dentro do custo, tempo e escopo-base;

Agile – Planejamento baseado em alto nível de abstração e complexidade, ciclos iterativo-incrementais-articulados, detalhar e tomar decisões no último momento responsável, se a arquitetura e arquitetura for legível, a documentação será mais leve e talvez temporária;

Enxuto – Privilegiar o vital e não o trivial, registrar o óbvio é inútil, foquemos no desconhecido de alto impacto, é desnecessário registrar o óbvio. Quanto mais enxuto e relevante melhor. Valor está no uso e quanto maior, menor o uso, maior o custo relativo e mais rápido caduca;

5W2H – É fundamental mapear entre os envolvidos, racionalmente cada artefato ou documento, a quem ele interessa, qual a alternativa ideal, o que é e porque existe, quanto custa a sua atualização, por quanto tempo será útil, quando deve ser feita e se permanece ou será descartada.

Referências

Há algumas cláusulas pétrias quando falamos de documentação ágil, como YAGNI (You Aren’t Gonna Need It), KISS (Keep it simple stupid), auto-documentação enquanto excelência em engenharia de SW, menor assombro (seguir padrões), DRY (não redundância), garantia de links estáveis, especialização (foco), dependências estáveis, fácil de manter, fácil de encontrar – www.agilemodeling.comwww.smartics.eunathandonaldson.com.

Documentação tem a ver com a cultura da organização, relacionamento e tecnologia, por isso tem a ver com boas práticas ágeis. A regra é trabalhar de forma fluida, sem tanto desperdício, seguindo a máxima de Pareto – Poucos Vitais para muitos triviais.

Conclusão

Sem boa engenharia de software, domain driven design (DDD), behave driven development (BDD), arquitetura orientada a serviços, código limpo e auto-documentado, … é pouco provável que uma documentação mínima e mapas mentais sejam suficientes;

Use o conceito de “Gemba” do Lean, pergunte a quem está onde as coisas acontecem, não faça documentação por idealização de quem não as constrói, mantém ou usa. Documentação boa é documentação útil, ela tem que informar coisas relevantes e serem confiáveis.

Pare de buscar receitas mágicas e aprenda a cozinhar, estabeleça uma discussão sobre sua documentação atual, perenes ou temporárias, se está lendo este post é porque já sabe o suficiente para pensar Lean, experimentar, aprender e melhorar.

Um comentário sobre “Documentação é inversamente proporcional às suas boas práticas ágeis

  1. Pingback: Ao invés de perguntar sobre documentação, aprenda com ela | Jorge Horácio "Kotick" Audy

Deixe um comentário

Preencha os seus dados abaixo ou clique em um ícone para log in:

Logotipo do WordPress.com

Você está comentando utilizando sua conta WordPress.com. Sair / Alterar )

Imagem do Twitter

Você está comentando utilizando sua conta Twitter. Sair / Alterar )

Foto do Facebook

Você está comentando utilizando sua conta Facebook. Sair / Alterar )

Foto do Google+

Você está comentando utilizando sua conta Google+. Sair / Alterar )

Conectando a %s