Documentação Automática

Este recurso gera, automaticamente, uma documentação completa do projeto, seguindo as normas do modelo adotado pelo PRAXIS para Especificação de Requisitos de Software (ERSw) e seguindo as boas normas de desenvolvimento de software sugeridas pelo PMI.

A partir do menu Utilitários, acesse o menu Documentação e inicie por Dados Gerais.

Observação: Caso o submenu Documentação não esteja visível no Menu Utilitários, deve-se habilitar o parâmetro Documentação Automática, da tela de Configurações.

Dados Gerais

É o cadastro inicial para documentação do projeto.

image780.jpg

A tela Dados Gerais dos Documentos, apresenta os seguintes itens:

Observação: Os botões ficarão disponíveis após a gravação do cadastro.

Identificação dos Aprovadores do projeto

Esta tela permite que sejam cadastrados os responsáveis pela aprovação do projeto e suas fases. A partir do menu Utilitários, acesse o menu Documentação e ative Aprovadores:

image781.jpg

Referente aos campos da tela:

Atores do projeto

Cadastre nesta tela os papéis dos usuários ou outros sistemas que interagem com o produto. Cada ator representará uma classe de usuários. A partir do menu Utilitários, acesse o menu Documentação e ative Atores:

image782.jpg

Referente aos campos da tela:

Casos de uso

Cadastre as funções completas do produto. A partir do menu Utilitários, acesse o menu Documentação e ative Casos de uso:

image783.jpg

Referente aos campos da tela:

Casos de Uso X Atores

Os relacionamentos indicam a existência de comunicação entre atores e casos de uso. Um caso de uso pode estar associado a mais de um ator, quando a sua execução requer a participação de diferentes atores. A partir do menu Utilitários, acesse o menu Documentação e ative Casos de uso X Atores:

image784.jpg

Referente aos campos da tela:

Benefícios do Projeto

Devem-se identificar os benefícios que se esperam obter com o produto e o valor desses para o cliente. O valor pode ser descrito simplesmente pela importância atribuída pelo cliente ou pode ser expresso de outras formas, inclusive quantitativas. A partir do menu Utilitários, acesse o menu Documentação e ative Benefícios:

image785.jpg

Referente aos campos da tela:

Interfaces

A interface do usuário é o que permite que as informações sejam transmitidas entre um usuário humano e os componentes de hardware ou software de um sistema de computador [IEEE, Std 610.12-1990]. A partir do menu Utilitários, acesse o menu Documentação e ative Interfaces:

image786.jpg

Referente aos campos da tela:

Interpretação dos campos

Como interpretar alguns campos de uma interface de usuário: a partir do menu Utilitários, acesse o menu Documentação e ative Interpretação dos Campos:

image787.jpg

Referente aos campos da tela:

Exemplo:

Tipo de restrição

Padrão

1

Obrigatoriedade

Para descrever a obrigatoriedade ou não de campos, devem ser utilizados os termos Obrigatório e Não obrigatório. Quando um campo for especificado como obrigatório, isto quer dizer que o usuário deverá especificar um valor não vazio para ele. Para os campos não obrigatórios, o usuário terá a opção de deixá-los vazios. A obrigatoriedade ou não obrigatoriedade deverá ser indicada explicitamente para todos os campos das interfaces

2

Possibilidade de alteração

Os termos Editável e Não editável não serão mais utilizados. A possibilidade de alteração dos valores dos campos pelos usuários deverá ser registrada por meio dos termos Alterável e Não alterável.

3

Campos multivalorados

Quando um campo puder conter mais de um valor dentre os seus valores válidos, será utilizado o termo Multivalorado. Quando nada for mencionado a esse respeito, será considerado que o campo poderá conter apenas um valor.

Limites

Devem-se determinar os limites do produto, ou seja, o que o sistema não fará. A partir do menu Utilitários, acesse o menu Documentação e ative Limites:

image788.jpg

Referente aos campos da tela:

Materiais de Referência

Devem-se cadastrar os materiais de consulta sobre o projeto. A partir do menu Utilitários, acesse o menu Documentação e ative Materiais de Referência:

image789.jpg

Referente aos campos da tela:

Modos de Operação

Devem-se cadastrar as atividades operacionais do projeto. A partir do menu Utilitários, acesse o menu Documentação e ative Modos de Operação:

image790.jpg

Referente aos campos da tela:

Observações sobre Relatórios

Descreva observações sobre os relatórios do sistema. A partir do menu Utilitários, acesse o menu Documentação e ative Observações sobre Relatórios:

image791.jpg

Referente aos campos da tela:

Requisitos Gerais

Descreva os requisitos adiados ou características do ambiente. A partir do menu Utilitários, acesse o menu Documentação e ative Requisitos Gerais:

image792.jpg

Referente aos campos da tela:

Restrições

Descreva as restrições do sistema. A partir do menu Utilitários, acesse o menu Documentação e ative Restrições:

image793.jpg

Referente aos campos da tela:

Versões

Cadastre as versões do projeto. A partir do menu Utilitários, acesse o menu Documentação e ative Versões:

image794.jpg

Referente aos campos da tela:

Observações sobre formulários

Cadastre comentários sobre o formulário. A partir do menu Utilitários, acesse o menu Documentação e ative Observações sobre formulários:

image795.jpg

Referente aos campos da tela:

Diagrama de Contexto

Documentação composta por fluxos de dados que mostram as interfaces entre o sistema e as entidades externas. A partir do menu Utilitários, acesse o menu Documentação e ative Diagrama de Contexto:

image796.jpg

Referente aos campos da tela:

Observações:

  1. Antes de realizar a impressão da documentação automática, as dependências devem ser atualizadas.

  2. Este recurso está disponível apenas para a versão Enterprise.

  3. As imagens dos fluxos só irão aparecer na documentação se eles estiverem vinculados a um evento.


Documentação automática - Este vídeo demonstra a utilização do recurso de documentação automática.

____________________________________________________________________________

image776.jpg

Caso este tópico não tenha comentário satisfatório, envie e-mail para documentacao@softwell.com.br