Documento de Requisitos do Sistema versão 1.0

Transcrição

1 Documento de Requisitos do Sistema versão 1.0 Desenvolvimento do Sistema de Gestão de Documentos Doc Manager Cliente: São José Agroindustrial Representante do cliente: Paulo José de Souza

2 Ficha Técnica Equipe Responsável pela Elaboração Joabe José Willyan Marques Gerente de Qualidade/Testes Engenheiro de Software Público Alvo Este documento destina-se a equipe de engenheiros de software principalmente, gerencia de configuração, gerente de qualidade e analista de sistemas. Página 2 de 20

3 Histórico de Versão Data Versão Descrição Autor 07/05/ Elaboração do documento de requisitos Joabe / Willyan Documento de Requisitos do Usuário /FastSoftware Página 3 de 20

4 Sumário Introdução... 5 Visão geral deste documento...5 Convenções, termos e abreviações Identificação dos Requisitos Prioridades dos Requisitos...5 Referências... 6 Capítulo Descrição geral do sistema Escopo Negativo... 7 Descrição dos usuários...8 Capítulo Requisitos funcionais (casos de uso) Login... 9 [RF001] Efetuar Login Ator: Todos os atores...9 Manter Filial... 9 [RF002] Cadastrar Filial Ator: Administrador...9 [RF003] Consultar Filial...10 Manter Departamento...10 [RF004] Cadastrar Departamento...10 [RF005] Consultar Departamento...11 Manter Caixa [RF006] Cadastrar Caixa...11 [RF007] Consultar Caixa...12 Documentos [RF008] Manter Documentos...12 [RF009] Consultar Documento...13 Tipo de documento [RF010] Manter tipo de documento [RF011] Consultar tipo de documentos Ator: Administrador, e Operador...13 Ator: Administrador, operador e consulta...14 Manter Endereço de Localização...14 [RF012] Cadastrar Endereço de localização da caixa Ator: Administrador e operador.14 Documento de Requisitos do Usuário /FastSoftware Página 4 de 20

5 Mover documentos [RF013] Realocar documentos Ator: Administrador e Operador...15 [RF014] Consultar documentos realocados Ator: Administrador, operador...15 [RF015] Descartar documentos...15 [RF016] Consultar Documento Descartado...16 Capítulo Requisitos não funcionais Usabilidade [NF001] Interface Amigável...17 [NF002] Manual do Usuário...17 Confiabilidade...17 [NF003] Consistência dos dados...17 Desempenho [NF004] Tempo de resposta...17 [NF005] Acessos Simultâneos...17 [NF006] Falhas Segurança [NF007] Restrições de Acessos...18 [NF008] Criptografia dos Dados de Acesso...18 Padrões [NF009] Arquitetura...18 Hardware e software...18 [NF010] Hardware para Operação do sistema...18 [NF011] Framework...18 [NF012] Ferramenta para controle de versão...19 Documento de Requisitos do Usuário /FastSoftware Página 5 de 20

6 Introdução Este documento especifica o sistema Doc Manager, fornecendo aos desenvolvedores as informações necessárias para o projeto e implementação, assim como para a realização dos testes e homologação do sistema. Visão geral deste documento Na Seção 1 deste documento será apresentada uma breve introdução do que se trata o documento, uma visão geral do documento, descrição das prioridades dos requisitos e como os mesmos serão identificados. As demais seções apresentam a especificação do sistema Doc Manager e estão organizadas como descrito abaixo. Seção 2 - Descrição geral do sistema: apresenta uma visão geral do sistema, caracterizando qual é o seu escopo e descrevendo seus usuários. Seção 3 - Requisitos funcionais (casos de uso): especifica todos os requisitos funcionais do sistema, descrevendo os fluxos de eventos, prioridades, atores, entradas e saídas de cada caso de uso a ser implementado. Seção 4 - Requisitos não funcionais: especifica todos os requisitos não funcionais do sistema, divididos em requisitos de usabilidade, confiabilidade, desempenho, segurança, distribuição, adequação a padrões e requisitos de hardware e software. Convenções, termos e abreviações A correta interpretação deste documento exige o conhecimento de algumas convenções e termos específicos, sendo os termos e abreviações descritos no glossário do projeto. 1. Identificação dos Requisitos Por convenção, a referência a requisitos é feita através identificador do requisito seguindo com um número sequêncial, como mostrado abaixo: [identificador do requisito.número de sequência] Por exemplo, o requisito Cadastrar Aluno, [RF002] - Cadastrar Filial, está descrito com uma referência RF e número de sequência 002, em um bloco identificador []. Assim da mesma forma para os requisitos não funcionais. E para a referência das regras de negócios dos requisitos, seguirá com o: [identificador.do.requisitos.nº.sequência-identificador.regra de negócio.nº.sequência] Por exemplo, o requisito Cadastrar filial [RF016-RN001], a sequência da regra de negócio será de acordo com o requisito, sendo zerada a sequência ao mudar para outro requisito. Documento de Requisitos do Usuário /FastSoftware Página 6 de 20

7 2. Prioridades dos Requisitos Para estabelecer a prioridade dos requisitos foram adotadas as denominações essencial, importante e desejável. Essencial é o requisito sem o qual o sistema não entra em funcionamento. Requisitos essenciais são requisitos imprescindíveis, que têm que ser implementados impreterivelmente. Importante é o requisito sem o qual o sistema entra em funcionamento, mas de forma não satisfatória. Requisitos importantes devem ser implementados, mas, se não forem, o sistema poderá ser implantado e usado mesmo assim. Desejável é o requisito que não compromete as funcionalidades básicas do sistema, isto é, o sistema pode funcionar de forma satisfatória sem ele. Requisitos desejáveis são requisitos que podem ser deixados para versões posteriores do sistema, caso não haja tempo hábil para implementá-los na versão que está sendo especificada. Referências 1. Não se aplica Documento de Requisitos do Usuário /FastSoftware Página 7 de 20

8 Capítulo 1 Descrição geral do sistema 1 O sistema Doc Manager é um software de gestão eletrônica de documento que desenvolvido inicialmente para atender uma problemática real do nosso cliente (São José Agroindustrial), voltado para atender as necessidades de gestão dos documentos que são processados internamente na empresa e requerem uma guarda obrigatória por um período de tempo prédeterminado pelo tipo de documento a ser guardado, onde o setor responsável por esta atividade leva muito tempo através de processos manuais para localizar documentos que estão alocados dentro das caixas. O Software Doc Manager vem para sistematizar e otimizar consultas de documentos alocados dentro das caixas usando poucos cliques de forma ágil. Através desta ferramenta os usuários poderão cadastrar filiais (Empresas pertencentes ao grupo Cavalcanti Petribu), cadastrar departamentos (Setores internos de cada filial), cadastrar caixas (Atribuindo sua localização no sistema mediante sua localização física dentro do setor), cadastro dos documentos (Indexando o mesmo a caixa já criada), terão acesso a consultas que irão auxiliar nas demandas diárias do setor fazendo com que as atividades rotineiras sejam executadas com agilidade aumentando o tempo de resposta para atender as solicitações dos setores que usam o serviço guarda de documento. Escopo Negativo Devido à grande dimensão que o projeto pode alcançar, faz necessário não só definir no escopo apenas aquilo que será feito, mas citando também o que não fará parte do escopo. Algumas funcionalidades foram avaliadas por toda a equipe como sendo de uma maior atenção, comprometendo assim apenas o desenvolvimento das funcionalidades citadas, não está sendo parte do escopo as seguintes funcionalidades: Função backup: O sistema gera o backup dos documentos, mas onde esse arquivo de backup será armazenado será de total responsabilidade do cliente. Documento de Requisitos do Usuário /FastSoftware Página 8 de 20

9 Descrição dos usuários NÚMERODE DE ORGEM ATOR DEFINIÇÃO Ator-001 Administrador: O ator que possuir o perfil de administrador, terá acessos a todas as funcionalidades disponíveis do sistema. Onde o mesmo devera atribuir todas as permissões de acesso conforme o nível de privilegio que o ator deve ter dentro do sistema. Ator-002 Operador: O ator que possuir o perfil de Operador terá a mesma autoridade que o Administrador, com exceção de Cadastrar usuários, Filiais. Ator-003 Consulta O ator que possui o perfil Consulta, será limitado a acessar documentos onde o mesmo só poderá ter acesso a documentos que possui o status de privacidade publico. Documento de Requisitos do Usuário /FastSoftware Página 9 de 20

10 Capítulo 2 Requisitos funcionais (casos de uso) 2 Login [RF001] Efetuar Login Ator: Todos os atores Prioridade: Essencial Entradas e pré-condições: Para ser autenticado no sistema, os atores precisaram estar com seus perfis de acesso ativos. Deve ser informado os seguintes dados como entrada: Login (primeiro. ultimo nome) do usuário e senha de acesso. Ao se autenticar o sistema deve verificar se os dados informados estão corretos e se o usuário está ativo no sistema. Saídas e pós-condições: Ao ser validada a autenticação, o usuário será redirecionado para a página inicial do sistema. no documento de casos de uso [UC-001]. Manter Filial [RF002] Cadastrar Filial Ator: Administrador Prioridade: Essencial Entradas e pré-condições: Para realizar o cadastro o ator deve estar logado no sistema. Deve ser informado os seguintes dados como entrada por meio de um formulário: CJPJ, Razão social, Nome fantasia, Código, Nome do responsável, do responsável. 1. Após o cadastro da filial, a mesma só poderá ser excluída se não houver nenhum vínculo de outras partes do sistema atrelado a ela, por exemplo, vínculo com alguma caixa cadastrada. Saídas e pós-condições: Ao ser finalizado o cadastro, os dados obrigatórios devem ser validados, e posteriormente salvos no sistema. A filial está incluída no sistema. no documento de casos de uso [UC-002]. Documento de Requisitos do Usuário /FastSoftware Página 10 de 20

11 [RF003] Consultar Filial Ator: Administrador, Operador e Consulta. Prioridade: Importante Entradas e pré-condições: Para realizar a consulta o ator deve estar logado no sistema. Pode ser informado os seguintes dados como entrada para filtro: Nome da filial, e CNPJ. 1. Na listagem das filiais na tabela de dados terá a opção visualizar, editar, excluir para cada registro, sendo o editar e excluir exclusivo para o Administrador. Saídas e pós-condições: Listar a ou as instituições desejadas. no documento de casos de uso [UC-003] Manter Departamento [RF004] Cadastrar Departamento Ator: Administrador e Operador Prioridade: Essencial Entradas e pré-condições: Para realizar o cadastro os atores devem estar logados no sistema. Deve ser informado os seguintes dados como entrada por meio de um formulário: Nome do departamento, filial pertencente, nome do responsável. 1. Para cadastro do departamento, deve haver uma filial já cadastrada no sistema. Saídas e pós-condições: Ao ser finalizado o cadastro, os dados obrigatórios devem ser validados, e posteriormente salvos no sistema. O departamento está incluído. no documento de casos de uso [UC-004]. [RF005] Consultar Departamento Ator: Administrador, Operador Documento de Requisitos do Usuário /FastSoftware Página 11 de 20

12 Prioridade: Importante Entradas e pré-condições: Para realizar a consulta o ator deve estar logado no sistema. Pode ser informado os seguintes dados como entrada para filtro: Código, Nome do departamento, Filial atribuída. 1. Na listagem das departamento na tabela de dados terá a opção visualizar, editar para cada registro, editar e excluir não estará disponível para usuário Operador e consulta. Saídas e pós-condições: Listar o ou os departamentos desejados. no documento de casos de uso [UC-005] Manter Caixa [RF006] Cadastrar Caixa Ator: Administrador e Operador Prioridade: Essencial Entradas e pré-condições: Para realizar o cadastro os atores devem estar logados no sistema. Deve ser informado os seguintes dados como entrada por meio de um formulário: Tipo de documento contido, Data de criação, Localização, Filial pertencente, Data descarte, Departamento pertencente, Validade dos documentos, Período dos documentos contidos inicio/fim, Observações. 1. Para cadastro caixa, deve haver uma filial e departamento já cadastrados no sistema. Saídas e pós-condições: Ao ser finalizado o cadastro, os dados obrigatórios devem ser validados, e posteriormente salvos no sistema. A caixa está incluída no sistema. no documento de casos de uso [UC-006]. Documento de Requisitos do Usuário /FastSoftware Página 12 de 20

13 [RF007] Consultar Caixa Ator: Administrador, Operador e Consulta Prioridade: Importante Entradas e pré-condições: Para realizar a consulta o ator deve estar logado no sistema. Podem ser informados os seguintes dados como entrada para filtro: Numero, Tipo de documento contido na caixa, data de criação, localização, filial pertencente, data de descarte dos documentos contidos, departamento pertencente, validade dos documentos contidos, período dos documentos contidos (data inicial, e final). 1. Na listagem das caixas na tabela de dados terá a opção visualizar documentos contidos, editar e excluir. 2. As caixas só poderão ser excluídas se elas ainda não estiverem vinculadas com outras funcionalidades do sistema, por exemplo, vinculada a algum documento ou departamento. Saídas e pós condições: Listar a ou as disciplinas desejadas. no documento de casos de uso [UC-007] Documentos [RF008] Manter Documentos Ator: Administrador e Operador Prioridade: Essencial Entradas e pré-condições: Para realizar o cadastro dos documentos os atores devem estar logados no sistema. Deve ser informado os seguintes dados como entrada por meio de um formulário: Tipo de documento, Número do documento, data de emissão, localização, filial pertencente, data de descarte do documento, departamento pertencente, validade do documento, documento digitalizado, observações. 1. Os campos Tipo de documento, Localização, Filial pertencente, e Departamento pertencente, devem estar previamente cadastrados no sistema. Saídas e pós-condições: Ao ser finalizado o cadastro, os dados obrigatórios devem ser validados, e posteriormente salvos no sistema. O documento está incluído no sistema. Documento de Requisitos do Usuário /FastSoftware Página 13 de 20

14 no documento de casos de uso [UC-008]. [RF009] Consultar Documento Ator: Administrador, Operador e Consulta Prioridade: Importante Entradas e pré-condições: Para realizar a consulta os atores devem estar logados no sistema. Podem ser informados os seguintes dados como entrada para filtro: Tipo de documento, Número do documento, data de emissão, localização, filial pertencente, data de descarte do documento, departamento pertencente, validade do documento, documento digitalizado. 1. Na listagem dos documentos na tabela de dados terá a opção visualizar, editar e excluir. 2. Os documentos só poderão ser excluídos se eles ainda não estiverem vinculados com outras funcionalidades do sistema, por exemplo, vinculado a algum departamento. Saídas e pós-condições: Listar o ou os documentos desejados. no documento de casos de uso [UC-009] Tipo de documento [RF010] Manter tipo de documento Ator: Administrador, e Operador Prioridade: Essencial Entradas e pré-condições: Para realizar o cadastro dos tipos de documentos os atores devem estar logados no sistema. Deve ser informado o seguinte dado como entrada por meio de um formulário: Descrição do tipo de documento. Saídas e pós-condições: Ao ser finalizado o cadastro, os dados obrigatórios devem ser validados, e posteriormente salvos no sistema. O documento está incluído no sistema. no documento de casos de uso [UC-010]. Documento de Requisitos do Usuário /FastSoftware Página 14 de 20

15 [RF011] Consultar tipo de documentos Ator: Administrador, operador e consulta. Prioridade: Importante Entradas e pré-condições: Para realizar a consulta os atores devem estar logados no sistema. Podem ser informado o seguinte dado como entrada para filtro: Descrição do tipo do documento. 1. Na listagem dos tipos de documentos na tabela de dados terá a opção editar e excluir. 2. Os tipos de documentos só poderão ser excluídos se eles ainda não estiverem vinculados com outras funcionalidades do sistema, por exemplo, a um documento. Saídas e pós-condições: Listar a ou as séries desejadas. no documento de casos de uso [UC-011] Manter Endereço de Localização [RF012] Cadastrar Endereço de localização da caixa Ator: Administrador e operador. Prioridade: Essencial Entradas e pré-condições: Para realizar o cadastro dos endereços os atores devem estar logados no sistema. Prateleira, Rua. Saídas e pós-condições: Ao ser finalizado o endereço, os dados obrigatórios devem ser validados, e posteriormente salvos no sistema. no documento de casos de uso [UC-012]. Documento de Requisitos do Usuário /FastSoftware Página 15 de 20

16 Mover documentos [RF013] Realocar documentos Ator: Administrador e Operador Prioridade: Essencial Importante Desejável Entradas e pré-condições: Para realocar os documentos os atores devem estar logados no sistema. Deve ser informado os seguintes dados como entrada por meio de um campo de busca: Data de descarte, período de descarte, departamento. Saídas e pós-condições: Ao ser finalizado a realocação do documento, os dados obrigatórios devem ser validados, e posteriormente movidos dentro do sistema. A realocação foi efetuada dentro do sistema. no documento de casos de uso [UC-013]. [RF014] Consultar documentos realocados Ator: Administrador, operador. Prioridade: Importante Entradas e pré-condições: Para realizar a consulta os atores devem estar logados no sistema. Podem ser informados os seguintes dados como entrada para filtro: Data de descarte, período de descarte, departamento, data que foi realocado, mês que foi efetuada a realocação. 1. Na listagem das turmas na tabela de dados terá a opção de baixar o documento. Saídas e pós-condições: Listar a ou as documentos que foram realocados. no documento de casos de uso [UC-014] [RF015] Descartar documentos Ator: Administrador, Operador Prioridade: Essencial Entradas e pré-condições: Para realizar o descarte do documento os atores devem estar logado no sistema. Deve ser consultado o documento por meios dos filtros (data de vencimento, mês de vencimento) que esta com a validade (período de descarte) no prazo e descarta-los para um arquivo morto onde ficara por tempo indeterminado. Documento de Requisitos do Usuário /FastSoftware Página 16 de 20

17 Saídas e pós condições: Ao ser finalizado o descarte. O documento esta descartado com sucesso. Qualquer informação com relação ao fluxo de eventos e fluxos secundários estão contidos no documento de casos de uso [UC-015]. [RF016] Consultar Documento Descartado Ator: Apenas do tipo Super-Administrador Prioridade: Importante Entradas e pré-condições: Os atores devem estar cadastrados e logados no sistema. Entradas e pré-condições: o finalizar a ação, o sistema trará o resultado dos documentos que foram descartados. Qualquer informação com relação a como realizar essa ação no sistema, poderá ser vista no documento de casos de uso com o identificador [UC-016]o passo-apasso. Documento de Requisitos do Usuário /FastSoftware Página 17 de 20

18 Capítulo 3 Requisitos não funcionais 3 Usabilidade [NF001] Interface Amigável O sistema Doc Manager precisa ter uma interface bastante amigável, com simplicidade e intuitiva. Tendo como preocupação a usabilidade do software com relação a experiência dos usuários finais para com o uso do computador, sendo as mensagens de erros bem explicativas, indicando ao usuário como o mesmo deve agir, incluindo validações na entrada dos dados, fazendo uso de linguagens menos técnicas afim de facilitar o entendimento dos usuários. [NF002] Manual do Usuário O sistema deve disponibilizar um manual para facilitar e esclarecer eventuais dúvidas para com uso da ferramenta. Confiabilidade [NF003] Consistência dos dados Em algum processamento dos dados de forma mais robusta, o sistema deve fazer uso de transações afim de evitar possíveis problemas com os dados armazenados, retornando no caso para um estado anterior mais consistente. Desempenho [NF004] Tempo de resposta O sistema deve demandar de uma certa agilidade tanto para as atividades realizadas quanto interatividades com a ferramenta, tendo um tempo de respostas das ações realizadas não maior que 7 segundos. [NF005] Acessos Simultâneos O sistema deve demandar de uma capacidade de processamento para o acesso simultâneo dos usuários, devido a ferramenta ser desenvolvida para atingir um grande número de usuários, sendo esse operando no sistema ao mesmo tempo.

19 [NF006] Falhas A aplicação deve estar livre de falhas afim de não prejudicar a agilidade do processo de implantação principalmente para o caso de apresentação e treinamento do sistema para os usuários finais. Segurança [NF007] Restrições de Acessos Para a confiança dos dados do cliente será desenvolvido um serviço para autenticação por meio de login e senha para poder acessar ao sistema, tendo para cada perfil de usuário um controle das permissões em utilizar determinadas funcionalidades. [NF008] Criptografia dos Dados de Acesso Para uma melhor segurança dos dados utilizados para autenticação do sistema, as senhas geradas para os usuários devem ser criptografadas afim de evitar que as mesmas sejam violadas com facilidade. Padrões [NF009] Arquitetura Será necessário o uso do padrão de arquitetura MVC, para uma melhor reutilização e organização do código, melhor controle das requisições e processamento das mesmas. Hardware e software [NF010] Hardware para Operação do sistema Os computadores que forem utilizados para acessar o sistema Doc Manager devem ter no mínimo um processador Celeron 200MHz, memória RAM de 512MB, sendo essas configurações necessário para que não aja lentidão para o uso do navegador, pois o sistema será web e rodara na intranet, e não necessita de muitos recursos do computador que for utilizado para usar a aplicação. [NF011] Framework Será de grande importância fazer uso de algum Framework, no caso estará sendo usado a

20 Framework Locaweb Style (Front-End), que atribua agilidade e produtividade para o desenvolvimento do sistema, que ofereça uma melhor organização dos componentes do software, mantendo uma melhor manutenção do mesmo para procedimentos de falhas e evolução. [NF012] Ferramenta para controle de versão Deve ser utilizado uma ferramenta para controle de versão, ou a Git ou Subversion, para realizar o versionamento do sistema conforme for sendo estabilizada os itens e configuração e release do software.