Comments on: Documentação é burocracia?

By: cava

cava — Tue, 31 Jul 2007 11:28:25 +0000

Lucio, o ponto que discordamos é simples. Em qualquer metodologia moderna, planejar vem antes de executar.

E por isso, durante o planejamento, documentar (seguindo a logica que botei no texto) é importante para garantir que o software funcione.

Software funcionando (mantendo escopo, prazo e custo) é o objetivo. A metodologia (e a documentacao é parte dela) é apenas um meio para atingir este fim.

By: Lucio

Lucio — Tue, 31 Jul 2007 11:14:58 +0000

Não, não é deixar na memória. Mas também não é escrever tim tim por tim tim. É trabalhar com o cliente do lado, de maneira que você consiga ter iterações pequenas e feedback rápido: trabalha um pouco, mostra pro cliente, trabalha mais um pouco, mostra pro cliente e assim vai, ao contrário de: trabalha um monte (acabou o prazo aqui), mostra pro cliente, ajusta um monte, mostra de novo etc. No fim, a documentação é o próprio produto, no máximo com um manual para os usuários finais, se necessário.

Não são idéias novas, nem minhas, nem tão simples que dê para explicar tudo aqui. Mas são mudanças significativas na maneira de se fazer software, na comunicação com o cliente, na maneira de se cobrar o cliente e muito mais, baseado em algumas premissas:

Apesar da documentação ter valor pro cliente e pra você, o software funcionando tem muito mais valor.
Apesar de processos e ferramentas terem seu valor, pessoas e a interação entre elas têm mais valor.
Apesar de que negociar um contrato tem seu valor, a colaboração de perto com o cliente tem muito mais valor.
Apesar de que seguir um plano pré-determinado tem valor, ter a capacidade de responder rapidamente às mudanças tem muito mais valor.

By: TheSoulSurfer

TheSoulSurfer — Mon, 30 Jul 2007 20:41:55 +0000

Documentar eh registrar como as coisas estao organizadas.
Organizacao eh bom em todos os niveis… ter o armario em ordem, seus livros arrumados na prateleira, seus CDs catalogados ou os seus arquivos no computador nomeados corretamente… sao pequenas coisas que fazem o dia a dia mais eficiente… principalmente se voce compartilha esses livros, CDs e arquivos com outras pessoas… pode ser o colega do trabalho ou sua esposa… a questao eh… um vez organizado, fica facil p/ todos acharem o que estao procurando…se se no caso voce nao vai poder ficar explicando p/ cada um onde as coisas estao… simplesmente documente.

organizar e documentar eh sim um saco… mas pense em fazer isso por uma causa maior… pelo bem estar de todos.

tem empresa que faz isso na porrada… onde trabalho por exemplo se nao preencher o time sheet semanal o individuo recebe ateh tres advertencias… depois comeca a ter parte do salario descontado… documentar eh bom pra poder combrar bem o cliente tambem.

Abrasss!

###

By: Bugz

Bugz — Mon, 30 Jul 2007 20:01:55 +0000

A documentação, registro de metodologia, work-flow ou sei-lá o nome que pode se deseja dar aos documentos que são criados durante o processo de um trabalho (seja este um hot-site, um sistema laboratorial ou um canal de televisão) são de valor inestimável. Isso se aprende de dois jeitos; a maneira fácil, fazendo a documentação de processos, decisões e reuniões, ou, do jeito mais difícil, quando se percebe que o trabalho foi muito maior devido a falta de uma determinação por escrito.

Sou a favor de documentação. Não gosto de escrevê-la, mas, tendo vivido como fornecedor e como cliente, todos tem a ganhar de uma formalização do trabalho.

By: cava

cava — Mon, 30 Jul 2007 16:35:02 +0000

Lucio, nao entendi. Sua ideia seria discutir com o cliente e deixar na memoria o que foi combinado?

Porque o problema que vc descreveu (do cliente mudar de ideia) nao é um problema da documentacao e sim do seu relacionamento com o cliente. E mais, a documentacao (no minimo) ajudaria nesta discussao.

By: Lucio

Lucio — Mon, 30 Jul 2007 16:30:53 +0000

Falando em regras de negócio, na minha opinião documentar regra de negócio de um programa de computador é uma droga. (Esse programa pode ser um hotsite, por exemplo)

O problema é que o documento substitui a comunicação com o cliente, que escreveu uma regra hoje e quer outra daqui a cinco minutos. A colaboração constante com o cliente, se possível lado a lado, é uma prática quase ausente na criação de software, mas é altamente valiosa porque você consegue feedback instantâneo, coisa que o documento não faz por você.

By: André Traichel

André Traichel — Mon, 30 Jul 2007 13:32:42 +0000

Tchê, enfrento isto TODO o dia. O principal produto da minha empresa é um sistema de gestão para pequenas e médias agências de comunicação. Neste tempo que estamos no mercado percebemos que não só existe a resistência à documentação do trabalho por parte dos funcionários, como falta uma mentalidade administrativa por parte dos donos. Agência é empresa e como tal merece atenção nos processos e no histórico, este último um dos principais motivos de se documentar. Todo mundo já teve que recuperar um orçamento de 6 meses atrás, ou então procurar aquele layout que o cliente reprovou ano passado e só agora acha que funcionaria.
Como diz aquele ditado, quem guarda o que não presta tem o que precisa!

By: Gui Lima

Gui Lima — Mon, 30 Jul 2007 13:08:23 +0000

Sempre achei um puta saco do cacete preencher todas as documentações. Vai ver pq tinha vindo de agências que, como disse, tem briefing e olhe lá.
Mas, tenho que admitir que todas as vezes que precisei levantar alguma informação e recorria a documentação de 1 a 30 preenchida, agradecia pelo processo feito.

A mesma coisa pra um timesheet. Outra porra de coisa chata pra cacete ainda mais pra que trabalha na área de negócios de uma empresa, que faz 900 mil coisas ao mesmo tempo e tem que detalha-las numa planilha. Um saco!

Porém, vendo do ponto de vista da empresa os dois processos são fundamentais.

Um mal necessário para ambas as partes. Funcionários e Proprietários

By: Klug

Klug — Mon, 30 Jul 2007 09:57:01 +0000

Eu nunca fui muito com a cara do documento 5 (exercício de criação), até pq ele acabava sendo preenchido (quando era preenchido) depois que o layout e texto pra aprovação do cliente já estavam prontos, devido à correria que vc conhece bem… No final servia só pra documentar algo que já estava documentado visualmente, e passou a não fazer o menor sentido heheh!
Eu sou muito a favor de metodologia e documentacao, mas na correria do dia-a-dia algumas dessas coisas vão sendo esquecidas, e o esquecimento vira o padrão. O ideal era fazer tudo na sequencia certa, documentar tudo pra ter tudo organizado e nao esquecer de detalhe nenhum, que tenha que ser acrescentado durante a producao… mas quem disse que no Brasil da tempo?