Documentação e sucesso

March 1st, 2008 § 4 comments

Existem dois tipos de projetos de código aberto: os que os usuários entendem o suficiente para contribuir regularmente e os que os usuários são geralmente apenas isso, usuários. No caso desse último–o kernel do Linux, por exemplo–integração com outros sistemas de maneira transparente é o mais interessante e com isso alcançado, usuários raramente precisam se preocupar e sucesso é geralmente proporcional a essa integração.

No outro tipo de projeto, porém, documentação parece ser o fator dominando para o sucesso. Não importa se é fácil de instalar e configurar, não importa se é possível contribuir, se não existe documentação abundante, os projetos simplesmente permanecem em um limbo de uso. Algumas pessoas, corajosas o suficiente para se dedicar ao código, vão desbravando novas fronteiras e usando com sucesso enquanto o resto olha, se dá conta de que para ter respostas será necessário empregar mais esforço de uma busca trivial e parte desapontada.

De vez em quando, eu acho que o sucesso do Rails se deve primariamente à documentação abundante que foi produzida antes mesmo que ele se tornasse um sucesso. Hoje qualquer busca por qualquer coisa sobre Rails retorna milhões de receitas similares e adaptáveis. O Django, mais de dois anos depois de seu lançamento, ainda possui um documentação fragmentada e às vezes contraditória que gera mais dúvidas do que respostas. Seaside, da mesma forma, possui documentação quase nula e somente agora um esforço maior está sendo feito para remediar isso.

A ironia está em que isso também parece confirmar considerações como a de Joel Spolsky sobre a mediocridade dos programadores. Sem documentação, alguns não sairiam nem do lugar.

§ 4 Responses to Documentação e sucesso"

  • Trabalhei por dois anos com Zope/Plone e posso dizer que foi a pior experiência da minha vida, no que tange a Open Source.
    O Zope, até pouco tempo, tinha uma quantidade razoável de documentação, mas para o desenvolvedor avançado, necas.
    O Plone tem a pior documentação da face da terra: desatualizada e pouco informativa.

    O contraste é o Drupal. Trabalho com ele desde 2002 e nunca faltou documentação decente.

    Quando procurei alguma coisa sobre Rails, realmente não faltou documentação, só não segui adiante porque faltou projetos :-p

  • Ronaldo says:

    É isso mesmo. Eu acho que a falta de documentação gera um atrito que, dependendo da tecnologia, é muito difícil de superar.

    Tome o caso do Castle Monorail, com o qual eu estou mexendo agora. A documentação até existe no site mas é extremamente fragmentada e não tem algo que eu acho fundamental: problemas comuns e suas soluções. Isso gera uma ladeira que, dependendo da questão, é muito difícil de superar.

    Obviamente, como o projeto é aberto, parte da responsabilidade é minha. Eu posso–e pretendo–investir mais no assunto e contribuir.

  • É, no meu caso, até o momento não tenho intenção de voltar à essas ferramentas.

    Também concordo que todo usuário é responsável pela documentação de projetos open source, o problema é quando você já desacreditou na comunidade :-/

    Abraço

  • Ronaldo says:

    Sim, claro. Existem ferramentas que eu ainda uso e que não tenho a menor intenção de contribuir porque a comunidade é fechada de mais, cheia de cliques. E outras que eu nem quero ver mais porque não há estímulo. Infelizmente, tem muita gente que começa dizendo que é código aberto mas não sabe compatilhar.

Leave a Reply

Your email address will not be published. Required fields are marked *

What's this?

You are currently reading Documentação e sucesso at Superfície Reflexiva.

meta