← Eventos

Tao Of Documentation

A maioria dos desenvolvedores odeia ter que escrever documentação, mas ao mesmo tempo reclama de como as ferramentas e bibliotecas que usa carecem de documentação. A questão é: como fazer com que desenvolvedores escrevam boa documentação sem sentir que estão perdendo tempo? Existem boas ferramentas de documentação por aí, como TomDoc, YardDoc e RDoc — cada uma com sua forma única de facilitar a documentação de ferramentas, gems e diversos projetos open source.

Como gerenciar a documentação de um produto? Na Engine Yard, tínhamos o produto AppCloud, e ter uma boa documentação externa para os clientes era muito importante — queríamos garantir que eles entendessem facilmente como usar o produto e conseguissem fazer o que precisavam. No entanto, sempre foi difícil produzir boa documentação rapidamente.

Slides

Ver slides no Speaker Deck

Áudio

Gravação — Ruby Conf Uruguai 2011