Padronização do Projeto
Introdução
Este documento é uma verificação do artefato Padronização do Projeto na versão 1.0 de data 06/10/2023, autorado por Doan Filho, que é integrante do grupo 03, cujo projeto tem como foco o aplicativo BRB Mobilidade.
Metodologia
A verificação do artefato seguirá o planejamento desenvolvido pelo nosso grupo. Conforme detalhado no planejamento, destaca-se a relevância do subtópico da metodologia neste documento, onde será apresentada a tabela contendo os checklists utilizados para realizar essa verificação. O referido checklist pode ser consultado na Tabela 1.
Tabela 1 - Checklist
ID | Descrição | Avaliação | Observação |
---|---|---|---|
1 | O histórico de versão é padronizado? | - | - |
2 | Possui o(s) autor(es) e o(s) revisor(es) do artefato? | - | - |
3 | O artefato possui referências bibliográficas e/ou bibliografia? | - | - |
4 | Todas as tabelas e imagens são chamadas no texto, possuem legendas e fontes? | - | - |
5 | Todos os textos estão na norma padrão? | - | - |
6 | Nos componentes da padronização há um exemplo de como deve ser? | - | - |
7 | No guia github há como deve ser utilizado cada componente? | - | - |
8 | Há introdução do artefato? | - | - |
Fonte: Milena Baruc
Desenvolvimento
A tabela 2 apresenta o checklist preenchido após a verificação do artefato.
Tabela 2 - Checklist preenchido
ID | Descrição | Avaliação | Observação |
---|---|---|---|
1 | O histórico de versão é padronizado? | Sim | - |
2 | Possui o(s) autor(es) e o(s) revisor(es) do artefato? | Sim | - |
3 | O artefato possui referências bibliográficas e/ou bibliografia? | Sim | - |
4 | Todas as tabelas e imagens são chamadas no texto, possuem legendas e fontes? | Não | Nenhuma tabela/imagem possui legenda e fonte, e também não são chamadas no texto. Além disso, a imagem em: "Imagens: tag, link referênciado, padrão, legendas." está quebrada. |
5 | Todos os textos estão na norma padrão? | Sim | - |
6 | Nos componentes da padronização há um exemplo de como deve ser? | Sim | - |
7 | No guia github há como deve ser utilizado cada componente? | Sim | - |
8 | Há introdução do artefato? | Sim | - |
Fonte: Milena Baruc
Sugestões de Melhorias
As ideias foram documentadas de forma clara e concisa o que demonstra um cuidado na documentação,porém está faltando colocar legendas e fontes das tabelas/imagens, além de cita-lás no texto. Uma dica que pode melhorar o histórico de versões é colocar o link do github dos autores/revisores. Além dos fatos inseridos acima, o uso de referências bibliograficas e bibliografia está errada, de acordo com [1], podemos dizer que Bibliografia: conjunto de obras consultadas. Deve ser inserida no final do trabalho. Referência bibliográfica: conjunto de obras citadas. Deve ser inserida em cada citação e, no final do trabalho, assim sendo as referências citadas não foram inseridas no texto, logo pressuponho que sejam bibliografias.
Referências Bibliograficas
[1] DIANA, Daniela. Bibliografia. Toda Matéria, [s.d.]. Disponível em: https://www.todamateria.com.br/bibliografia/. Acesso em: 13/11/2023.
Bibliografia
Raphael Pires, Qual a importância da padronização de documentos?, Disponível em: https://rockcontent.com/br/blog/padronizacao-de-documentos/, Acesso em : 13/11/2023.
📑 Histórico de Versões
Versão | Data | Descrição | Autor | Revisor |
---|---|---|---|---|
1.0 |
13/11/2023 | Criação do Documento | Milena Baruc | Mayara Alves |