Engenharia de Software 2016/201 Grupo 5E1D Software Requirements Specification for Web Dashboard for Git Versão 1.0 Cátia Mourão 2014210939 cmourao@student.dei.uc.pt Ivo Carvalho 2009112219 ivoc@student.dei.uc.pt Jorge Figueiredo 2014213266 jfcunha@student.dei.uc.pt Marta Esteves 2014206799 mesteves@student.dei.uc.pt Thomas Almeida 2009112219 thomasa@student.dei.uc.pt Franciso Fernandes 2014200243 ffernand@student.dei.uc.pt 30 de Setembro de 2016
Conteúdo 1 Histórico de Revisões 3 2 Introdução 4 2.1 Objectivo................................. 4 2.2 Convenções do Documento........................ 4 2.3 Público-Alvo do Documento e Sugestões de Leitura.......... 4 2.4 Scope do Producto............................ 4 2.5 Referências................................ 5 3 Descrição Overall 6 3.1 Perspectiva do Produto.......................... 6 3.2 Funções do Produto............................ 6 3.3 Características e Classes do Utilizador................. 7 3.4 Operating Environment......................... 7 3.5 Restrições de Design e Implementação................. 7 3.6 Documentação do Utilizador....................... 7 4 External Interface Requirements 8 4.1 Interfaces do Utilizador.......................... 8 4.2 Interfaces do Hardware.......................... 8 4.3 Interfaces do Software.......................... 8 4.4 Interfaces de Comunicações....................... 8 5 Funcionalidades do Sistema 9 5.1 Membros do Projecto........................... 9 5.1.1 Descrição e Prioridade...................... 9 5.1.2 Sequências de Estimulo/Resposta................ 9 5.1.3 Requisitos Funcionais....................... 9 5.2 Repositório de Ficheiros......................... 9 5.2.1 Descrição e Prioridade...................... 9 5.2.2 Sequências de Estimulo/Resposta................ 10 5.2.3 Requisitos Funcionais....................... 10 5.3 Commits.................................. 10 5.3.1 Descrição e Prioridade...................... 10 5.4 Sequências de Estímulo/Resposta.................... 11 5.4.1 Requisitos Funcionais....................... 11 5.5 Ver Requisitos de um projecto...................... 11 5.5.1 Descrição e Prioridade...................... 11 5.5.2 Sequências de Estímulo/Resposta................ 11 5.5.3 Requisitos Funcionais....................... 11 5.6 Ver Tarefas de um projecto....................... 12 5.6.1 Descrição e Prioridade...................... 12 5.6.2 Sequências de Estimulo/Resposta................ 12 5.6.3 Requisitos Funcionais....................... 12 5.7 Scorecard................................. 13 Universidade de Coimbra 1
5.7.1 Descrição e Prioridade...................... 13 5.7.2 Sequências de Estimulo/Resposta................ 13 5.7.3 Requisitos Funcionais....................... 13 5.8 Modelos de Processos........................... 13 5.8.1 Descrição e Prioridade...................... 13 5.8.2 Sequências de Estimulo/Resposta................ 13 5.8.3 Requisitos Funcionais....................... 14 6 Outros Requisitos Funcionais 14 6.1 Requisitos de Performance........................ 14 6.2 Safety Requirements........................... 14 6.3 Security Requirements.......................... 14 6.4 Atributos de Qualidade de Software................... 14 6.5 Regras de Negócio............................ 14 7 Outros Requisitos 14 Universidade de Coimbra 2
1 Histórico de Revisões Nome Data Razões de Alterações Versão Cátia 30/09/2016 Criação do Documento 1.0 Universidade de Coimbra 3
2 Introdução 2.1 Objectivo Neste documento os requisitos especificados são retirados da primeira entrevista com o cliente e da descrição inicial do projecto. Este projecto vem do âmbito da disciplina Engenharia de Software no ano lectivo 2016/2017 da Faculdade de Ciências e Tecnologias da Universidade de Coimbra. O produto final será uma web dashboard que será integrada num sistema Git. 2.2 Convenções do Documento Na descrição dos requisitos, as prioridades dos requisitos de alto nível são herdadas pelos requisitos mais detalhados. 2.3 Público-Alvo do Documento e Sugestões de Leitura Os leitores deste documento são os clientes (neste caso os professores que lecionam a disciplina de Engenharia de Software) e os membros da equipa que vai implementar o projecto. Recomenda-se a leitura da secção 3.1 e 3.2. Nestas secções serão apresentados o contexto e o sumário das principais funcionalidades do producto a desenvolver. De seguida, na secção 5, serão detalhados os requisitos do producto. 2.4 Scope do Producto Os requisitos a serem especificados são para a implementação de uma web Dashboard para o Git. Esta dashboard permitirá às equipas uma melhor organização dos seus projectos. Para tal, serão introduzidas formas de gestão dos ficheiros, dos membros e das tarefas do projecto. Também serão disponibilizadas várias estatísticas como o esforço que cada membro pôs no projecto, assim como, a satisfação da equipa. Universidade de Coimbra 4
2.5 Referências [1] https://docs.gitlab.com/ce/api/ [2] https://git.dei.uc.pt/ [3] https://git-scm.com/ Universidade de Coimbra 5
3 Descrição Overall 3.1 Perspectiva do Produto O produto a ser desenvolvido utiliza um sistema já existente, o git do DEI (Departamento de Engenharia Informática). O Git é um sistema de controle de versão de ficheiros em que se pode desenvolver projectos nos quais várias pessoas podem simultaneamente contribuir, editando e criando novos ficheiros sem o risco de as suas alterações serem sobrescritas. A Dashboard a ser produzida utilizará informações adquiridas através da API do git do DEI. As informações serão processadas e utilizadas para a implementação de mais funcionalidades do que as da dashboard atual. 3.2 Funções do Produto O produto final vai permitir ao utilizador fazer várias operações como gerir tarefas, requisitos, ficheiros e os membros. As funções vão ser apresentadas mais detalhadamente na secção 5. De seguida é apresentado um diagrama das principais funcionalidades. Universidade de Coimbra 6
3.3 Características e Classes do Utilizador 3.4 Operating Environment 3.5 Restrições de Design e Implementação 3.6 Documentação do Utilizador Universidade de Coimbra 7
4 External Interface Requirements 4.1 Interfaces do Utilizador 4.2 Interfaces do Hardware 4.3 Interfaces do Software 4.4 Interfaces de Comunicações Universidade de Coimbra 8
5 Funcionalidades do Sistema 5.1 Membros do Projecto 5.1.1 Descrição e Prioridade O utilizador vai poder ver a listagem, as funções e as contribuições dos membros que fazem parte da equipa do projecto. Prioridade: Alta 5.1.2 Sequências de Estimulo/Resposta Estímulo O utilizador seleciona a opção Members no menu. Seleciona o menu de permissões de um membro. Seleciona função do membro. Seleciona o menu dos membros. Seleciona Delete Member. Seleciona o membro a remover. Seleciona New member Seleciona Import Member. Seleciona o projecto. Resposta Mostra a listagem dos m Mostra várias funções para É aplicada essa função ao Mostra as opções de m Mostra lista dos membros possi Remove o membro e envia a mensagem Pergunta qual o utilizador que pretende ad Mostra os projectos em que o ut Importa os membros do projec 5.1.3 Requisitos Funcionais REQ-1: Ver esforço de um membro específico do projecto. O utilizador pode ver o esforço que cada membro dedicou ao projecto. REQ-2: Definir função (role) de cada membro do projecto. Cada membro pode ter atribuido uma função específicao utilizador, pode editar as funções de cada membro da sua equipa. 5.2 Repositório de Ficheiros 5.2.1 Descrição e Prioridade Aqui serão apresentadas todas as funcionalidades relativas a ficheiros do projecto. Universidade de Coimbra 9
Prioridade: Alta 5.2.2 Sequências de Estimulo/Resposta Estímulo O utilizador acede à listagem de ficheiros. Clicar numa pasta. Clicar no botão de informação. Clicar no botão de voltar. Resposta É mostrado os ficheiros da árvore do É mostrado o conteúdo dessa mostra o caminho do ficheiro (file path),o tamanho, É mostrado o conteúdo da pasta 5.2.3 Requisitos Funcionais REQ-3: Ver listagem dos ficheiros do projecto. Todos os ficheiros e pastas serão apresentados aqui, o que vai permitir ao utilizador escolher o ficheiro que pretende visualizar. REQ-4: Navegar na hierarquia de ficheiros do projecto. Através de cliques, o utilizador pode navegar na hierarquia de ficheiros. Ao clicar em cada pasta os ficheiros que estão dentro da pasta são listados. Também poderá abrir a pasta onde se encontrava anteriormente. REQ-5: Ver ciclo de vida de um ficheiro específico. O utilizador poderá ver o ciclo de vida de um ficheiro. Isto inclui toda a informação, isto é, datas e autores sobre a criação, as alterações e a eliminação. REQ-6: Ver os membros que participaram num ficheiro específico. Cada ficheiro terá a informação disponível sobre os seus autores. 5.3 Commits 5.3.1 Descrição e Prioridade Nesta secção é mostrada todas as alterações que os membros do projecto fizeram ao repositório, identificando a data de alteração, o branch a que foi submetida a alteração, assim como, o membro que a submeteu. Prioridade: Alta Universidade de Coimbra 10
5.4 Sequências de Estímulo/Resposta Estímulo Seleciona no menu a opção Commits. Resposta É mostrada a listagem dos commits por data. 5.4.1 Requisitos Funcionais REQ-7: Ver todas as contribuições feitas por um membro do projecto especifico. Aqui são apresentadas todas as contribuições que um membro fez. Estas contribuições incluem, apoio dado a outros membros do projecto, contribuições de ficheiros, a qualidade dos artefactos produzidos e o esforço. 5.5 Ver Requisitos de um projecto 5.5.1 Descrição e Prioridade O utilizador terá a possibilidade de ver quais são os requisitos do projecto em que está inserido. Prioridade: Média 5.5.2 Sequências de Estímulo/Resposta 5.5.3 Requisitos Funcionais REQ-8: Adicionar Requisito. É permitido ao utilizador adicionar mais requisitos à lista de requisitos do projecto. REQ-9: Ver lista de Requisitos Vai ser disponibilizada uma listagem dos requisitos que a equipa tem para o produto que estarão a desenvolver. Nesta lista, os requistos estarão organizados por ordem de prioridade e de esforço estimado. REQ-10: Estimar esforço previsto para cada requisito do projecto. Ao adicionar um novo requisito, será perguntado ao utilizador uma estimativa de esforço previsto que o desenvolvimento do requisito implica. Universidade de Coimbra 11
REQ-11: Estabelecer uma prioridade para um requisito. Será possivel ao utilizador atribuir uma prioridade ao requisito. As prioridades disponíveis serão: Alta, Média e Baixa. 5.6 Ver Tarefas de um projecto 5.6.1 Descrição e Prioridade Esta funcionalidade permite aos membros da equipa organizarem as tarefas para a realização do projecto. Prioridade: Média. 5.6.2 Sequências de Estimulo/Resposta 5.6.3 Requisitos Funcionais REQ-12: Adicionar Tarefa. O utilizador pode adicionar uma tarefa à lista das já existentes. REQ-13: Ver lista de Tarefas. Numa secção da dashboard, será apresentada uma listagem de tarefas para a realização do projecto. REQ-14: Atribuir estado a uma Tarefa. Ao ir avançando na execução de uma determinada tarefa, o responsável pela tarefa pode atribuir vários estados (To Do, In progess, Testing and Done). REQ-15: Adicionar um tempo previsto dedicado a uma Tarefa. Ao adicionar uma tarefa nova, é pedido ao utilizador para estabelecer um tempo previsto para a execução da tarefa. Se o tempo previsto for ultrapassado, o membro responsável pela tarefa é avisado. REQ-16: Categorizar uma Tarefa pelas categorias RUP. O utilizador, quando adiciona uma nova tarefa, pode-lhe atribuir uma categoria RUP.4 REQ-17: Atribuir um membro responsável pela execução de uma Tarefa. As tarefas podem ser associadas a um membro específico da equipa que fica responsável pela sua execução. Universidade de Coimbra 12
5.7 Scorecard 5.7.1 Descrição e Prioridade Nesta parte é possivel analisar a satisfação dos membros de uma equipa com estatísticas obtidas por inquéritos respondidos por cada membro. Prioridade: Média 5.7.2 Sequências de Estimulo/Resposta 5.7.3 Requisitos Funcionais REQ-18: Ver estatísticas de satisfação dos membros do projecto. O utilizador poderá ver a satisfação da sua equipa através de gráficos que mostrarão as estatisticas de satisfação. REQ-19: Responder a inquérito sobre a sua satisfação com a equipa e o projecto. O utilizador pode contribuir para as médias e os gráficos respondendo a um inquérito sobre a sua satisfação com o projecto e a sua equipa. 5.8 Modelos de Processos 5.8.1 Descrição e Prioridade Esta funcionalidade permite à equipa seguir um modelo de processo para melhor gerir o projecto e a equipa. Prioridade: Média 5.8.2 Sequências de Estimulo/Resposta Universidade de Coimbra 13
5.8.3 Requisitos Funcionais REQ-20: Ver o modelo de processos do projecto. Na secção de modelo de processos, o utilizador pode ver que podelo a equipa está a seguir para o projecto. REQ-21: Escolher qual o modelo de processos a seguir. O utilizador pode escolher qual o modelo de processos que a sua equipa pretende seguir. 6 Outros Requisitos Funcionais 6.1 Requisitos de Performance 6.2 Safety Requirements 6.3 Security Requirements 6.4 Atributos de Qualidade de Software 6.5 Regras de Negócio 7 Outros Requisitos Universidade de Coimbra 14