Um dos aspectos mais importantes no desenvolvimento de plugins é ter um bom arquivo readme.txt.  Nome, descrição, tags, versões do WordPress compatíveis, instalação e FAQ são apenas alguns dos vários dados que podem ser adicionados, e todos eles contribuem um pouco para aumentar a qualidade do plugin desenvolvido, já que as buscas no repositório são feitas, inclusive, por esses itens.

De acordo com Vladmir Prelovac, em seu texto Top 10 Tips for WordPress Plugin Developers, os usuários se interessam mais em fazer download de plugins com uma boa descrição, instruções de instalação e algumas telas que os mostrem funcionando. Além disso, Vladmir comenta que, em segundo plano, caso seu plugin se torne popular, você começará a receber inúmeros pedidos de suporte. Dessa forma, se o plugin possuir um readme.txt completo, as chances de você ser inundado por perguntas diminui consideravelmente. E foi pensando nisso que Sudar Muthu disponibilizou o WordPress Plugin Readme File Generator.

Os campos obrigatórios do formulário

O WordPress Plugin Readme File Generator nada mais é do que uma simples ferramenta que agiliza a produção desse arquivo. Utilizando o  padrão de escrita do WordPress, a fim de que as informações entrem corretamente no repositório de plugins, o formulário desenvolvido por Muthu gera o arquivo readme.txt para o seu plugin, baseado nas informações que você fornece. Após a inclusão dos campos obrigatórios, é só gerar o arquivo, validar (ele usa o próprio validador do WordPress), salvar o arquivo e pronto, seu readme.txt está criado.

Desenvolvedores, documentem seus plugins. Sério, não dói. A documentação básica aumenta a credibilidade e, principalmente, a qualidade da extensão desenvolvida. E simples idéias como essa de Sudar Muthu podem facilitar essa tarefa.