Está en la página 1de 22

SURICATE Versão 1.

0
Documentos de Caso de Uso 08/04/10

Sistema Único de Registro, Interatividade e Controle das


Atividades, Turmas e Estudantes

1
SURICATE Versão 1.0
Documentos de Caso de Uso 08/04/10

Histórico de Alterações
Versão Data Autor Descrição Localização

1 08/04/10 Todos Construção do WWW.alphatec.web


documento node.com.br

2
SURICATE Versão 1.0
Documentos de Caso de Uso 08/04/10

Conteúdo
[UC-02] Editar Professor .....................................................................................7

3
1. Introdução

1.1. Objetivo
Este documento busca apresentar todos os casos de uso do Sistema Suricate, cujo
qual tem como foco criar uma plataforma virtual de suporte ao docente. Esta parte do
projeto irá descrever minuciosamente cada um dos requisitos funcionais do sistema,
bem como mostrar suas principais funcionalidades.

1.2. Glossário
Este segmento do projeto explica o conceito sobre palavras e termos que serão
mencionados frequentemente ao logo do documento. Tais termos podem soar
entendíveis aos ouvidos do programador, mas isso dificilmente ocorrerá com um usuário
leigo, uma vez que este não possui um bom vocabulário sobre as palavras utilizadas no
mundo da informática. Os termos serão descritos na tabela abaixo, estando apresentados
por ordem alfabética.

Termo Descrição
[FS-XXX] Fluxo Secundário de numeração XXX
[UC-XX] Use Case de numeração XX
PRIORIDADE Desejável, Essencial, Importante
* Campo obrigatório
(PI) Página Inicial (HOME)
2. Diagrama de casos de uso
3. Descrição dos casos de uso

[UC-01] Cadastrar Professor

[UC-01]
Nome: Cadastrar Professor
Atores: Administrador
Prioridade: Essencial
Entradas e pré- O administrador estar cadastrado no sistema
condições: O administrador estar logado no sistema
Saídas e pós- O cadastro de professores será realizado.
condições:
Fluxos de eventos
1. Depois de o administrador efetuar logon, será exibido
uma tela principal, contendo opções administrativas
2. Ao escolher a opção administrativa “Cadastrar
Professor” serão exibidas ambiente com as seguintes
características:
Campos de informações para preenchimento:
• Nome Completo*
• Data de Nascimento*
• Sexo (M, F)*
• C.P.F.*
• R.G. (Número e Órgão Expedidor)*
• Estado*
• Cidade*
Fluxo principal:
• CEP*
• Bairro*
• Rua*
• Número*
• Telefone
• Número da Matrícula do Professor*
• Login*
• Senha*
[FS001]
[FS002]
Botões:
• Voltar (PI)
• Salvar

Caso não seja preenchido algum campo obrigatório, será


[FS001] visualizado um alerta, com os devidos campos a serem
preenchidos
[FS001] Não será permitido a criação de um login que já existe.
[UC-02] Editar Professor

[UC-01]
Nome: Editar Professor
Atores: Administrador e Professor
Prioridade: Importante
Entradas e pré- O administrador estar cadastrado no sistema
condições: O administrador estar logado no sistema
Saídas e pós- Um editor com os dados para edição será apresentada.
condições:
Fluxos de eventos
Fluxo principal: 1. Depois de o usuário efetuar logon, será exibido uma
tela principal de acordo com o seu perfil, contendo
opções de gerenciamento
2. Se o usuário for o professor, ao escolher a opção
“Editar meus dados” será exibido ambiente com as
seguintes características:
Campos de informações para edição:
• Nome Completo*
• Data de Nascimento*
• Sexo (M, F)*
• C.P.F.*
• R.G. (Número e Órgão Expedidor)*
• Estado*
• Cidade*
• CEP*
• Bairro*
• Rua*
• Número*
• Telefone
• Login*
• Senha*
[FS001]
Botões:
• Voltar (PI)
• Salvar

• Se o usuário for o administrador, ao escolher


a opção “Editar Professor” será exibido
ambiente de Pesquisa de professores:
• Campo para “Nome”
• Botão Pesquisar
[FS002]

1. Ao clicar no botão Pesquisar será exibido


a listagem com os nomes dos professores
ou professor, de acordo com o nome
digitado (campo chave), bem como a
opção “Editar” ao lado de cada nome.
2. Ao escolher a opção “Editar” serão
exibidos em com as seguintes
características:
Campos de informações para edição:
• Nome Completo*
• Data de Nascimento*
• Sexo (M, F)*
• C.P.F.*
• R.G. (Número e Órgão Expedidor)*
• Estado*
• Cidade*
• CEP*
• Bairro*
• Rua*
• Número*
• Telefone
• Número da Matrícula do Professor*
[FS003]

Botões:
• Voltar (PI)
• Salvar

Caso não seja preenchido algum campo obrigatório, será


visualizado um alerta, com os devidos campos a serem
[FS001]
preenchidos

Caso o campo “Nome” não seja preenchido, será


[FS002]
visualizado um alerta solicitando o preenchimento do campo
Caso não seja preenchido algum campo obrigatório, será
[FS003] visualizado um alerta, com os devidos campos a serem
preenchidos

[UC-03] Excluir Professor

[UC-01]
Nome: Excluir Professor
Atores: Administrador
Prioridade:Importante Importante
Entradas e pré- O administrador estar cadastrado no sistema
condições: O administrador estar logado no sistema
Saídas e pós- Exclusão do professor cadastro no sistema
condições:
Fluxos de eventos
• Depois de o administrador efetuar logon, será exibido
uma tela principal contendo opções administrativas
• Ao escolher a opção “Excluir Professor” será
exibido ambiente de Pesquisa de
professores:
• Campo para Nome
• Botão Pesquisar
[FS001]

Fluxo principal:
3. Ao clicar no botão “Pesquisar” será
exibido a listagem com os nomes dos
professores ou professor, de acordo com o
nome digitado (campo chave), bem como
a opção “Excluir” ao lado de cada nome.
4. Ao escolher a opção “Editar” será exibido
uma tela pedindo a confirmação da
referente exclusão.

Caso o campo “Nome” não seja preenchido, será


[FS001]
visualizado um alerta solicitando o preenchimento do campo

[UC-04] Logar no Sistema

[UC-01]
Nome: Logar no Sistema
Atores: Administrador, Professor
Prioridade: Essencial
Entradas e pré- Precisa-se que o usuário esteja cadastrado
condições:
Saídas e pós- O professor ou administrador entrará o sistema
condições:
Fluxos de eventos
• Ao entrar no site do sistema, haverá uma área para
login do usuário, caracterizada por:
• Login
Fluxo principal: • Senha
• Botão “OK”
[FS001]

Caso os campos não sejam preenchidos ou estiverem


incorretos, será visualizada uma tela de aviso afirmando que
[FS001]
os campos estão incorretos ou vazios sugerindo uma nova
tentativa ao usuário.
[UC-05]Adicionar Turma

[UC-05]
Nome: Adicionar Turma
Atores: Professores
Prioridade: Essencial
Usuário estar cadastrado;
Entradas e pré-
condições: Usuário estar logado.
Saídas e pós- Um cadastro de turma será exibido.
condições:
Fluxos de eventos
1. Após o usuário ter efetuado o logon, o sistema
apresentará um ambiente de acordo com o seu
perfil;
2. Nele terá um menu do lado esquerdo que conterá
a opção adicionar turma. Ao clicar nessa opção,
será exibido uma tela com:
Campos:
• Série;
• turma;
Fluxo principal:
• instituição;
[FS001]
Botões:
• Salvar
• Limpar campos
• Voltar (PI)
[FS002]

Caso não seja fornecido algum desses dados, o cadastro não


[FS001]
poderá ser gravado no sistema.
Caso os dados fornecidos sejam iguais a algum já registrado,
[FS002]
não será aceito salvar-los.

[UC-06] Editar turma

[UC-06]
Nome: Editar Turma
Atores: Professores
Prioridade: Importante
Entradas e pré- Usuário estar cadastrado;
condições: Usuário estar logado.
Saídas e pós- Um editor de turma será exibido.
condições:
Fluxos de eventos
1. Após o usuário ter efetuado o logon, o sistema
apresentará um ambiente de acordo com o seu perfil;
2. Nele terá um menu do lado esquerdo que conterá a
opção editar turma. Ao clicar nessa opção, será
exibido uma tela para localização da turma:
Menus suspensos:
• Série;
• turma;
Campo:
• instituição;
Botão:
• Pesquisar

Fluxo principal:
• Voltar (PI)
[FS001]
3. Feito a pesquisa, será exibido, abaixo, os campos
da turma, para edição, bem como uma lista com
os alunos pertencentes à turma com a opção de
deletar e editar (levará para tela de edição do
aluno) ao lado de cada um deles. São os campos
de edição:
• Série;
• Turma;
• Instituição;
Botão:
• Salvar;
[FS002]
Caso o usuário forneça informações não existentes, nada será
[FS001]
exibido e ele será notificado do erro ocorrido.
Caso na edição de dados algum dado coincidir com dados já
[FS002]
registrados , a edição não poderá ser efetuada.
[UC-07] Excluir turma

[UC-07]
Nome: Excluir turma
Atores: Professores
Prioridade: Importante
Entradas e pré- Usuário estar cadastrado;
condições: Usuário estar logado.
Saídas e pós- Um ambiente de exclusão de turmas será exibido.
condições:
Fluxos de eventos
1. Após o usuário ter efetuado o logon, será exibido
um ambiente de acordo com seus privilégios;
2. Nesse ambiente, ao lado esquerdo da tela, será
exibido um menu com a opção excluir turma;
3. Clicando nessa opção, será exibida uma tela para
pesquisa da turma que se deseja excluir, contendo
os seguintes elementos:
Menus suspensos:
• Série;
• turma;
Campo:
• instituição;
Botão:
Fluxo principal:
• Pesquisar ;
• Voltar (PI)
[FS001]
4. Ao pesquisar, será exibido, logo abaixo, um
relatório da turma, contendo o seguinte:
• Série;
• turma;
• instituição;
• e relação dos alunos pertencentes a turma
especificada.
Botão:
• Excluir.
[FS002]

Caso a pesquisa não encontre nada, será exibido uma


[FS001]
mensagem de notificação.
Quando o usuário clicar no botão de exclusão, será exibido
[FS001] uma mensagem notificando que a turma bem como todos os
alunos relacionados a ela será excluídos.
[UC-08] Adicionar alunos

[UC-08]
Nome: Adicionar alunos
Atores: Professores
Prioridade: Essencial
Entradas e pré- Usuário estar cadastrado;
condições: Usuário estar logado.
Saídas e pós- Uma ambiente para adição de alunos será exibido.
condições:
Fluxos de eventos
1. Após o usuário ter efetuado o logon, será exibido
um ambiente de acordo com seus privilégios;
2. Nesse ambiente, ao lado esquerdo da tela, será
exibido um menu com a opção adicionar turma;
3. Ao clicar nessa opção será exibido uma tela de
cadastro com as seguintes características:
Menus suspensos:
• Instituição
• Série
• Turma
[FS001]
Essas informações serão fornecidas para que o código da
turma, gerado automaticamente pelo sistema, seja
relacionado ao aluno.

Fluxo principal: Campos:


• Nome*
• E-mail*
• Estado
• Cidade
• CEP
• Rua
• Número
• Telefone
Botões:
• Voltar (PI)
• Limpar campos
• Salvar
[FS002]

Os menus suspensos posteriores ao Instituição só serão


mostrados caso o anterior tenha sido alimentado com algum
dado, pois será tomado como base sempre o último dado
[FS001]
escolhido pelo usuário para que só seja exibido como opção
nesse menu suspenso só o que tenha a ver com os dados
anteriores.
[FS002] Caso os campos obrigatórios sejam deixados em branco,
uma mensagem de alerta será exibida e os dados não serão
gravados até que seja preenchido todos esses campos.

[UC-09] Editar alunos

[UC-09]
Nome: Editar alunos
Atores: Professores
Prioridade: Importante
Entradas e pré- Usuário estar cadastrado;
condições: Usuário estar logado
Saídas e pós- Um ambiente de edição de dados do aluno será exibido.
condições:
Fluxos de eventos
Fluxo principal: 1. Após o utilizador ter efetuado o logon, será
apresentado um ambiente de acordo com seu
perfil;
2. Nesse ambiente, ao lado esquerdo da tela, será
exibido um menu com a opção editar aluno;
3. Clicando nessa opção, o usuário será levado a
uma tela de pesquisa que conterá:
Menus suspensos:
• Instituição
• Série
• Turma
• Nome
[FS001]
Botões:
• Voltar (PI)
• Pesquisar
4. Ao fazer a pesquisa, será exibido uma lista com
todos os alunos que coincidirem com os dados
fornecidos, e ao lado de seus nomes terá uma
opção de Editar Aluno.
5. Ao clicar nessa opção, o usuário será levado para
um ambiente de edição dos dados do referido
aluno que conterá:
Campos:
• Nome*
• E-mail*
• Estado
• Cidade
• CEP
• Rua
• Número
• Telefone
Botões:
• Voltar (PI)
• Limpar campos
• Salvar
[FS002]
6. Clicando em salvar, os dados serão atualizados.
Os menus suspensos posteriores ao Instituição só serão
mostrados caso o anterior tenha sido alimentado com algum
dado, pois será tomado como base sempre o último dado
[FS001]
escolhido pelo usuário para que só seja exibido como opção
nesse menu suspenso só o que tenha a ver com os dados
anteriores.
Caso os campos obrigatórios estejam vazios, o sistema não
[FS002]
irá gravar os dados e exibirá uma mensagem de alerta.

[UC-10] Excluir alunos

[UC-10]
Nome: Excluir alunos
Atores: Professores
Prioridade: Importante
Entradas e pré- Usuário estar cadastrado;
condições: Usuário estar logado.
Saídas e pós- • Exibe um ambiente para exclusão do (s) aluno (s).
condições:
Fluxos de eventos
1. Após o usuário ter efetuado o logon, o sistema
apresentará um ambiente de acordo com o seu perfil;
2. Nele terá um menu do lado esquerdo que conterá a
opção excluir alunos. Ao clicar nessa opção, será
exibido uma tela com:
Os menus suspensos:
• Instituição
• Série
Fluxo principal: • Turma
• Aluno
[FS001]

Botões:
• Voltar (PI)
• Excluir
[FS002]

Os menus suspensos posteriores ao Instituição só serão


mostrados caso o anterior tenha sido alimentado com algum
dado, pois será tomado como base sempre o último dado
[FS001]
escolhido pelo usuário para que só seja exibido como opção
nesse menu suspenso só o que tenha a ver com os dados
anteriores.
O aluno só será excluído se todos os menus suspensos
[FS002]
estiverem alimentados com dados válidos.
[UC-11] Adicionar plano de aula

[UC-11]
Nome: Adicionar plano de aula
Atores: Professores
Prioridade: Essencial
Entradas e pré- Usuário estar cadastrado.
condições: Usuário estar logado.
Saídas e pós- Uma tela para adicionar plano de aula será apresentada.
condições:
Fluxos de eventos
1. Após o usuário ter efetuado o logon, o sistema
exibirá um ambiente de acordo com o seu perfil;
2. Nele terá um menu do lado esquerdo que conterá a
opção adicionar plano de aula. Ao clicar nessa opção,
será exibido uma tela com:
Os campos:
• Tema
Fluxo principal: • Nível do Plano (Série)
• Data atual
• Descrição

Os botões:
• Salvar plano
• Voltar (PI)
[FS001]
Só será gravados os dados, caso todos os campos estejam
[FS001]
preeenchido.

[UC-12] Editar plano de aula


[UC-12]
Nome: Editar plano de aula
Atores: Professores
Prioridade: Importante
Entradas e pré- Usuário estar cadastrado.
condições: Usuário estar logado.
Saídas e pós- Será exibido uma tela para edição dos planos de aulas
condições: existentes.
Fluxos de eventos
Fluxo principal: 1. Após o usuário ter efetuado o logon, o sistema
exibirá um ambiente de acordo com o seu perfil;
2. Nele terá um menu do lado esquerdo que conterá a
opção editar plano de aula. Ao clicar nessa opção,
será exibido uma tela com:
Os menus suspensos para pesquisa do plano:
• Nível
• Data
• Tema do Plano
Botões
• Pesquisar
• Voltar (PI)
[FS001]

3. Para que o usuário tenha acesso a seu plano de aula,


antes, é preciso escolher uma opção válida por nível,
data e Tema do plano e em seguida clicar em
Pesquisar.
4. Após clicar em pesquisar será exibido, a baixo, os
campos do plano para edição. Com o botão:
• Salvar
[FS002]
Os menus suspensos iram aparecendo na ordem que está
[FS001]
cada vez que o usuário for preenchendo o anterior.
O botão salvar só será exibido após a pesquisa do plano ter
[FS002]
ocorrida com sucesso.

[UC-13] Excluir plano de aula

[UC-13]
Nome: Excluir plano de aula
Atores: Professores
Prioridade: Importante
Entradas e pré- Usuário estar cadastrado.
condições: Usuário estar logado.
Saídas e pós- Um ambiente de exclusão de plano de aula será exibido.
condições:
Fluxos de eventos
Fluxo principal: 1. Após o usuário ter efetuado o logon, o sistema
exibirá um ambiente de acordo com o seu perfil;
2. Nele terá um menu do lado esquerdo que conterá a
opção excluir plano de aula. Ao clicar nessa opção,
será exibido uma tela com:
Os menus suspensos para pesquisa do plano:
• Nível
• Data
O Campo:
• Tema do Plano

Os botões:
• Pesquisar
• Voltar (PI)
• Excluir

3. O usuário poderá fazer uma pesquisa por nível,


data de postagem do plano ou por tema.
[FS001]
4. Ao clicar em pesquisar o sistema exibirá a
relação dos dados encontrados a baixo.
5. Caso o utilizador queira excluir, bastará clicar
nos checkbox , que estarão ao lado de cada plano
de aula, correspondentes e em seguida clicar no
botão excluir.
Caso não haja nenhum registro com a característica
[FS001]
fornecida, o sistema exibirá uma mensagem informando.

[UC-14] Adicionar trabalho, atividades e/ou exercícios

[UC-14]
Nome: Adicionar trabalho, atividades e/ou exercícios
Atores: Professores
Prioridade: Essencial
Entradas e pré- Usuário estar cadastrado.
condições: Usuário estar logado.
Saídas e pós- Um ambiente de adição de atividades será exibido.
condições:
Fluxos de eventos
Fluxo principal: 1. Após o usuário ter efetuado o logon, o sistema
exibirá um ambiente de acordo com o seu perfil;
2. Nele terá um menu do lado esquerdo que conterá a
opção Adicionar atividade. Ao clicar nessa opção,
será exibido uma tela com:
Menus suspensos:
• Instituição*
• Série*
• Turma*
Essas informações serão fornecidas para que o código da
turma, gerado automaticamente pelo sistema, seja
relacionado a atividade.
Campos:
• Tema*
• Descrição*
• Data de prestação de contas*
• Data de expiração da atividade* (quando chegar
nessa data, o sistema irá excluí-la do banco de dados)
[FS001]
Checkbox:
• Notificar os alunos
Botões:
• Adicionar
• Voltar (PI)
3. Caso o usuário tenha marcado a opção de notificação,
o sistema irá mandar uma cópia da atividade para
todos os alunos da turma.
Caso algum campo obrigatório esteja em branco, uma
[FS001]
mensagem de notificação será exibida.

[UC-15] Visualizar atividades agendadas

[UC-15]
Nome: Visualizar atividades agendadas
Atores: Professores
Prioridade: Importante
Entradas e pré- Usuário estar cadastrado.
condições: Usuário estar logado.
Saídas e pós-condições: Um ambiente de visualização das atividades será exibido.
Fluxos de eventos
Fluxo principal: 1. Após o usuário ter efetuado o logon, o sistema
apresentará um ambiente de acordo com o seu perfil;
2. Nele terá um menu do lado esquerdo que conterá a
opção Visualizar atividades. Ao clicar nessa opção,
será exibido uma tela com:
Menus suspensos:
• Instituição*
• Série*
• Turma*
• Data de prestação de contas
• Tema
[FS001]
Botões:
• Pesquisar
• Voltar (PI)
3. Ao fazer a pesquisa o usuário terá uma lista abaixo
com todas as atividades , por temas, que se
relacionam com os dados passados. Ao lado de cada
tema conterá um link que levará para a página de
visualização dos dados completos.
4. Clicando nessa opção, o sistema levará para uma
tela de relatório da atividade que terá:
• Tema
• Descrição
• Data de prestação de contas
• Data de expiração da atividade (quando chegar
nessa data, o sistema irá excluí-la do banco de
dados)

Os menus suspensos posteriores ao Instituição só serão


mostrados caso o anterior tenha sido alimentado com algum
dado, pois será tomado como base sempre o último dado
[FS001]
escolhido pelo usuário para que só seja exibido como opção
nesse menu suspenso só o que tenha a ver com os dados
anteriores.

[UC-16] Notificar os alunos sobre as atividades

[UC-16]
Nome: Notificar os alunos sobre as atividades
Atores: Professores
Prioridade: Importante
Entradas e pré- Usuário ter adicionado atividade(s) anteriormente;
condições:
Saídas e pós- Automaticamente, a notificação da atividade será
condições: encaminhada aos alunos;
Fluxos de eventos
1. O sistema executará, uma vez por dia, um algoritmo
que vai ler as datas das atividades agendadas e
comparar com a do dia, caso a diferença entre elas
Fluxo principal:
seja de 2 dias, o sistema irá notificar todos os alunos
da turma que está relacionada com a atividade.
[FS001]
Caso não haja atividade ou as que tenham no sistema sejam
[FS001]
de datas anteriores, o sistema não notificará ninguém.

[UC-17] Visualizar calendário do mês

[UC-17]
Nome: Visualizar calendário do mês
Atores: Professores
Prioridade: Desejável
Entradas e pré- Usuário estar cadastrado.
condições: Usuário estar logado.
Saídas e pós- Mostrará um calendário do mês.
condições:
Fluxos de eventos
1. Após o usuário ter efetuado o logon, o sistema
exibirá o ambiente correspondente ao seu perfil;
Fluxo principal:
2. O calendário estará localizado nesse ambiente do
lado esquerdo da tela.
[UC-18] Pesquisar: atividades, alunos e turmas

[UC-18]
Nome: Pesquisar: atividades, alunos e/ou turmas
Atores: Professores
Prioridade: Importante
Entradas e pré- Usuário estar cadastrado.
condições: Usuário estar logado.
Saídas e pós- Listará as atividades, alunos e/ou turmas.
condições:
Fluxos de eventos
1. Após o usuário ter efetuado o logon, o sistema
exibirá um ambiente de acordo com o seu perfil;
2. Nele, opção de pesquisa será exibida abaixo do
menu esquerdo com os seguintes elementos:
Campo:
• Palavra-chave
Botão:
Fluxo principal: • Pesquisar
[FS001]
3. Após o usuário digitar a palavra chave e clicar no
botão pesquisar, o sistema fará uma busca e exibirá
uma tela com os dados encontrados.
4. Para que o usuário tenha acesso a algum desses
dados listados, ao lado de cada um deles aparecerá
uma opção de visualizar. Ao clicar nela o sistema
exibirá os dados do mesmo.
[FS001] Caso não seja encontrado nada, uma mensagem será exibida.

[UC-19] Alterar dados do administrador

[UC-20]
Nome: Alterar dados do administrador
Atores: Administrador
Prioridade: Essencial
Entradas e pré- Precisa-se que o usuário esteja cadastrado
condições: O administrador esteja logado
Saídas e pós- O administrador alterará seus próprios dados
condições:
Fluxos de eventos
1. Depois de o administrador efetuar logon, será exibido
uma tela principal contendo opções administrativas
2. Ao escolher a opção “Editar meus dados” será
exibido ambiente de edição para o
administrador,
Contendo os campos:
• Login
Fluxo principal:
• Senha
• Confirmação da senha
[FS001]

Botões:
• Salvar
• Voltar (PI)
As alterações só serão realizadas se os campos “Senha” e
[FS001]
“Confirmação da Senha”