Documentação

Contexto

Projetos de software exigem documentação. De fato, talvez várias "documentações" no sentido em que, cada documentação é produzida para um leitor bem-definido, por exemplo, a documentação do usuário é diferente daquela documentação produzida por arquitetos de software para a equipe responsável pelo desenvolvimento. Dentre os documentos a serem produzidos para o Programa HealthDB está aquele direcionado para os desenvolvedores.

Objetivo

Investigar e apresentar proposta de documentação para o HealthDB.

Espera-se que a documentação dos projetos hsqldb, H2, Derby, SQLite e Realm sejam analisadas e os resultados utilizados na definição da documentação a ser sugerida para o HealthDB.

Além da análise da documentação acima, o que deverá incluir a identificação de critérios como facilidade de uso, legibilidade e outros, o projeto deverá incluir a análise das ferramentas abaixo, possivelmente acrescida de outras.

Ferramentas

• http://daux.io/
• https://readthedocs.org/
• https://github.com/lord/slate
• http://www.mkdocs.org/

Tarefas

1. Descrever os critérios para seleção dos SGBDs "similares". A escolha aqui é pelo SGBD, não é pela estratégia adotada pelo SGBD para a documentação.
2. Documentar, de forma resumida (1 ou 2 parágrafos), cada um dos SGBDs selecionados: principais características.
3. Analisar a documentação de sistemas similares ao HealthDB. Criar uma tabela na qual o resultado dessa análise será registrado. A tabela deve conter nas linhas os SGBDs e nas colunas os critérios relevantes, que serão atendidos ou não por cada SGBD.

• Proposta de documentação para o HealthDB baseada na análise de documentação de projetos similares (citados acima). A proposta deverá considerar os critérios cuja identificação também faz parte do projeto.
• Uso da estratégia de documentação adotada para parte da documentação do HealthDB.