Merge pull request #137 from UnBArqDsw2023-2/prepara-mkdocs

Prepara mkdocs para apresentação

docs/ArquiteturaReutilizacao/reutilizacao/Arquitetura.md → docs/Entregas/Tres/Arquitetura.md

@@ -11,7 +11,7 @@ Sendo assim este documento tem como objetivo descrever a arquitetura de software
 
 ## Metodologia
 
-Para a escolha da arquitetura do projeto, a equipe produziu os diagramas e com base nos mesmos decidiu um framework que seria mais adequadro para o trabalho e por fim implementou a arquitetura previamente disponível no mesmo. Podemos encontrar as tecnologias escolhidas no documento de [reutilização de software interno](../../ArquiteturaReutilizacao/reutilizacao/Interna.md). Com isto, foi feito um estudo da arquitetura disponível e produzido o produto de software.
+Para a escolha da arquitetura do projeto, a equipe produziu os diagramas e com base nos mesmos decidiu um framework que seria mais adequadro para o trabalho e por fim implementou a arquitetura previamente disponível no mesmo. Podemos encontrar as tecnologias escolhidas no documento de [reutilização de software interno](./Interna.md). Com isto, foi feito um estudo da arquitetura disponível e produzido o produto de software.
 
 ## Arquitetura MVC
 
@@ -78,9 +78,9 @@ Podemos chamar o projeto de MVC modificado pois na realidade o framework nos for
 ‌
 ## Histórico de versão
 
-| Versão | Data       | Descrição                            | Autor(es)     |  Revisor(es) |
-| ------ | ---------- | ------------------------------------ | ------------- | ------------ |
-| `1.0`  | 22/11/2023 | Iniciando o documento                |    Kauã       |      Ana     |
-| `1.1`  | 22/11/2023 | Adicionando textos padrões           |    Kauã       |      Ana     |
-| `1.2`  | 25/11/2023 | Finalizando o documento              |    Kauã       |      Ana     | 
-| `1.3`  | 28/11/2023 | Documento revisado              |    Ana       |      Kauã     | 
+| Versão | Data       | Descrição                  | Autor(es) | Revisor(es) |
+| ------ | ---------- | -------------------------- | --------- | ----------- |
+| `1.0`  | 22/11/2023 | Iniciando o documento      | Kauã      | Ana         |
+| `1.1`  | 22/11/2023 | Adicionando textos padrões | Kauã      | Ana         |
+| `1.2`  | 25/11/2023 | Finalizando o documento    | Kauã      | Ana         |
+| `1.3`  | 28/11/2023 | Documento revisado         | Ana       | Kauã        |

docs/ArquiteturaReutilizacao/reutilizacao/Interna.md → docs/Entregas/Tres/Interna.md

@@ -137,8 +137,8 @@ Na sequência, temos os métodos que atuam como a operação que desejamos guard
 
 ## Histórico de versão
 
-| Versão | Data       | Descrição                            | Autor(es)     |  Revisor(es) |
-| ------ | ---------- | ------------------------------------ | ------------- | ------------ |
-| `1.0`  | 29/11/2023 | Iniciando o documento                |    Kauã       |      Ana     |
-| `1.1`  | 30/11/2023 | Adicionando informações              |    Kauã       |      Ana     |
-| `1.2`  | 30/11/2023 | Informações sobre especialização     |   Guilherme   |              |
+| Versão | Data       | Descrição                        | Autor(es) | Revisor(es) |
+| ------ | ---------- | -------------------------------- | --------- | ----------- |
+| `1.0`  | 29/11/2023 | Iniciando o documento            | Kauã      | Ana         |
+| `1.1`  | 30/11/2023 | Adicionando informações          | Kauã      | Ana         |
+| `1.2`  | 30/11/2023 | Informações sobre especialização | Guilherme | Arthur      |

docs/Entregas/VisaoExterna/VisaoExterna.md → docs/Entregas/Tres/VisaoExterna/VisaoExterna.md

@@ -77,7 +77,7 @@ Para utilizar o Django-Extensions, basta instalá-lo através do gerenciador de
 
 Vale ressaltar que é sempre importante consultar a documentação do Django-Extensions para entender corretamente como cada recurso do pacote funciona e como eles podem ser melhor explorados de acordo com cada cenário de aplicação.
 
-| Versão |    Data    |                Descrição                 |     Autor     |    Revisor    |
-| :----: | :--------: | :--------------------------------------: | :-----------: | :-----------: |
-| `1.1`  | 30/11/2023 |Criação do documento inicial|  Augusto D. Camargo  |    Arthur F. Rodrigues   |
-| `1.2`  | 30/11/2023 |Adição de imagens e finalização do documento|  Augusto D. Camargo  |    Arthur F. Rodrigues   |
+| Versão |    Data    |                  Descrição                   |       Autor        |       Revisor       |
+| :----: | :--------: | :------------------------------------------: | :----------------: | :-----------------: |
+| `1.1`  | 30/11/2023 |         Criação do documento inicial         | Augusto D. Camargo | Arthur F. Rodrigues |
+| `1.2`  | 30/11/2023 | Adição de imagens e finalização do documento | Augusto D. Camargo | Arthur F. Rodrigues |

docs/ArquiteturaReutilizacao/arquiteturaDeSoftware/das_implementação.md → docs/Entregas/Tres/das_implementacao.md

@@ -1,31 +1,5 @@
 # DAS de implementação
 
-## O que é DAS?
-
-Documentos de Arquitetura de Software (DAS)a são conjuntos de informações detalhadas sobre a estrutura, componentes, módulos, interfaces e padrões utilizados em um sistema de software. Eles servem como guias abrangentes para a equipe de desenvolvimento, destacando as decisões arquitetônicas e as justificativas por trás delas.
-
-## Por que utilizar DAS?
-
-- Compreensão Global do Sistema: Os DAS oferecem uma visão clara e abrangente da arquitetura do software, permitindo que todos os membros da equipe entendam a estrutura e a lógica por trás do sistema.
-
-- Tomada de Decisões Informada: Ao documentar decisões arquitetônicas, os desenvolvedores podem tomar decisões informadas sobre modificações, melhorias ou expansões no sistema.
-
-- Colaboração Eficaz: Facilitam a comunicação entre membros da equipe, stakeholders e outros envolvidos no projeto, promovendo uma colaboração mais eficaz.
-
-- Manutenção e Evolução: Os DAS ajudam a facilitar a manutenção do software ao longo do tempo, garantindo que as futuras mudanças estejam alinhadas com a visão arquitetônica original.
-
-Documentação de Arquitetura de Software (DAS) de Implementação: Elementos Essenciais e Diagrama de Componentes
-
-## Elementos Necessários em um DAS de Implementação:
-
-- **Contexto**: Uma breve descrição do contexto do projeto, identificando os principais objetivos e restrições.
-
-- **Cenários-Chave**: Documentos da parte de requisitos, como modelagem, elicitação e validação.
-
-- **Representação Gráfica**: Diagramas que ilustremos diferentes componentes do sistema e suas interações.
-
-- **Estrutura do Código**: Uma visão geral da estrutura do código-fonte, destacando módulos principais, pacotes ou camadas.
-
 ## Contexto
 
 A Amazon é uma plataforma e-commerce que oferece diversos serviços para o clientea. Através do site da Amazon, é possível fazer compras diante de um extenso catálogo de produtos e serviços oferecidos pela empresa.
@@ -35,77 +9,77 @@ O nosso grupo, da matéria de Arquitetura e desenho de software, ficou responsá
 
 ### 5W2H
 
-Essa abordagem deriva de sete perguntas simples, "What" (O quê), "Why" (Por quê), "Where" (Onde), "When" (Quando), "Who" (Quem), "How" (Como) e "How much" (Quanto custa). No caso do projeto da Amazon, foi utilizado para compreender melhor o escopo do projeto, quais eram os requisitos necessários. O documento pode ser acessado nesse [link](../../Entregas/Um/5W2H.md).
+Essa abordagem deriva de sete perguntas simples, "What" (O quê), "Why" (Por quê), "Where" (Onde), "When" (Quando), "Who" (Quem), "How" (Como) e "How much" (Quanto custa). No caso do projeto da Amazon, foi utilizado para compreender melhor o escopo do projeto, quais eram os requisitos necessários. O documento pode ser acessado nesse [link](../Um/5W2H.md).
 
 ### Storyboard
 
-Um Storyboard é uma representação gráfica que utiliza uma sequência de imagens ou quadros para representar uma série de eventos ou ações de um cenário específico. No contexto do grupo 1, foi utilizado na hora de elicitar requisitos. O documento e as imagens podem ser acessadas nesse [link.](../../Entregas/Um/StoryBoard.md).
+Um Storyboard é uma representação gráfica que utiliza uma sequência de imagens ou quadros para representar uma série de eventos ou ações de um cenário específico. No contexto do grupo 1, foi utilizado na hora de elicitar requisitos. O documento e as imagens podem ser acessadas nesse [link.](../Um/StoryBoard.md).
 
 ### Rich Picture
 
-O Rich Picture é uma ferramenta visual para expressar ideias e analisar problemas. Os artefatos elaborados são construídos de maneira informal, visando o fácil entendimento. Os rich pictures elaborados pela equipe podem ser vizualizados nesse [link](../../Entregas/Um/RichPicture.md).
+O Rich Picture é uma ferramenta visual para expressar ideias e analisar problemas. Os artefatos elaborados são construídos de maneira informal, visando o fácil entendimento. Os rich pictures elaborados pela equipe podem ser vizualizados nesse [link](../Um/RichPicture.md).
 
 ### Mapa mental
 
-Um mapa mental é uma representação visual que condensa conceitos e pensamentos de maneira gráfica, estabelecendo vínculos entre palavras e imagens que irradiam de um ponto central. O mapa mental elaborado pela equipe pode ser encontrado nesse [link](../../Entregas/Um/MapaMental.md).
+Um mapa mental é uma representação visual que condensa conceitos e pensamentos de maneira gráfica, estabelecendo vínculos entre palavras e imagens que irradiam de um ponto central. O mapa mental elaborado pela equipe pode ser encontrado nesse [link](../Um/MapaMental.md).
 
 ### Protótipo
 
-O protótipo é utilizado na validação dos requisitos elicitados por meio das técnicas acima. O documento desenvolvido na disciplina, relacionado a disciplina, pode ser acessado nesse [link](../../Entregas/Um/Prototipo.md).
+O protótipo é utilizado na validação dos requisitos elicitados por meio das técnicas acima. O documento desenvolvido na disciplina, relacionado a disciplina, pode ser acessado nesse [link](../Um/Prototipo.md).
 
 ### Entrevista
 
-A entrevista foi utilizada na tecnica de elicitação e tem como objetivo realizar conversas estruturadas com stakeholders para entender melhor as necessidades e requisitos do sistema. O documento referente a esse artefato pode ser acessado nesse [link](../../Entregas/Um/Entrevista.md)
+A entrevista foi utilizada na tecnica de elicitação e tem como objetivo realizar conversas estruturadas com stakeholders para entender melhor as necessidades e requisitos do sistema. O documento referente a esse artefato pode ser acessado nesse [link](../Um/Entrevista.md)
 
 ### BPMN
 
-O BPMN (Business Process Model and Notation), é uma linguagem gráfica padronizada para representar processos de negócios. O BPMN pode ser acessado nesse [link](../../Entregas/Um/BPMN.md)
+O BPMN (Business Process Model and Notation), é uma linguagem gráfica padronizada para representar processos de negócios. O BPMN pode ser acessado nesse [link](../Um/BPMN.md)
 
 ## Diagramas
 
 <details>
   <summary>Diagrama de Classes</summary>
   <h3>O Diagrama de Classes é uma ferramenta fundamental na UML (Unified Modeling Language) que oferece uma perspectiva 
-abrangente da estrutura de um sistema orientado a objetos. O artefato referente a esse diagrama pode ser encontrado neste <a href="../../Entregas/Dois/DiagramaDeClasses/DiagramaDeClasses.html">link</a>.</h3>
-  <img src="../../Entregas/Dois/DiagramaDeClasses/Classe UML - Amazon_v2.1.png" alt="Diagrama de Classes"/>
+abrangente da estrutura de um sistema orientado a objetos. O artefato referente a esse diagrama pode ser encontrado neste <a href="../Dois/DiagramaDeClasses/DiagramaDeClasses.html">link</a>.</h3>
+  <img src="../Dois/DiagramaDeClasses/Classe UML - Amazon_v2.1.png" alt="Diagrama de Classes"/>
   <center>
     <p> Diagrama 1 (Fonte: Ana e Beatriz, 2023).</a></p> 
   </center>
 </details>
 
 <details>
   <summary>Diagrama de Pacotes</summary>
-  <h3>É um diagrama estrutural e estático que tem como objeto mostrar a disposição de pacotes (conjunto de elementos) dentro do projeto. O artefato referente a esse diagrama pode ser encontrado neste <a href="../../Entregas/Dois/DiagramaDePacotes/DiagramaDePacotes.html">link</a>.</h3>
-  <img src="../../Entregas/Dois/DiagramaDePacotes/DiagramaDePacotesVF.png" alt="Diagrama de Pacotes"/>
+  <h3>É um diagrama estrutural e estático que tem como objeto mostrar a disposição de pacotes (conjunto de elementos) dentro do projeto. O artefato referente a esse diagrama pode ser encontrado neste <a href="../Dois/DiagramaDePacotes/DiagramaDePacotes.html">link</a>.</h3>
+  <img src="../Dois/DiagramaDePacotes/DiagramaDePacotesVF.png" alt="Diagrama de Pacotes"/>
   <center>
     <p> Diagrama 2 (Fonte: Kauã e Mylena, 2023).</a></p> 
   </center>
 </details>
 
 <details>
   <summary>Diagrama de Estados</summary>
-  <h3>  É um diagrama comportamental e dinâmico. O diagrama de estados consiste em estados, transições, eventos e atividades. Eles são importantes na modelagem de comportamentos de interface, classe ou colaboração. Ele enfatiza a ordem dos eventos do comportamento de um objeto. O artefato referente a esse diagrama pode ser encontrado neste <a href="../../Entregas/Dois/DiagramaDeEstados/DiagramaDeEstados.html">link</a>.</h3>
-  <img src="../../Entregas/Dois/DiagramaDeEstados/EstadosProdutoVF.png" alt="Diagrama de Estados"/>
+  <h3>  É um diagrama comportamental e dinâmico. O diagrama de estados consiste em estados, transições, eventos e atividades. Eles são importantes na modelagem de comportamentos de interface, classe ou colaboração. Ele enfatiza a ordem dos eventos do comportamento de um objeto. O artefato referente a esse diagrama pode ser encontrado neste <a href="../Dois/DiagramaDeEstados/DiagramaDeEstados.html">link</a>.</h3>
+  <img src="../Dois/DiagramaDeEstados/EstadosProdutoVF.png" alt="Diagrama de Estados"/>
   <center>
     <p> Diagrama 3 (Fonte: Kauã, Ana e Mylena 2023).</a></p> 
   </center>
 </details>
 
 <details>
   <summary>Diagrama de Atividades</summary>
-  <h3>O Diagrama de Atividade é uma variação do Diagrama de Estado, que contém essencialmente os comportamentos a serem realizados no sistema. O artefato referente a esse diagrama pode ser encontrado neste <a href="../../Entregas/Dois/DiagramaDeAtividade/DiagramaDeAtividade.html">link</a>.</h3>
+  <h3>O Diagrama de Atividade é uma variação do Diagrama de Estado, que contém essencialmente os comportamentos a serem realizados no sistema. O artefato referente a esse diagrama pode ser encontrado neste <a href="../Dois/DiagramaDeAtividade/DiagramaDeAtividade.html">link</a>.</h3>
   <h2>Diagrama de Atividades - Cadastro</h2>
-  <img src="../../Entregas/Dois/DiagramaDeAtividade/assets/Atividade UML Cadastro.png" alt="Diagrama de Atividades - Cadastro"/>
+  <img src="../Dois/DiagramaDeAtividade/assets/Atividade UML Cadastro.png" alt="Diagrama de Atividades - Cadastro"/>
   <center>
     <p> Diagrama 4 (Fonte: Bruno e Gabriel, 2023).</a></p> 
   </center>
   <h2>Diagrama de Atividades - Compras</h2>
-  <img src="../../Entregas/Dois/DiagramaDeAtividade/assets/UML_Compras.png" alt="Diagrama de Atividades - Compras"/>
+  <img src="../Dois/DiagramaDeAtividade/assets/UML_Compras.png" alt="Diagrama de Atividades - Compras"/>
   <center>
     <p> Diagrama 5 (Fonte: Bruno e Gabriel, 2023).</a></p> 
   </center>
   <h2>Diagrama de Atividades - Gestão</h2>
-  <img src="../../Entregas/Dois/DiagramaDeAtividade/assets/UML_Gestao.png" alt="Diagrama de Atividades - Gestão"/>
+  <img src="../Dois/DiagramaDeAtividade/assets/UML_Gestao.png" alt="Diagrama de Atividades - Gestão"/>
   <center>
     <p> Diagrama 6 (Fonte: Bruno e Gabriel, 2023).</a></p> 
   </center>
@@ -118,12 +92,12 @@ Sendo o Diagrama de Componentes uma das principais representações visuais no D
 
 Essa representação, além de simplificar a compreensão da estrutura do sistema, também fornece uma base sólida para a tomada de decisões ao longo do ciclo de vida do projeto, permitindo que a equipe de desenvolvimento e manutenção atue de maneira informada e eficaz.
 
-O artefato completo referente a esse diagrama esta disponível neste [link](../../Entregas/Dois/DiagramaDeComponentes/DiagramaDeComponentes.md).
+O artefato completo referente a esse diagrama esta disponível neste [link](../Dois/DiagramaDeComponentes/DiagramaDeComponentes.md).
 
 <br>
 
 
-<img src="../../Entregas/Dois/DiagramaDeComponentes/v3.png"/>
+<img src="../Dois/DiagramaDeComponentes/v3.png"/>
 <center>
 <p> Diagrama 7 (Fonte: Guilherme Puida, 2023).</a></p> 
 </center>
@@ -135,9 +109,9 @@ A estrutura do código é uma parte essencial para compreender a implementação
 
 ## Fontes:
 
-- [Arquitetura](../../ArquiteturaReutilizacao/reutilizacao/Arquitetura.md)
-- [Reutilização de software interno](../../ArquiteturaReutilizacao/reutilizacao/Interna.md)
-- [Reutilização de software externo](../../ArquiteturaReutilizacao/reutilizacao/Externa.md)
+- [Arquitetura](./Arquitetura.md)
+- [Reutilização de software interno](./Interna.md)
+- [Reutilização de software externo](./VisaoExterna/VisaoExterna.md)
 
 ## Concideraçẽos Gerais
 
@@ -160,3 +134,4 @@ A estrutura do código é uma parte essencial para compreender a implementação
 | `1.0`  | 28/11/2023 | Criação do documento                           | Mylena      | Beatriz     |
 | `1.1`  | 29/11/2023 | Adicionando links e mais informações           | Mylena      | Beatriz     |
 | `1.2`  | 30/11/2023 | Adicionando  diagramas e finalizando documento | Ana Beatriz | Beatriz     |
+| `1.3`  | 01/12/2023 | Revisão final                                  | Arthur      | N/A         |

docs/Entregas/Tres/index.md

@@ -0,0 +1,27 @@
+# Entrega 3
+
+## O que é DAS?
+
+Documentos de Arquitetura de Software (DAS) a são conjuntos de informações detalhadas sobre a estrutura, componentes, módulos, interfaces e padrões utilizados em um sistema de software. Eles servem como guias abrangentes para a equipe de desenvolvimento, destacando as decisões arquitetônicas e as justificativas por trás delas.
+
+## Por que utilizar DAS?
+
+- Compreensão Global do Sistema: Os DAS oferecem uma visão clara e abrangente da arquitetura do software, permitindo que todos os membros da equipe entendam a estrutura e a lógica por trás do sistema.
+
+- Tomada de Decisões Informada: Ao documentar decisões arquitetônicas, os desenvolvedores podem tomar decisões informadas sobre modificações, melhorias ou expansões no sistema.
+
+- Colaboração Eficaz: Facilitam a comunicação entre membros da equipe, stakeholders e outros envolvidos no projeto, promovendo uma colaboração mais eficaz.
+
+- Manutenção e Evolução: Os DAS ajudam a facilitar a manutenção do software ao longo do tempo, garantindo que as futuras mudanças estejam alinhadas com a visão arquitetônica original.
+
+Documentação de Arquitetura de Software (DAS) de Implementação: Elementos Essenciais e Diagrama de Componentes
+
+## Elementos Necessários em um DAS de Implementação:
+
+- **Contexto**: Uma breve descrição do contexto do projeto, identificando os principais objetivos e restrições.
+
+- **Cenários-Chave**: Documentos da parte de requisitos, como modelagem, elicitação e validação.
+
+- **Representação Gráfica**: Diagramas que ilustremos diferentes componentes do sistema e suas interações.
+
+- **Estrutura do Código**: Uma visão geral da estrutura do código-fonte, destacando módulos principais, pacotes ou camadas.