Verificação - Análise de Documentos
Introdução
Este documento é destinado para a revisão do artefato Análise de Documentos do grupo 6 - Letterbox, vale ressaltar que a avaliação é feita de maneira imparcial, sem a intenção de atacar ninguém.
Versão do arquivo analisada foi a 1.0 no dia 14/06/2023.
Metodologia
A verificação foi feita por meio da insperção, utilizando uma checklist com base em repositórios antigos e no plano de ensino da disciplina de requisitos de software. Na parte do conteúdo, foi usado como base o capítulo 7, tópico 3, do livro Engeharia de Requisitos, escrito por Carlos Vazquez e Guilherme Simões. A principio, foram criadas duas tabelas nas quais, temos 3 campos, "Questão": pergunta que será respondida, "Resposta" na qual como resultados válidos, podemos ter:
- Sim : caso um critério for atendido.
- Não : caso um critério não for atendido.
- Incompleto : caso um critério for parcialmente atendido.
Também temos o campo "Observação", um campo no qual pode ser feito algum comentário a respeito da questão em específico. Posteriormente, neste mesmo documento, pode-se encontrar uma sessão na qual serão sumarizados todos os problemas do artefacto em estudo e outra nos quais se encontram as sugestões de soluções dos mesmos.
Checklist de documento
| ID | Questão | Resposta | Observação |
|---|---|---|---|
| 1 | O artefato possui Introdução? | Sim | |
| 2 | O artefato artefato possui uma Bibliografia/Referência Bibliográfica? | Sim | |
| 3 | O artefato possui um Histórico de Versões com o id e descrição das versões, data, autores e revisores? | Sim | |
| 4 | Todos os textos estão na norma padrão? | Sim | |
| 5 | As tabelas são chamadas no texto? | Sim | |
| 6 | Os revisores são pessoas diferentes dos autores? | Sim |
Tabela 1 - Checklist do documento
Fonte: Autores
Checklist do conteúdo
| ID | Questão | Resposta | Observação |
|---|---|---|---|
| 7 | Foram definidos os objetivos e necessidades a serem respondidos pela análise? | Não | |
| 8 | Os documentos em questão são referenciados em alguma parte do texto? | Incompleto | Os documentos estão na bibliografia, mas não são explicitamente mencionados no texto |
| 9 | A análise responde os objetivos e necessidades definidos? | Não | Não foram definidos objetivos e necessidades |
| 10 | Foi feita uma memória de levantamento (relatório que consolida a análise) para documentar as respostas das questões iniciais? | Não | |
| 11 | Houve alguma forma de catalogação dos documentos utilizados na análise? | Incompleto | Há apeanas a menção da fonte dos documentos na bibliografia |
| 12 | Os requisitos elicitados são coerentes com as informações presentes no documento? | Sim | |
| 13 | A classificação dos requisitos em relação à funcionalidade está correta de acordo com a teoria? | Sim |
Tabela 2 - Checklist dos pontos relativos ao conteúdo
Fonte: Autores
Observações e Problemas encontrados
ID7
Segundo Vazquez e Simões (2016), a preparação da análise de documentos deve determinar as necesidades de informação a serem respondidas. O documento analisado não define quais são as informações que se busca responder com a análise.
ID8
Em nenhum momento do texto é referenciado sobre quais tópicos foram usados para determinadas conclusões feita na Metodologia.
ID9
Como não foram definidos objetivos e necessidades de informação, não há respostas definidas para eles.
ID10
Vazquez e Simões (2016) definem que as respostas para as questões iniciais devem ser elaboradas e apresentadas em relatório que consolida a análise feita.
ID11
Não foi identificada uma catalogação dos documentos analisados, o documento utilizado para a análise está mencionado apenas na bibliografia do artefato.
Sugestões
A maioria dos problemas encontrados se devem à falta da elaboração das necessidades de informação na preparação para a análise. Recomendo que seja criado um tópico chamado "Preparação", em que sejam definidas essas questões a serem respondidas pela análise. O livro Engenharia de Requisitos (VAZAQUEZ, SIMÕES 2016) define bons critérios para a elaboração dos objetivos na página 150.
A memória de levantamento que contém as respostas para as questões definidas nada mais é do que um relatório explicando como a análise em si foi feita e esclarecendo quais partes dos documentos analisados respondem cada necessidade de informação em específico.
Por fim, o livro usado como referência possui uma tabela na página 152 para catalogação de um documento. Recomendo que seja elaborado essa catalogação para o documento analisado. Caso sejam analisados mais documentos depois dessa verificação, essa catagolação é extremamente importnte.
Bibliografia
[1] VAZQUEZ C. E.; SIMÕES G. S.. Engenharia de Requisitos. Brasport, 2016. p. 148 - 153
Histórico de Versão
| Versão | Data | Descrição | Autor(es) | Revisor(es) |
|---|---|---|---|---|
1.0 |
08/06/2023 | Criação do documento. | Leonardo | Beatriz |