Questões sobre a documentação

[GeovaneSchmitz]

Atualmente, tem uma documentação simples aqui, contudo ela é muito básica, é gerada automaticamente pelo tsdoc.
Meu objetivo é criar uma documentação mais voltada em um formato de tutorial do que, atualmente, apenas listar os métodos, classes, etc.

• Português, inglês ou ambos? Ambos seria o melhor porém ter que manter duas versões complicaria muito, se escolhemos fazer em português será mais fácil de escrever, contudo será uma oportunidade perdida para melhorar o inglês. O problema do inglês é que ele cria uma barreira a mais para as pessoas entenderem a biblioteca, já que o SIGAA, até o que sei, só é usado no Brasil, por brasileiros. Usar o nomes em inglês pode trazer confusão, por mais que eu esteja seguindo uma tabela da UFSC com as traduções para os termos acadêmicos é muito fácil, por exemplo, confundir course com curso, quando na verdade course quer dizer turma. Mesmo assim, tudo pode ser explicado na documentação em inglês, se for feito em inglês.

• Qual é a melhor maneira de fazer uma documentação? Eu estava pensando em usar o (VuePress)[https://vuepress.vuejs.org/guide/getting-started.html], mas não sei se tem melhores opções.

• Também queria saber se alguém poderia tanto escrever como dar feedback da documentação.

[irwinschmitt]

Acredito que seja um esforço grande para um produto apenas utilizado e desenvolvido por pessoas que falam português. Minha sugestão é adicionar suporte à i18n para que as páginas principais, com a descrição do projeto, sejam traduzidas.