Atenção grandes empresas: Documentação do Pomodoros em estágio avançado de conclusão

15 de enero de 2018

Foi-se priorizado “subitamente” a criação da documentação para assim poder finalmente entrar em um período de estabilidade de uma versão nova do software, o chamado Pomodoros Black, novo momento do site www.pomodoros.com.br.

Assim a documentação puxou uma série de melhorias “bruscas” no código, para acompanhar a documentação foi-se revisto quase que todo o código do projeto e como prioridade absoluta foi-se removido todos os comentários, excluindo assim muitas linhas de código antigas.

A dificuldade na remoção era porque os comentários misturavam no código as ideias de funcionalidades, misturando planejamento e produção, foram todas retiradas e catalogadas no nosso sistema de controle de novas funcionalidades e bugs.

O código ficou mais leve e ao se documentar também acabei percebendo muitas oportunidades de melhorias imediatas, como simplificação de comandos e redução de lógica redundante. Assim páginas php com dezenas de linhas de códigos foram reduzidas a poucas linha.

Uma nova estrutura exigiu grandes mudanças, assim cada parte de código quando revista era renomeada e o que “ficou para trás” podia então ser excluído. No decorrer do processo também foram otimizados e atualizado os comandos de WordPress, para os mais recentes e adequados para cada cenário.

Ao se fazer a navegação também tive a oportunidade de rever cada página e fazer as pequenas correções que cada uma exigia. Assim a documentação trouxe muito mais qualidade para o usuário e o software final.

Por que documentar?

Vários projetos existem sem documentação, dependendo do estágio e objetivo do projeto a documentação pode ser considerada uma tarefa desnecessária, que consome muitos recursos, principalmente em situação de muitas mudanças, pois o custo de se adequar a documentação a cada mudança implica em prejuízo no desenvolvimento.

Assim, o projeto Pomodoros foi feito a “queima roupa”, com um planejamento mutante, que se transformava “a cada esquina”. Porém, após semanas e rodadas de decisões técnicas e estratégicas no final de 2017, a documentação passou a ter maior importância.

A nova documentação vai permitir uma manutenção mais precisa e eficaz no código, permitindo que programadores façam melhor uso do código e que grandes empresas possam olhar para o sistema com bons olhos.

Além de uma boa documentação grandes empresas exigem um bom suporte, então estas são as prioridades atuais do Pomodoros em termos técnicos, atingir rapidamente o mercado das grandes empresas e assim “puxar” uma série de inovações importantes para o futuro da plataforma.

Um agradecimento especial a todos os usuários históricos do sistema, desde o primeiro dia que entraram na plataforma, minha maior satisfação é saber que de alguma forma ajudei cada um a atingir seus objetivos pessoais, acadêmicos e profissionais.