WP Help: Criando documentação hierarquica de seu trabalho diretamente no painel do WordPress

Como falado na nossa postagem anterior sobre o uso da função Function Exists, muitos dos desenvolvedores nem sempre criam uma simples documentação para que quem passe por algum problema saiba se virar sozinho (ou o novo desenvolvedor contratado, etc) e saiba exatamente quais plugins deve ativar (ou instalar novamente) para o site voltar a funcionar corretamente.

Seguindo os princiípios de Qualidade de Software, manutenibilidade é um item importante e a correta documentação do seu trabalho ajudará e muito neste processo.

Sabendo que a criação e apresentação de documentação de projeto pode ser um grande desafio para muitos desenvolvedores WordPress, Mark Jaquith, líder de desenvolvimento do WordPress, criou um novo plugin que lhe dá a habilidade para explorar o poder do WordPress para criar, editar e organizar sua documentação. Com este plugin, você poderá fornecer a documentação, organizada de forma hierárquica, diretamente no painel do WordPress.

Tal plugin se chama WP Help e foi lançado no dia 18 de maio de 2011 na sua versão 0.1. Por enquanto apenas disponível em inglês, mas segundo próprio Mark em breve estarão disponíveis os arquivos .pot para que possamos o traduzir para outras línguas.

O WP Help utiliza custom post types para ajudar você a organizar o conteúdo de uma forma que fique estruturada e legível, com ilustrações e links, sempre que necessário.

Uma das coisas interessantes deste plugin é que ele trás um design e código muito limpo e atraente, parecendo até que faz parte do próprio WordPress. Vejamos como ele se apresenta no painel do WordPress 3.2:

O WP Help adicionará ao seu WordPress tal funcionalidade para que você possa dar a seus clientes um manual que eles podem acessar diretamente no dashboard. Com isso, você poderá acabar com a necessidade do cliente caçar em seus emails aquela antiga mensagem que explicava como proceder para instalar e fazer um bom uso do tema criado por você, ou passar horas no telefone explicando e re-explicando como publicar o novo conteúdo com o WordPress. Este plugin lhe poupará tempo na prestação de suporte para sites de clientes. Infelizmente tal plugin ainda não funciona na documentação de toda uma rede de sites WordPress (quando usando a função multisite), o que seria uma fantástica funcionalidade. Vejamos como tal plugin evoluirá

Criar a documentação pode ser uma parte chata do seu trabalho. No entanto, este plugin o ajudará neste processo, lhe dando uma forma fácil de organizar a documentação e a apresentar de forma simples e de fácil compreensão.

Para baixar este plugin, acesse https://wordpress.org/extend/plugins/wp-help/ e fique atento a sua evolução, tal plugin lhe será muito útil com certeza !