Merge pull request #127 from Requisitos-de-Software/rastreabilidade-l…

…exicos Adicionando subartefatos dos requisitos pessoais escolhidos
Requisitos-de-Software · Dec 11, 2024 · 8b4f62e · 8b4f62e
2 parents 17dae74 + 7ba4850
commit 8b4f62e
Show file tree

Hide file tree

Showing 5 changed files with 119 additions and 27 deletions.
diff --git a/docs/assets/modelagem/casos-de-uso/diagrama-de-caso-de-uso.png b/docs/assets/modelagem/casos-de-uso/diagrama-de-caso-de-uso.png
diff --git a/docs/modelagem-pt1/casos-de-uso.md b/docs/modelagem-pt1/casos-de-uso.md
@@ -45,7 +45,7 @@ A figura 1 demonstra o diagrama de casos de uso.
 
 ## Especialização dos casos de uso
 
-As tabelas de 2 a 6 mostram a especialização dos casos de uso.
+As tabelas de 2 a 9 mostram a especialização dos casos de uso.
 
 ### Tabela 2: Fazer Login
 <font size="3"><p style="text-align: center">Tabela 2: Fazer Login </p></font>
@@ -190,9 +190,30 @@ As tabelas de 2 a 6 mostram a especialização dos casos de uso.
 | **Data de Criação**     | 11/12/2024                                                                                                         |
 
 Esse caso de uso foi feito baseado nas [Instruções do Professor](../../elicitacao/grupo5/requisitos/#requisitos-por-integrante) sobre os requisitos a serem desenvolvidos no projeto.
+<font size="2"><p style="text-align: center"><b>Autor: <a href="https://github.com/moonshinerd">Víctor Schmidt</a></b></p></font>
+
+### Tabela 9: Relatórios Mensais de Evolução de Rendimentos
+
+<font size="3"><p style="text-align: center">Tabela 9: Incluir Relatórios Personalizados </p></font>
+<center>
+
+| **IT15**               | **Informações**                                                                                                         |
+|-------------------------|-------------------------------------------------------------------------------------------------------------------------|
+| **Descrição**           | Permitir que o sistema forneça relatórios mensais com a evolução dos rendimentos dos títulos adquiridos pelo investidor.  |
+| **Ator**                | Sistema                                                                                                                |
+| **Pré-condições**       | O investidor deve estar autenticado no sistema.                                                                            |
+| **Ação**                | O sistema gera automaticamente relatórios mensais com base nos rendimentos acumulados dos títulos do investidor.          |
+| **Fluxo principal**     | <ul><li>1. O sistema coleta os dados dos rendimentos mensais dos títulos adquiridos pelo investidor.</li><li>2. O sistema processa as informações e consolida os rendimentos do mês atual e dos meses anteriores.</li><li>3. O relatório é formatado com os seguintes elementos:</li><ul><li>a. Total de rendimentos mensais por título;</li><li>b. Comparativo com meses anteriores;</li><li>c. Gráficos e/ou tabelas de evolução acumulada.</li></ul><li>4. O sistema disponibiliza o relatório na seção "Meus Relatórios".</li><li>5. O investidor pode visualizar ou fazer download do relatório.</li></ul> |
+| **Fluxo alternativo**   | <ul><li>1. O investidor decide pela não geração automática dos relatórios <ul></ul><li>2. O sistema enfrenta problemas temporários ao acessar os dados de rendimentos (e.g., falhas de conectividade ou indisponibilidade do servidor).</li><li>3. O sistema exibe uma mensagem ao usuário informando a indisponibilidade momentânea e sugere tentar novamente mais tarde.</li><li>4. O usuário retorna à seção "Meus Relatórios" para acessar o relatório assim que o problema for resolvido.</li></ul> |
+| **Fluxo de exceção**    | <ul><li>1. O sistema não encontra dados de rendimentos para o período solicitado.</li><li>2. O sistema exibe uma mensagem informando que não há dados suficientes para gerar o relatório.</li></ul> |
+| **Pós-condições**       | O relatório mensal é gerado e armazenado para consulta futura na seção "Meus Relatórios".                              |
+| **Rastreabilidade**     | [RF15](../../elicitacao/grupo5/requisitos/#anchor_RF15)                                                             |
+| **Data de Criação**     | 11/12/2024                                                                                                          |
+
 </center>
 
-<font size="2"><p style="text-align: center"><b>Autor: <a href="https://github.com/moonshinerd">Víctor Schmidt</a></b></p></font>
+Esse caso de uso foi feito baseado nas [Instruções do Professor](../../elicitacao/grupo5/requisitos/#requisitos-por-integrante) sobre os requisitos a serem desenvolvidos no projeto.
+<font size="2"><p style="text-align: center"><b>Autor: <a href="https://github.com/thaleseuflauzino">Thales Euflauzino</a></b></p></font>
 
 ## Bibliografia
 
@@ -217,3 +238,4 @@ Esse caso de uso foi feito baseado nas [Instruções do Professor](../../elicita
 | `1.2`    | 07/12/2024 | Corrigindo Fonte para Autor | [Thales Euflauzino](https://github.com/thaleseuflauzino)   | [Víctor Schmidt](https://github.com/moonshinerd) |
 | `1.3`    | 10/12/2024 | Alterações e correções | [Víctor Schmidt](https://github.com/moonshinerd)   | [Thales Euflauzino](https://github.com/thaleseuflauzino) |
 | `1.4`    | 11/12/2024 | Adicionando Caso de Uso baseado nas [Instruções do Professor](../../elicitacao/grupo5/requisitos/#requisitos-por-integrante)| [Víctor Schmidt](https://github.com/moonshinerd)   | [Thales Euflauzino](https://github.com/thaleseuflauzino) |
+| `1.5`    | 11/12/2024 | Adicionando Caso de Uso baseado nas [Instruções do Professor](../../elicitacao/grupo5/requisitos/#requisitos-por-integrante) | [Thales Euflauzino](https://github.com/thaleseuflauzino) | [Víctor Schmidt](https://github.com/moonshinerd) |
diff --git a/docs/modelagem-pt1/cenarios.md b/docs/modelagem-pt1/cenarios.md
@@ -56,9 +56,9 @@ Inicialmente serão definidos os cenários das tarefas principais, que descrevem
 
 ## Cenários Identificados
 
-Os cenários listados nas tabelas 2 a 8 foram elaborados com base na análise dos requisitos elicitados, disponíveis na seção de [Requisitos](../elicitacao/grupo5/requisitos.md).
+Os cenários listados nas tabelas 2 a 10 foram elaborados com base na análise dos requisitos elicitados, disponíveis na seção de [Requisitos](../elicitacao/grupo5/requisitos.md).
 
-### Cenário 1 - Simulação de compra de titulos <a href="../../elicitacao/grupo5/requisitos/#anchor_RF02">[RF02]</a>
+### Cenário 1 - Simulação de compra de titulos - <a href="../../elicitacao/grupo5/requisitos/#anchor_RF02">RF02</a>
 
 <p style="font-size: 13px; text-align: center; margin: 0px auto"><strong>Tabela 2:</strong> Cenário 1</p>
 <table border="1">
@@ -146,7 +146,7 @@ Os cenários listados nas tabelas 2 a 8 foram elaborados com base na análise do
 <p style="font-size: 13px; margin: 0px; text-align: center; margin-top: -14px">Autores: <a href="https://github.com/MariaCHelena" target="blank">Maria Helena</a> e <a href="https://github.com/ViictorHugoo" target="blank">Victor Rodrigues</a></p>
 
 
-### Cenário 2 - Resgate Antecipado de Títulos <a href="../../elicitacao/grupo5/requisitos/#anchor_RF03">[RF03]</a>
+### Cenário 2 - Resgate Antecipado de Títulos - <a href="../../elicitacao/grupo5/requisitos/#anchor_RF03">RF03</a>
 
 <p style="font-size: 13px; text-align: center; margin: 0px auto"><strong>Tabela 3:</strong> Cenário 2</p>
 <table border="1">
@@ -236,7 +236,7 @@ Os cenários listados nas tabelas 2 a 8 foram elaborados com base na análise do
 <p style="font-size: 13px; margin: 0px; text-align: center; margin-top: -14px">Autores: <a href="https://github.com/MariaCHelena" target="blank">Maria Helena</a> e <a href="https://github.com/ViictorHugoo" target="blank">Victor Rodrigues</a></p>
 
 
-### Cenário 3 - Planejamento de Metas de Investimento <a href="../../elicitacao/grupo5/requisitos/#anchor_RF04">[RF04]</a>
+### Cenário 3 - Planejamento de Metas de Investimento - <a href="../../elicitacao/grupo5/requisitos/#anchor_RF04">RF04</a>
 
 <p style="font-size: 13px; text-align: center; margin: 0px auto"><strong>Tabela 4:</strong> Cenário 3</p>
 <table border="1">
@@ -326,7 +326,7 @@ Os cenários listados nas tabelas 2 a 8 foram elaborados com base na análise do
 <p style="font-size: 13px; margin: 0px; text-align: center; margin-top: -14px">Autores: <a href="https://github.com/MariaCHelena" target="blank">Maria Helena</a> e <a href="https://github.com/ViictorHugoo" target="blank">Victor Rodrigues</a></p>
 
 
-### Cenário 4 - Planejamento de Aposentadoria <a href="../../elicitacao/grupo5/requisitos/#anchor_RF05">[RF05]</a>
+### Cenário 4 - Planejamento de Aposentadoria - <a href="../../elicitacao/grupo5/requisitos/#anchor_RF05">RF05</a>
 
 <p style="font-size: 13px; text-align: center; margin: 0px auto"><strong>Tabela 5:</strong> Cenário 4</p>
 <table border="1">
@@ -418,7 +418,7 @@ Os cenários listados nas tabelas 2 a 8 foram elaborados com base na análise do
 </table>
 <p style="font-size: 13px; margin: 0px; text-align: center; margin-top: -14px">Autores: <a href="https://github.com/MariaCHelena" target="blank">Maria Helena</a> e <a href="https://github.com/ViictorHugoo" target="blank">Victor Rodrigues</a></p>
 
-### Cenário 5 - Consultar operações agendadas <a href="../../elicitacao/grupo5/requisitos/#anchor_RF08">[RF08]</a>
+### Cenário 5 - Consultar operações agendadas - <a href="../../elicitacao/grupo5/requisitos/#anchor_RF08">RF08</a>
 
 <p style="font-size: 13px; text-align: center; margin: 0px auto"><strong>Tabela 6:</strong> Cenário 5</p>
 <table border="1">
@@ -498,7 +498,7 @@ Os cenários listados nas tabelas 2 a 8 foram elaborados com base na análise do
 </table>
 <p style="font-size: 13px; margin: 0px; text-align: center; margin-top: -14px">Autores: <a href="https://github.com/MariaCHelena" target="blank">Maria Helena</a> e <a href="https://github.com/ViictorHugoo" target="blank">Victor Rodrigues</a></p>
 
-### Cenário 6 - Visualizar lista de títulos públicos disponíveis <a href="../../elicitacao/grupo5/requisitos/#anchor_RF30">[RF30]</a>
+### Cenário 6 - Visualizar lista de títulos públicos disponíveis - <a href="../../elicitacao/grupo5/requisitos/#anchor_RF30">RF30</a>
 
 <p style="font-size: 13px; text-align: center; margin: 0px auto"><strong>Tabela 7:</strong> Cenário 6</p>
 <table border="1">
@@ -577,7 +577,7 @@ Os cenários listados nas tabelas 2 a 8 foram elaborados com base na análise do
 </table>
 <p style="font-size: 13px; margin: 0px; text-align: center; margin-top: -14px">Autores: <a href="https://github.com/MariaCHelena" target="blank">Maria Helena</a> e <a href="https://github.com/ViictorHugoo" target="blank">Victor Rodrigues</a></p>
 
-### Cenário 7 - Consultar as informações de liquidez dos títulos disponíveis <a href="../../elicitacao/grupo5/requisitos/#anchor_RF23">[RF23]</a>
+### Cenário 7 - Consultar as informações de liquidez dos títulos disponíveis - <a href="../../elicitacao/grupo5/requisitos/#anchor_RF23">RF23</a>
 
 <p style="font-size: 13px; text-align: center; margin: 0px auto"><strong>Tabela 8:</strong> Cenário 7</p>
 <table border="1">
@@ -659,9 +659,9 @@ Os cenários listados nas tabelas 2 a 8 foram elaborados com base na análise do
 </table>
 <p style="font-size: 13px; margin: 0px; text-align: center; margin-top: -14px">Autores: <a href="https://github.com/MariaCHelena" target="blank">Maria Helena</a> e <a href="https://github.com/ViictorHugoo" target="blank">Victor Rodrigues</a></p>
 
-### Cenário 8 - Simulação da Evolução de Metas/Sonhos [RF25](../../elicitacao/grupo5/requisitos/#anchor_RF25)
+### Cenário 8 - Simulação da Evolução de Metas/Sonhos - [RF25](../../elicitacao/grupo5/requisitos/#anchor_RF25)
 
-<p style="font-size: 13px; text-align: center; margin: 0px auto"><strong>Tabela 1:</strong> Cenário 8</p>
+<p style="font-size: 13px; text-align: center; margin: 0px auto"><strong>Tabela 9:</strong> Cenário 8</p>
 <table border="1">
     <thead>
         <tr>
@@ -726,6 +726,73 @@ Os cenários listados nas tabelas 2 a 8 foram elaborados com base na análise do
 Esse cenário foi feito baseado nas [Instruções do Professor](../../elicitacao/grupo5/requisitos/#requisitos-por-integrante) sobre os requisitos a serem desenvolvidos no projeto.
 <p style="font-size: 13px; margin: 0px; text-align: center; margin-top: -14px">Autor: <a href="https://github.com/moonshinerd" target="blank">Víctor Schmidt</a></p>
 
+### Cenário 9 - Relatórios Mensais de Evolução de Rendimentos - [RF15](../../elicitacao/grupo5/requisitos/#anchor_RF15)
+
+<p style="font-size: 13px; text-align: center; margin: 0px auto"><strong>Tabela 10:</strong> Cenário 9</p>
+<table border="1">
+    <thead>
+        <tr>
+            <th colspan="2" style="text-align: center;">Cenário: Relatórios Mensais de Evolução de Rendimentos</th>
+        </tr>
+    </thead>
+    <tbody>
+        <tr>
+            <td style="font-weight: bold;">Título</td>
+            <td>Geração de Relatórios Mensais de Evolução de Rendimentos</td>
+        </tr>
+        <tr>
+            <td style="font-weight: bold;">Objetivo</td>
+            <td>Fornecer ao usuário uma visão consolidada da evolução mensal dos rendimentos de seus títulos adquiridos que estão ativos, auxiliando na análise de desempenho dos investimentos.</td>
+        </tr>
+        <tr>
+            <td style="font-weight: bold;">Contexto</td>
+            <td>O usuário deseja verificar como os rendimentos de seus títulos têm evoluído ao longo dos meses, usando os relatórios gerados pelo sistema para acompanhamento financeiro.</td>
+        </tr>
+        <tr>
+            <td style="font-weight: bold;">Atores</td>
+            <td>Sistema e Usuário</td>
+        </tr>
+        <tr>
+            <td style="font-weight: bold;">Recursos</td>
+            <td>Base de dados dos rendimentos dos títulos adquiridos, módulo de geração de relatórios, interface do sistema.</td>
+        </tr>
+        <tr>
+            <td style="font-weight: bold;">Episódios</td>
+            <td>
+                <ol>
+                    <li>O sistema gera automaticamente o relatório mensal ao final de cada mês.</li>
+                    <li>O relatório consolida os rendimentos mensais de todos os títulos adquiridos ativos pelo usuário.</li>
+                    <li>Os dados são organizados em gráficos e/ou tabelas comparando o mês atual com os 3 meses anteriores.</li>
+                    <li>O sistema notifica o usuário sobre a disponibilidade do relatório na seção "Meus Relatórios".</li>
+                    <li>O usuário acessa o relatório, visualiza os dados e faz o download, se desejar.</li>
+                </ol>
+            </td>
+        </tr>
+        <tr>
+            <td style="font-weight: bold;">Restrições</td>
+            <td>
+                <ul>
+                    <li>O usuário deve estar autenticado para acessar os relatórios.</li>
+                    <li>Os dados dos rendimentos dos títulos devem estar atualizados no sistema.</li>
+                    <li>Os relatórios são baseados em dados históricos e não apresentam projeções futuras.</li>
+                </ul>
+            </td>
+        </tr>
+        <tr>
+            <td style="font-weight: bold;">Exceção</td>
+            <td>
+                <ul>
+                    <li>Se houver falha na geração do relatório, o sistema exibe uma mensagem de erro e agenda uma nova tentativa automática.</li>
+                    <li>Se o usuário tentar acessar o relatório durante uma indisponibilidade do servidor, o sistema exibe uma mensagem e sugere tentar novamente mais tarde.</li>
+                </ul>
+            </td>
+        </tr>
+    </tbody>
+</table>
+
+Esse cenário foi feito baseado nas [Instruções do Professor](../../elicitacao/grupo5/requisitos/#requisitos-por-integrante) sobre os requisitos a serem desenvolvidos no projeto.
+<p style="font-size: 13px; margin: 0px; text-align: center; margin-top: -14px">Autor: <a href="https://github.com/thaleseuflauzino" target="blank">Thales Euflauzino</a></p>
+
 
 ## Bibliografia
 
@@ -749,3 +816,4 @@ Esse cenário foi feito baseado nas [Instruções do Professor](../../elicitacao
 | `1.3` | 10/12/2024 | Adicionando rastreabilidade  | [Thales Euflauzino](https://github.com/thaleseuflauzino) | [Victor Schmidt](https://github.com/moonshinerd)  |
 | `1.4`  | 10/12/2024 |  Ajustando referencias/bibliografia        | [Thales Euflauzino](https://github.com/thaleseuflauzino)  | [Víctor Schmidt](https://github.com/moonshinerd)  |
 | `1.5`    | 11/12/2024 | Adicionando Cenário baseado nas [Instruções do Professor](../../elicitacao/grupo5/requisitos/#requisitos-por-integrante)| [Víctor Schmidt](https://github.com/moonshinerd)   | [Thales Euflauzino](https://github.com/thaleseuflauzino) |
+| `1.6`    | 11/12/2024 | Adicionando Cenário baseado nas [Instruções do Professor](../../elicitacao/grupo5/requisitos/#requisitos-por-integrante)   | [Thales Euflauzino](https://github.com/thaleseuflauzino) | [Víctor Schmidt](https://github.com/moonshinerd) |
diff --git a/docs/modelagem-pt1/especificacao-suplementar.md b/docs/modelagem-pt1/especificacao-suplementar.md
@@ -26,7 +26,7 @@ Este tópico aborda os requisitos que influenciam a facilidade de uso da aplica
 | ------- | -------- |
 | <a href="../../elicitacao/grupo5/requisitos/#anchor_RNF04">[RNF04]</a> | A interface do aplicativo deve seguir as diretrizes de acessibilidade da norma técnica NBR 17060:2022. |
 | <a href="../../elicitacao/grupo5/requisitos/#anchor_RNF07">[RNF07]</a> | O sistema deve oferecer controle ampliado para simulações de aposentadoria |
-| <a href="../../elicitacao/grupo5/requisitos/#anchor_RNF08">[RNF08]</a> | O perfil de recomendação de investimentos deve ser mais visível e acessível no aplicativo |
+| <a href="../../elicitacao/grupo5/requisitos/#anchor_RNF08">[RNF08]</a> | O perfil de recomendação de investimentos deve ser acessível a partir de 3 cliques de qualquer parte do aplicativo. |
 | <a href="../../elicitacao/grupo5/requisitos/#anchor_RNF09">[RNF09]</a> | O aplicativo deve incluir uma opção de tema escuro para melhorar a experiência do usuário |
 <p style="font-size: 13px; margin: 0px; text-align: center; margin-top: -14px">Autores: <a href="https://github.com/MariaCHelena" target="blank">Maria Helena</a> e <a href="https://github.com/juliatakaki" target="blank">Júlia Takaki</a></p>
 
@@ -82,4 +82,5 @@ Esse tópico diz respeito a questões relacionadas ao desempenho do software. Os
 | `1.2`  | 07/12/2024 |  Padronizando versionamento        | [Thales Euflauzino](https://github.com/thaleseuflauzino)  | [Víctor Schmidt](https://github.com/moonshinerd)  |
 | `1.3`  | 10/12/2024 |  Ajustando referencias/bibliografia        | [Thales Euflauzino](https://github.com/thaleseuflauzino)  | [Víctor Schmidt](https://github.com/moonshinerd)  |
 | `1.4`  | 10/12/2024 |  Adicionando rastreabilidade        | [Thales Euflauzino](https://github.com/thaleseuflauzino)  | [Víctor Schmidt](https://github.com/moonshinerd)  |
-| `1.5`    | 11/12/2024 | Corrigindo RNF04 baseado em [Instruções do Professor](../../elicitacao/grupo5/requisitos/#requisitos-por-integrante)| [Víctor Schmidt](https://github.com/moonshinerd)   | [Thales Euflauzino](https://github.com/thaleseuflauzino) |
+| `1.5`    | 11/12/2024 | Corrigindo RNF04 baseado em [Instruções do Professor](../../elicitacao/grupo5/requisitos/#requisitos-por-integrante)| [Víctor Schmidt](https://github.com/moonshinerd)   | [Thales Euflauzino](https://github.com/thaleseuflauzino) |
+| `1.6`    | 11/12/2024 | Corrigindo RNF08 baseado em [Instruções do Professor](../../elicitacao/grupo5/requisitos/#requisitos-por-integrante)|  [Thales Euflauzino](https://github.com/thaleseuflauzino) | [Víctor Schmidt](https://github.com/moonshinerd) |