Skip to content

Commit

Permalink
Merge pull request #52 from Requisitos-de-Software/verificacao-yago
Browse files Browse the repository at this point in the history
2 artefatos de verificação
  • Loading branch information
yagompassos authored Nov 11, 2023
2 parents 8fba202 + 6c1cfff commit 0a331d1
Show file tree
Hide file tree
Showing 3 changed files with 198 additions and 4 deletions.
16 changes: 12 additions & 4 deletions docs/planejamento/modelo_artefato.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,15 @@

## Histórico de Versão

| Versão | Data de execução | Data de revisão | Descrição | Autor(es) | Revisor(es) |
| :----: | :--------------: | :-------------: | :-------------------------------: | :--------------------------------------------------: | :--------------------------------------------------: |
| `1.0` | 05/09/2023 | 18/04/2023 | Adição do modelo base dos artefatos | [Jefferson França](https://github.com/Frans6) | [Yago Passos](https://github.com/yagompassos) |

| Versão | Data de execução | Data prevista de revisão | Descrição | Autor(es) | Revisado |
| :----: | :--------------: | :-------------: | :------------------------: | :----------------: | :-----------: |
| `1.0` | dd/mm/aaaa | dd/mm/aaaa | Descrição do que foi feito | Nome do Autor | :heavy_check_mark: |
| `1.1` | dd/mm/aaaa | dd/mm/aaaa | Descrição do que foi feito | Nome do Autor | :heavy_check_mark: |
| `1.2` | dd/mm/aaaa | dd/mm/aaaa | Descrição do que foi feito | Nome do Autor | :heavy_check_mark: |

### Verificação

| Data de Revisão | Cobertura de Versões | Técnica | Revisor(es) |
| :------------: | :-------------: | :--------------------------: | :---------------: |
| dd/mm/aaaa | `1.0` | Elaboração em pares | Nome do Revisor |
| dd/mm/aaaa | `1.1` e `1.2` | Revisão por inspeção | Nome do Revisor |
93 changes: 93 additions & 0 deletions docs/verificacao/grupo7/entrevista.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
# Verificação do artefato ["Entrevista"](https://requisitos-de-software.github.io/2023.2-DETRAN/Entrega_2/entrevista/)

## Introdução

A análise de artefatos desempenha um papel fundamental na avaliação de documentos, projetos e produtos em diversas áreas, incluindo a Engenharia de Requisitos de Software. A abordagem de verificação de artefatos tem por objetivo realizar uma análise minuciosa do conteúdo, estrutura e atributos específicos de um artefato, com o propósito de avaliar sua qualidade, aderência aos requisitos e congruência com os objetivos previamente definidos.

Nesse contexto, o escopo de nossa pesquisa visa à aplicação da técnica de verificação de artefatos ao artefato de [Entrevista](https://requisitos-de-software.github.io/2023.2-DETRAN/Entrega_1/Rich_picture/), desenvolvido pelo [Grupo 7](https://requisitos-de-software.github.io/2023.2-DETRAN/) em seu projeto no contexto do Detran <a id="a" href="#aa">[3]</a>. Ressalta-se que a realização da verificação está estritamente alinhada com as diretrizes e datas estipuladas no [plano de ensino](https://aprender3.unb.br/pluginfile.php/2692699/mod_resource/content/34/Plano_de_Ensino%20RE%20022023%20Turma%202.pdf) <a id="a" href="#aa">[1]</a>.

Para melhor compreensão, é relevante salientar que a técnica de verificação, inspirada no processo de Fagan, abarca uma análise sistemática e rigorosa do artefato em busca de possíveis erros, inconsistências, omissões e desvios em relação aos requisitos. Essa etapa desempenha um papel crucial na garantia da qualidade e na precisão do artefato, assegurando sua conformidade com os objetivos estabelecidos no contexto do projeto ou documento em análise <a id="a" href="#aa">[4]</a>.

## Metodologia

A verificação, segundo o método de inspeção de Fagan, representa uma abordagem formal e estruturada para a revisão de documentos, cujo propósito é a identificação de falhas, erros e problemas nos artefatos, incluindo documentos, código-fonte, especificações e outros elementos correlacionados a projetos de desenvolvimento de software. O processo compreende etapas que envolvem planejamento, revisão geral, preparação, execução da inspeção, correções e acompanhamento <a id="b" href="#bb">[2]</a>. Além disso, a avaliação do artefato em questão também se baseará nos critérios de avaliação especificados no [plano de ensino](https://aprender3.unb.br/pluginfile.php/2692699/mod_resource/content/34/Plano_de_Ensino%20RE%20022023%20Turma%202.pdf) <a id="a" href="#aa">[1]</a>. Para dar maior clareza à análise, implementamos um "conteúdo esperado", que compreende um checklist fundamentado nas questões previamente definidas no plano de ensino <a id="b" href="#bb">[1]</a>.

A inspeção de Fagan é ilustrada na Figura 1 apresentada abaixo, demonstrando as etapas envolvidas no processo.

<div style="text-align: center;">
<img src="../../Fagan.png" alt="image" width="900"/>
</div>s

<div style="text-align: center;">
Figura 1: Método de Fagan: Inspeção. (Fonte: Slide “Requisitos – Aula 23” <a id="b" href="#bb">[2]</a>, 2023)
</div>

## Conteúdo esperado

Espera-se que no artefato estejam presentes as padronizações esperadas, metodologia explicada e conteúdo relevante sobre o tema da entrevista.

### Verificação

Sendo assim, foi elaborada a tabela 1 abaixo relacionando as especificações ideais do artefato, se ele possui ou não o requisito apresentado nas perguntas e quanto a qualidade, baseada na seguinte classificação:

**Possui/Atende**

- Sim
- Não
- Incompleto

**Qualidade**

- Ótimo (Apresenta todos os requisitos do conteúdo esperado)
- Bom (Apresenta parcialmente os requisitos do conteúdo esperado)
- Pode melhorar (Não apresenta os requisitos do conteúdo esperado)

<br>

| ID | Conteúdo | Possui/Atende | Qualidade | Observação |
| --- | ----------------------------------------------------------------------------- | ---------- | ------------- | -------------------------------------------------- |
| 1 | Há histórico de versão padronizado? | Sim | Ótimo | - |
| 2 | Há autor e revisor no artefato? | Sim | Ótimo | - |
| 3 | Existem referências bibliográficas? | Sim | Bom | O link da referência bibliográfica não é clicável |
| 4 | Possui hiperlinks para outros artefatos caso necessário? | Não | Ótimo | Não parece necessário. |
| 5 | As tabelas e imagens possuem legenda, fonte e são introduzidas no texto? | Incompleto | Bom | Apesar das legendas estarem ok, as tabelas e o vídeo não são introduzidos préviamente no texto |
| 6 | As referências bibliográficas estão citadas no texto? | Não | Pode melhorar | Não há nenhuma citação ou referência, no corpo do artefato, que remete ao que está listado na sua própria bibliografia. |
| 6 | Todas informações que o texto trás, citam e são referenciadas com alguma bibliografia? | Sim | Ótimo | O texto não trás novas informações que necessitariam de referência bibliográfica.|
| 7 | Existe uma metodologia definida no artefato? | Sim | Ótimo | A metodologia está completamente explicitada na seção 2, de Entrevista. |
| 9 | Os dados da entrevista, como data, duração e dados do participante estão explicitados na metodologia? | Sim | Ótimo |-|
| 10 | Existe a gravação da entrevista no artefato? | Sim | Bom | O link para o vídeo funciona, mas é interessante colocar o vídeo em formato *embed*.|
| 11 | As câmeras dos participantes estão ligadas durante a entrevista? | Sim | Ótimo | - |

<div style="text-align: center">
<p> Tabela 1: Checklist pro artefato de Entrevista. (Fonte: Yago Passos, 2023).</p>
</div>

## Correções e ajustes sugeridos

No geral, o artefato está condizente com o conteudo, mas precisa de pequenos ajustes. O que o Grupo Skoob sugere:

- Evitar incluir informações no texto sem citação, a exemplo da introdução do artefato.
- Transformar a seção de Metodologia em seção da legenda.
- Explicitar na legenda, quais figuras/componentes do Entrevista criado cabem naquela descrição

## Bibliografia

> [1] SALES, André Barros. Plano de ensino da disciplina. Disponível em: https://aprender3.unb.br/pluginfile.php/2692699/mod_resource/content/34/Plano_de_Ensino%20RE%20022023%20Turma%202.pdf. Acesso em 8 de novembro de 2023.
> [2] Slides da aula “Requisitos – Aula 23” dos professores Milene Serrano e Maurício Serrano. Disponível em: https://aprender3.unb.br/pluginfile.php/2692856/mod_resource/content/2/Requisitos%20-%20Aula%20023.pdf. Acessado em: 8 de novembro de 2023.
> [3] Entrevista do Grupo 7 da Disciplina de Requisitos. Disponível em: <https://requisitos-de-software.github.io/2023.2-DETRAN/Entrega_1/Rich_picture/>. Acesso em 8 novembro de 2023.
> [4] linhadecódigo, Técnicas de VV&T - Validação, Verificação e Teste. Dipsonível em: <http://www.linhadecodigo.com.br/artigo/492/tecnicas-de-vvampt-validacao-verificacao-e-teste.aspx/>. Acesso em 8 de novembro de 2023.
## Histórico de Versão

| Versão | Data de execução | Data prevista de revisão | Descrição | Autor(es) | Revisado |
| :----: | :--------------: | :-------------: | :------------------------: | :------------------------: | :------------------: |
| `1.0` | 08/11/2023 | 10/11/2023 | Criação do artefato | [Yago Passos](https://github.com/yagompassos) | |

### Revisão (V&V)

| Data de Revisão | Cobertura de Versões | Técnica | Revisor(es) |
| :------------: | :-------------: | :--------------------------: | :----------------------------------------: |
| xx/xx/xxxx | `1.0` | - | [Shaíne](https://github.com/ShaineOliveira) |
93 changes: 93 additions & 0 deletions docs/verificacao/grupo7/richpicture.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
# Verificação do artefato ["Rich Picture"](https://requisitos-de-software.github.io/2023.2-DETRAN/Entrega_1/Rich_picture/)

## Introdução

A análise de artefatos desempenha um papel fundamental na avaliação de documentos, projetos e produtos em diversas áreas, incluindo a Engenharia de Requisitos de Software. A abordagem de verificação de artefatos tem por objetivo realizar uma análise minuciosa do conteúdo, estrutura e atributos específicos de um artefato, com o propósito de avaliar sua qualidade, aderência aos requisitos e congruência com os objetivos previamente definidos.

Nesse contexto, o escopo de nossa pesquisa visa à aplicação da técnica de verificação de artefatos ao [Rich Picture](https://requisitos-de-software.github.io/2023.2-DETRAN/Entrega_1/Rich_picture/) desenvolvido pelo [Grupo 7](https://requisitos-de-software.github.io/2023.2-DETRAN/) em seu projeto no contexto do Detran <a id="a" href="#aa">[3]</a>. Ressalta-se que a realização da verificação está estritamente alinhada com as diretrizes e datas estipuladas no [plano de ensino](https://aprender3.unb.br/pluginfile.php/2692699/mod_resource/content/34/Plano_de_Ensino%20RE%20022023%20Turma%202.pdf) <a id="a" href="#aa">[1]</a>.

Para melhor compreensão, é relevante salientar que a técnica de verificação, inspirada no processo de Fagan, abarca uma análise sistemática e rigorosa do artefato em busca de possíveis erros, inconsistências, omissões e desvios em relação aos requisitos. Essa etapa desempenha um papel crucial na garantia da qualidade e na precisão do artefato, assegurando sua conformidade com os objetivos estabelecidos no contexto do projeto ou documento em análise <a id="a" href="#aa">[4]</a>.

## Metodologia

A verificação, segundo o método de inspeção de Fagan, representa uma abordagem formal e estruturada para a revisão de documentos, cujo propósito é a identificação de falhas, erros e problemas nos artefatos, incluindo documentos, código-fonte, especificações e outros elementos correlacionados a projetos de desenvolvimento de software. O processo compreende etapas que envolvem planejamento, revisão geral, preparação, execução da inspeção, correções e acompanhamento <a id="b" href="#bb">[2]</a>. Além disso, a avaliação do artefato em questão também se baseará nos critérios de avaliação especificados no [plano de ensino](https://aprender3.unb.br/pluginfile.php/2692699/mod_resource/content/34/Plano_de_Ensino%20RE%20022023%20Turma%202.pdf) <a id="a" href="#aa">[1]</a>. Para dar maior clareza à análise, implementamos um "conteúdo esperado", que compreende um checklist fundamentado nas questões previamente definidas no plano de ensino <a id="b" href="#bb">[1]</a>.

A inspeção de Fagan é ilustrada na Figura 1 apresentada abaixo, demonstrando as etapas envolvidas no processo.

<div style="text-align: center;">
<img src="../../Fagan.png" alt="image" width="900"/>
</div>

<div style="text-align: center;">
Figura 1: Método de Fagan: Inspeção. (Fonte: Slide “Requisitos – Aula 23” <a id="b" href="#bb">[2]</a>, 2023)
</div>

## Conteúdo esperado

Espera-se que no artefato estejam presentes o rich picture que descreve o aplicativo escolhido, bem como sua legenda detalhada..

### Verificação

Sendo assim, foi elaborada a tabela 1 abaixo relacionando as especificações ideais do artefato, se ele possui ou não o requisito apresentado nas perguntas e quanto a qualidade, baseada na seguinte classificação:

**Possui/Atende**

- Sim
- Não
- Incompleto

**Qualidade**

- Ótimo (Apresenta todos os requisitos do conteúdo esperado)
- Bom (Apresenta parcialmente os requisitos do conteúdo esperado)
- Pode melhorar (Não apresenta os requisitos do conteúdo esperado)

<br>

| ID | Conteúdo | Possui/Atende | Qualidade | Observação |
| --- | ----------------------------------------------------------------------------- | ---------- | ------------- | -------------------------------------------------- |
| 1 | Há histórico de versão padronizado? | Sim | Ótimo | - |
| 2 | Há autor e revisor no artefato? | Sim | Ótimo | - |
| 3 | Existem referências bibliográficas? | Sim | Ótimo | - |
| 4 | Possui hiperlinks para outros artefatos caso necessário? | Não | Ótimo | Não parece necessário. |
| 5 | As tabelas e imagens possuem legenda, fonte e são introduzidas no texto? | Sim | Otimo | - |
| 6 | As referências bibliográficas estão citadas no texto? | Sim | Ótimo | - |
| 6 | Todas informações que o texto trás, citam e são referenciadas com alguma bibliografia? | Não | Bom | A introdução aborda conceitos do Rich Picture, porém não há nenhuma citacão sobre.|
| 7 | Existe uma metodologia definida no artefato? | Sim | Bom | Um pouco simples |
| 9 | A legenda do rich picture detalha todos elementos usados nele? | Sim | Ótimo |-|
| 10 | O Rich Picture condiz com o conteúdo passado em aula? | Sim | Ótimo | - |

<div style="text-align: center">
<p> Tabela 1: Checklist do artefato do Rich Picture. (Fonte: Yago Passos, 2023).</p>
</div>

## Correções e ajustes sugeridos

No geral, o artefato está condizente com o conteudo, mas precisa de pequenos ajustes. O que o Grupo Skoob sugere:

- Evitar incluir informações no texto sem citação, a exemplo da introdução do artefato.
- Transformar a seção de Metodologia em seção da legenda.
- Explicitar na legenda, quais figuras/componentes do rich picture criado cabem naquela descrição


## Bibliografia

> [1] SALES, André Barros. Plano de ensino da disciplina. Disponível em: https://aprender3.unb.br/pluginfile.php/2692699/mod_resource/content/34/Plano_de_Ensino%20RE%20022023%20Turma%202.pdf. Acesso em 8 de novembro de 2023.
> [2] Slides da aula “Requisitos – Aula 23” dos professores Milene Serrano e Maurício Serrano. Disponível em: https://aprender3.unb.br/pluginfile.php/2692856/mod_resource/content/2/Requisitos%20-%20Aula%20023.pdf. Acessado em: 8 de novembro de 2023.
> [3] Rich Picture do Grupo 7 da Disciplina de Requisitos. Disponível em: <https://requisitos-de-software.github.io/2023.2-DETRAN/Entrega_1/Rich_picture/>. Acesso em 8 novembro de 2023.
> [4] linhadecódigo, Técnicas de VV&T - Validação, Verificação e Teste. Dipsonível em: <http://www.linhadecodigo.com.br/artigo/492/tecnicas-de-vvampt-validacao-verificacao-e-teste.aspx/>. Acesso em 8 de novembro de 2023.
## Histórico de Versão

| Versão | Data de execução | Data prevista de revisão | Descrição | Autor(es) | Revisado |
| :----: | :--------------: | :-------------: | :------------------------: | :------------------------: | :------------------: |
| `1.0` | 08/11/2023 | 10/11/2023 | Criação do artefato | [Yago Passos](https://github.com/yagompassos) | |

### Revisão (V&V)

| Data de Revisão | Cobertura de Versões | Técnica | Revisor(es) |
| :------------: | :-------------: | :--------------------------: | :----------------------------------------: |
| xx/xx/xxxx | `1.0` | - | [Shaíne](https://github.com/ShaineOliveira) |

0 comments on commit 0a331d1

Please sign in to comment.