Você quer uma documentação que atenda o usuário e o desenvolvedor?

Muito do que já ouvi em projetos de software é que a documentação precisa ser abrangente, precisa atender tanto ao usuário como ao desenvolvedor. Alguém mais já passou por isso?

Frequentemente é delegado ao Analista (de Negócios, Requisitos ou Processos) que execute esta função de forma que o documento agrade a todos.

Agora pense numa literatura que é universal: Vou trazer aqui como exemplo um jornal. Um jornal possui como sua essência trazer as notícias, com uma narrativa ou um relato breve de um fato, ou crônicas com opiniões de seus jornalistas. E qual é o resultado da leitura de um jornal?

Com base na experiência de cada um, cada pessoa que lê um jornal pode tirar conclusões distintas, não é mesmo? Basta ler a seção de comentários de um portal de notícias para perceber.

E porque isso não aconteceria com um documento de requisitos? Porque um documento precisa atender dois públicos tão distintos, com níveis tão diferentes de abstração? Com responsabilidades e desejos tão diferentes?

Um outro exemplo popular e histórico é a história de Jesus: Jesus trouxe a palavra universal e nem todos a entenderam. Como diz aquele velho ditado: Se nem Jesus agradou a todos…

Então, antes de concluir que uma documentação está “ruim”, tenha isso em mente: É humanamente impossível garantir que sua especificação atenda a dois públicos totalmente distintos.

E é preciso focar naquilo que é mais importante.

curte-compartilha

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 )

Foto do Google+

Você está comentando utilizando sua conta Google+. 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 )

w

Conectando a %s