Verificação do artefato "Análise de Documentos"
Introdução
A técnica de verificação de artefatos é uma etapa crítica no processo de avaliação de documentos, projetos ou produtos em várias áreas, incluindo Requisitos de Software. Essa abordagem visa examinar detalhadamente o conteúdo, a estrutura e as características específicas de um artefato para avaliar sua qualidade, conformidade com requisitos e adequação aos objetivos definidos.
Neste contexto, pretendemos aplicar essa técnica ao artefato "Análise de Documentos" desenvolvido pelo Grupo 7.[3]. A verificação é baseada no plano de ensino e nas datas estabelecidas nele.
Para esclarecer, a técnica de verificação, inspirada no processo de Fagan, implica na análise rigorosa e sistemática do artefato em busca de erros, inconsistências, lacunas e não conformidades com os requisitos. É uma etapa essencial para garantir a qualidade e a precisão do artefato, assegurando que ele atenda aos objetivos estabelecidos no contexto do projeto ou documento em questão.
Metodologia
A verificação por inspeção de Fagan é uma técnica formal e estruturada de revisão de documentos que visa identificar erros, falhas e problemas em artefatos como documentos, código-fonte, especificações e outros itens relacionados a projetos de desenvolvimento de software. O processo envolve etapas que incluem planejamento, visão geral, preparação, inspeção, correção e acompanhamento.[2]. Além disso, para verificar o artefato em questão será baseado também nos critérios de avaliação do artefato, disponível como prévia no plano de ensino. O processo será composto pelo "conteúdo esperado" onde foi realizado um checklist baseado nas perguntas do plano de ensino.[1].
Método de Fagan: Inspeção. (Fonte: Slides da aula “Requisitos – Aula 23” dos professores Milene Serrano e Maurício Serrano, 2023)
Conteúdo esperado
Espera-se que no artefato encontre todos os objetivos e necessidades atendidas com a análise dos documentos.
Verificação
Sendo assim, foi elaborada a tabela 1 e a tabela 2 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
- 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)
A Tabela 1 contém perguntas no que diz respeito à formatação do artefato.
| ID | Conteúdo | Possui | Qualidade | Observação |
|---|---|---|---|---|
| 1 | Há histórico de versão padronizado? | Sim | Ótimo | |
| 2 | Há autor e revisor no artefato? | Incompleto | Bom | Na versão 1.0 não possui um revisor |
| 3 | Existem referências bibliográficas? | Não | Pode melhorar | Não foi apresentada nenhuma referência bibliográfica |
| 4 | Possui hiperlinks para outros artefatos caso necessário? | Sim | Bom | O hiperlink apresentado não está no formato de link |
Tabela 1: Perguntas selecionadas: Formatação do artefato. (Fonte: Shaíne Oliveira, 2023)
A Tabela 2 contém perguntas no que diz respeito ao conteúdo do artefato.
| ID | Conteúdo | Possui | Qualidade | Observação |
|---|---|---|---|---|
| 1 | Há participação do cliente ou persona na elicitação de requisitos? | Não | Pode melhorar | O processo de elicitação de requisitos deve ser feito com a presença de um cliente e/ou persona |
| 2 | Existe uma metodologia definida no artefato? | Não | Pode melhorar | No artefato poderia ter colocado como foi feito todo o processo de elicitação com o nome dos participantes, horários, etc. |
| 3 | Há gravação da elicitação de requisitos? | Não | Pode melhorar | Não há gravação |
| 4 | Foram definidos os objetivos e necessidades a serem respondidos pela análise? | Sim | Bom | Poderiam ter esclarecido melhor quais eram os objetivos e necessidades para facilitar no entendimento do artefato |
| 5 | A análise responde os objetivos e necessidades definidos? | Sim | Ótimo |
Tabela 2: Perguntas selecionadas: Conteúdo do artefato. (Fonte: Shaíne Oliveira, 2023)
Correções e ajustes sugeridos
O artefato precisa de ajustes, pois não seguiu quase todos os checklists apresentados na tabela. Para isso, é recomendado fazer os ajustes seguindo as observações:
Referentes a tabela 1:
- ID2 - Há autor e revisor no artefato?
- ID3 - Existem referências bibliográficas?
- ID4 - Possui hiperlinks para outros artefatos caso necessário?
Referentes a tabela 2:
- ID1 - Há participação do cliente ou persona na elicitação de requisitos?
- ID2 - Existe uma metodologia definida no artefato?
- ID3 - Há gravação da elicitação de requisitos?
- ID4 - Foram definidos os objetivos e necessidades a serem respondidos pela análise?
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 7 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: 7 de novembro de 2023.
[3] Personas do Grupo 7 da Disciplina de Requisitos. Disponível em: https://requisitos-de-software.github.io/2023.2-DETRAN/Entrega_2/analise_de_documentos/. Acesso em 7 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 |
07/11/2023 | 10/11/2023 | Criação do artefato | Shaíne | |
1.1 |
11/11/2023 | 13/11/2023 | Correções no artefato | Shaíne |
Revisão
| Data de Revisão | Cobertura de Versões | Técnica | Revisor(es) |
|---|---|---|---|
| xx/xx/xxxx | -- | --- | Rafael |