A Documentação de Software
Por: fabiano451 • 21/6/2017 • Trabalho acadêmico • 1.440 Palavras (6 Páginas) • 269 Visualizações
[pic 1]
Documentação de Software
Sigla do sistema
(Nome do Sistema)
Analista Responsável..........: Marcos Lima
Programador...........................:
//
Logictel S.A – TI Sistemas
Sumário
Histórico de Revisão 2
Introdução 3
Objetivo do Software 3
Premissas 3
Definição de Requisitos 4
Requisitos Funcionais (explicar as funções e os responsáveis) 4
RF01. Nome da função 4
Requisitos Não-Funcionais 4
RNF01. Ambiente WEB 4
RNF02. Controlar acesso do usuário 4
Regras de Negocio 4
RN01. Nome da Regra 4
Casos de Uso 5
1. Nome do Caso de Uso 5
2. Nome dos Atores 5
3. Regras de negócio 5
4. Pré-condições 5
5. Pós-condição 5
Fluxo 6
Modelo de Dados 7
Modelo Relacional 7
Dicionário de Dados 7
Modelo Físico SQL 7
Layout das Telas 8
Relatórios: 8
Testes 9
Histórico de Revisão
Data | Descrição da alteração | Solicitante | Versão | Autor |
Introdução
Uma breve descrição do documento.
Objetivo do Software
Descrever os objetivos do sistema incluindo lista de ações.
- Listar alguns objetivos;
Premissas
Explicação do planejamento do projeto sendo o mais próximo do solicitado, descrever as funcionalidades
- Listar as ações e funções;
Definição de Requisitos
Requisitos Funcionais (explicar as funções e os responsáveis)
RF01. Nome da função
Informar as ações que as funções contêm.
Informar os Atores relacionados
Descrição detalhada das ações
Cadastro
Informe o ator e a ação a ser tomada:
Descreve os campos de preenchimento e as ações realizadas.
Requisitos Não-Funcionais
RNF01. Ambiente WEB
O Sistema deve estar disponível em plataforma WEB.
RNF02. Controlar acesso do usuário
Controla os acessos por meio de autenticação.
Regras de Negocio
Breve descrição das regras do sistema.
RN01. Nome da Regra
Descrição das regras.
Casos de Uso
Nome do Caso de Uso
Nome dos Atores
Regras de negócio
Pré-condições
Pós-condição
Fluxo
Modelo de Dados
Modelo Relacional
Dicionário de Dados
Entidade | tblUsuario | |||
Atributo | Domínio | Nulidade | Chave | Descrição |
usuRe | Varchar(15) | Not null | PK | RE ou RG sem o dígito verificador. |
usuNome | Varchar(60) | Not null | Nome do usuário | |
usuLogin | Varchar(15) | Not null | Login(“R” +RE ou “C”+RG sem o dígito verificador) | |
usuSenha | Varchar(15) | Not null | Senha de acesso ao sistema. | |
usuPerfil | Varchar(20) | Not null | Perfil de acesso | |
usuStatus | Char(2) | Not null | Status do usuário (“AT”= Ativo e “BL”=Bloqueado) | |
usuAlterarSenha | Char(1) | Not null | Alterar Senha (“S”= Sim e “N”=Não). | |
usuUsuarioCadastro | Varchar(15) | Not null | Usuário que realizou o cadastro | |
usuDtCadastro | Datetime | Not null | Data e Hora que realizou o cadastro. | |
usuUsuarioAlteracao | Varchar(15) | Not null | Usuário que realizou a alteração | |
usuDtAlteracao | Datetime | Not null | Data e Hora que realizou a alteração. |
...