Versões comparadas
Chave
- Esta linha foi adicionada.
- Esta linha foi removida.
- A formatação mudou.
O Cronapp possui uma ferramenta específica para gerar documentações automáticas a partir das implementações do sistema. É possível gerar documentações de 5 áreas do projeto: APIs, Blocos de programações (servidor e cliente), BPMN, Diagrama de dados e o Dicionário de dados.
Para criar ou atualizar as documentações existente, acesse no menu do sistema Projeto / Gerar Documentação, selecione quais os recursos que deseja gerar e clique em OK.
Figura 1 - Ferramenta Gerar documentação
Após o processo, a documentação de cada recurso estará separada por pastas dentro do diretório Documentação (localização: /Documentação/
Tooltip | ||||
---|---|---|---|---|
| ||||
Endereço: |
).
API
A opção API gera um arquivo *.pdf
com todos os recursos OData disponíveis no sistema. Esse conteúdo estará disponível no diretório api (localização: Documentação/api
Tooltip | ||||
---|---|---|---|---|
| ||||
Endereço: |
Figura 2 - Documentação das API's do sistema
Blocos de programação
Essa opção gera documentações em HTML a partir dos blocos de programação (Servidor e cliente) e dos comentários inseridos. São divididas em 2 pastas: javadoc, para os blocos Servidor e jsdoc, para os blocos cliente.
Servidor
A partir da página index (localização: Documentação/Blocos de programação/javadoc/Blocos de programação/index
Tooltip | ||||
---|---|---|---|---|
| ||||
Endereço: docs/blockly/javadoc/index.html |
Figura 3 - Documentação dos blocos de programação servidor
Cliente
A partir da página index (localização: Documentação/Blocos de programação/jsdoc/web/index
Tooltip | ||||
---|---|---|---|---|
| ||||
Endereço: |
Figura 4 - Documentação dos blocos de programação cliente
BPMN
A opção BPMN gera arquivos *.pdf
com todos os fluxos BPMN criados no sistema. Esse conteúdo estará disponível no diretório bpmn (localização: Documentação/bpmn
Tooltip | ||||
---|---|---|---|---|
| ||||
Endereço: |
Figura 5 - Documentação com as estruturas BPMN do sistema
Diagrama
A opção Dados gera arquivos *.svg
com a estrutura do Diagrama de dados do sistema. Esse conteúdo estará disponível no diretório models (localização: Documentação/data/models
Tooltip | ||||
---|---|---|---|---|
| ||||
Endereço: |
Figura 6 - Diagrama de dados do sistema
Dicionário de dados
A opção Dicionário de dados gera um arquivo *.HTML
com a estrutura das classes do sistema. Esse conteúdo estará disponível no diretório dictionary (localização: Documentação/dictionary
Tooltip | ||||
---|---|---|---|---|
| ||||
Endereço: |
Figura 7 - Descrição das classes do sistema
Nesta página
Índice |
---|