Documentação do sistema

Nenhum sistema é realmente bem desenvolvido se não tiver uma documentação que facilite, tanto ao desenvolvedor quanto ao usuário a compreensão e utilização de todas as partes que formam o sistema. Além disto, a forma na qual esta documentação é disponibilizada, também pode ser de fundamental importância na "popularização" do sistema.

As ferramentas de modelagem e de implementação utilizadas neste trabalho, facilitam bastante o trabalho "braçal", mas não são tão eficientes para disponibilizar a documentação. Para se tornar um software popular e para atrair o interesse de programadores da comunidade "open source", todo o sistema deve ser documentado de modo que o desenvolvedor consiga entender o funcionamento e implementação mesmo antes de ver o código fonte.

Para documentar as classes, os arquivos header (.h) foram todos documentados de acordo com as especificações do kdoc[1], que lé estes comentários e gera páginas html contendo a descrição das classes do sistema. Logicamente os comentários na codificação do sistema não foram esquecidas, mas a documentação estilo kdoc foi a que mereceu mais atenção, pois as classes ficam documentadas facilitando o seu entendimento sem nem mesmo ver o código fonte.

Para elaborar a documentação do sistema, manual do usuário e até mesmo este trabalho, poderia ter sido utilizado qualquer processador de texto. Porém, seguindo as especificações da TLDP - The Linux Documentation Project, foi utilizado o DocBook que posteriormente gera a documentação em HTML, PDF, LaTeX, PostScript entre outros formatos a partir de um mesmo fonte xml ou sgml.