Participe da melhoria da documentação

Ontem, mudamos o conteúdo inicial do wiki do projeto i-Educar, tornando-o mais informativo e útil ao visitante que procura rapidamente onde fazer o download do software junto com os procedimentos de instalação. O objetivo é centralizar toda a documentação e recursos disponibilizados pela comunidade.

Muita documentação ainda precisa ser criada. Para isso, precisamos da colaboração dos membros da comunidade que estão usando o i-Educar, seja criando novas entradas no wiki ou encerrando tópicos do fórum de suporte ao conseguir resolver algum problema. Qualquer pessoa da comunidade i-Educar pode editar o wiki, basta fazer o login com os mesmos dados de acesso da conta no Portal do Software Público Brasileiro

Guias de usuário (passo a passo) e tutoriais são excelentes pontos de partida para aumentar a adoção do software e são fáceis de fazer, apenas requerem uma contribuição de tempo.

Outra fonte preciosa de documentação que precisa ser filtrada é o fórum de suporte. Nele, temos vários problemas e dificuldades repetidas em tópicos diferentes que podem e devem servir de base para itens de um FAQ (Perguntas Frequentes). Questões como versão do PostgreSQL, versão estável do i-Educar e problemas de codificação já estão respondidas e em um formato FAQ evitaria a abertura de tópicos repetidos no fórum.

A documentação mais técnica é a que vai demandar mais cuidado na sua criação. Foi criado um item que é o dos padrões de codificação que deve ser seguido a risca para ajudar a trazer uniformidade ao código fonte e melhorar a manutenibilidade. Sua leitura é recomendada para todos que forem alterar o código, seja para correção de bugs ou para adicionar uma nova funcionalidade.

Esses padrões foram baseados nos padrões adotados por softwares livres de grande adoção como o Drupal CMS, Zend Framework, Symfony e PEAR. A medida que avançarmos no desenvolvimento do i-Educar, consolidaremos esse documento que hoje está em progresso e criaremos documentação técnica auxiliar, principalmente da modelagem do sistema e da API do sistema.

Boa documentação!