Guia de Estilo
Introdução
Este documento é de verificação do artefato Guia de Estilo produzido pelo Grupo 2 que tem o projeto voltado ao site Wikipedia. Com base nisso, o documento de Guia de Estilo será verificado de acordo com a literatura Interação-Humano-Computador de Barbosa e Silva.
Metodologia
Para a verificação do artefato, será feito uma checklist com base na literatura já citada anteriormente. A mesma será composta por 5 perguntas que serão o padrão exigido para a documentação e em seguida perguntas envolvendo o conteúdo do artefato Guia de Estilo . Na tabela 1 estão expostos todas as perguntas abordadas para verficação do artefato, a versão utilizada para a verificação será a 1.0, feita no dia 13 de maio de 2023.
Tabela 1 - Checklist do artefato guia de estilo.
| ID | Descrição | Avaliação |
|---|---|---|
| 1 | O artefato possui Introdução ? | - |
| 2 | O artefato artefato possui uma Bibliografia/Referência Bibliográfica ? | - |
| 3 | O artefato possui um Histórico de Versões com o id e descrição das versões, data, autores e revisores ? | - |
| 4 | Todos os textos estão na norma padrão ? | - |
| 5 | Todas as tabelas e imagens são chamadas no texto, possuem legendas e fontes ? | - |
| 6 | O guia de estilo do projeto se estrutura a partir da introdução com o objetivo do guia de estilo ? | - |
| 7 | O guia de estilo do projeto se estrutura a partir da introdução com organização e conteúdo do guia de estilo ? | - |
| 8 | O guia de estilo do projeto se estrutura a partir da introdução com público alvo do guia de estilos ? | - |
| 9 | O guia de estilo do projeto se estrutura a partir da introdução em como utilizar o guia ? | - |
| 10 | O guia de estilo do projeto se estrutura a partir da introdução em como manter o guia ? | - |
| 11 | O guia de estilo do projeto se estrutura a partir do resultados de análise com uma descrição do ambiente de trabalho do usuário ? | - |
| 12 | O guia de estilo do projeto se estrutura a partir dos elementos de interface com disposição espacial e grid ? | - |
| 13 | O guia de estilo do projeto se estrutura a partir dos elementos de interface com janelas ? | - |
| 14 | O guia de estilo do projeto se estrutura a partir dos elementos de interface com tipografia ? | - |
| 15 | O guia de estilo do projeto se estrutura a partir dos elementos de interface com cores ? | - |
| 16 | O guia de estilo do projeto se estrutura a partir dos elementos de interação com estilos de interação ? | - |
| 17 | O guia de estilo do projeto se estrutura a partir dos elementos de interação com uma seleção de estilo ? | - |
| 18 | O guia de estilo do projeto se estrutura a partir dos elementos de interação com aceleradores (teclas de atalho) ? | - |
| 19 | O guia de estilo do projeto se estrutura a partir dos elementos de ação com preenchimento de campos ? | - |
| 20 | O guia de estilo do projeto se estrutura a partir dos elementos de ação seleção ? | - |
| 21 | O guia de estilo do projeto se estrutura a partir dos elementos de ação ativação ? | - |
| 22 | O guia de estilo do projeto se estrutura a partir do vocabulário e padrões, possuindo um terminologia ? | - |
| 23 | O guia de estilo do projeto se estrutura a partir do vocabulário e padrões, possuindo tipos de tela (para tarefas comuns) ? | - |
| 24 | O guia de estilo do projeto se estrutura a partir do vocabulário e padrões, possuindo sequências de diálogos (e.g., para feedback ou confirmação de uma operação) ? | - |
Fonte: Rafael Ferreira.
Na tabela 1, os campos de “Avaliação” sera preenchidos no desenvolvimento em que haverá uma discussão a respeito de alguns itens. Para tal será utilizado o ID da pergunta.
Desenvolvimento
O artefato foi verificado e gerou os resultados da tabela 2, sendo possível identificar os tópicos faltantes e/ou concluídos.
Tabela 2 - Checklist preechido.
| ID | Descrição | Avaliação |
|---|---|---|
| 1 | O artefato possui Introdução ? | Sim |
| 2 | O artefato artefato possui uma Bibliografia/Referência Bibliográfica ? | Não |
| 3 | O artefato possui um Histórico de Versões com o id e descrição das versões, data, autores e revisores ? | Incompleto |
| 4 | Todos os textos estão na norma padrão ? | Sim |
| 5 | Todas as tabelas e imagens são chamadas no texto, possuem legendas e fontes ? | Sim |
| 6 | O guia de estilo do projeto se estrutura a partir da introdução com o objetivo do guia de estilo ? | Sim |
| 7 | O guia de estilo do projeto se estrutura a partir da introdução com organização e conteúdo do guia de estilo ? | Sim |
| 8 | O guia de estilo do projeto se estrutura a partir da introdução com público alvo do guia de estilos ? | Sim |
| 9 | O guia de estilo do projeto se estrutura a partir da introdução em como utilizar o guia ? | Sim |
| 10 | O guia de estilo do projeto se estrutura a partir da introdução em como manter o guia ? | Sim |
| 11 | O guia de estilo do projeto se estrutura a partir do resultados de análise com uma descrição do ambiente de trabalho do usuário ? | Sim |
| 12 | O guia de estilo do projeto se estrutura a partir dos elementos de interface com disposição espacial e grid ? | Sim |
| 13 | O guia de estilo do projeto se estrutura a partir dos elementos de interface com janelas ? | Sim |
| 14 | O guia de estilo do projeto se estrutura a partir dos elementos de interface com tipografia ? | Sim |
| 15 | O guia de estilo do projeto se estrutura a partir dos elementos de interface com cores ? | Sim |
| 16 | O guia de estilo do projeto se estrutura a partir dos elementos de interação com estilos de interação ? | Sim |
| 17 | O guia de estilo do projeto se estrutura a partir dos elementos de interação com uma seleção de estilo ? | Sim |
| 18 | O guia de estilo do projeto se estrutura a partir dos elementos de interação com aceleradores (teclas de atalho) ? | Sim |
| 19 | O guia de estilo do projeto se estrutura a partir dos elementos de ação com preenchimento de campos ? | Incompleto |
| 20 | O guia de estilo do projeto se estrutura a partir dos elementos de ação seleção ? | Incompleto |
| 21 | O guia de estilo do projeto se estrutura a partir dos elementos de ação ativação ? | Incompleto |
| 22 | O guia de estilo do projeto se estrutura a partir do vocabulário e padrões, possuindo um terminologia ? | Sim |
| 23 | O guia de estilo do projeto se estrutura a partir do vocabulário e padrões, possuindo tipos de tela (para tarefas comuns) ? | Sim |
| 24 | O guia de estilo do projeto se estrutura a partir do vocabulário e padrões, possuindo sequências de diálogos (e.g., para feedback ou confirmação de uma operação) ? | Sim |
| 25 | O guia de estilo apresenta como os princípios gerais serão adicionados no projeto ? | Não |
Fonte: Rafael Ferreira.
Problemas encontrados
Com base na tabela preenchida, serão feitas considerações acerca de alguns itens da tabela.
ID 2 - O artefato artefato possui uma Bibliografia/Referência Bibliográfica ?
Ficou faltando a bibliografia do site utilizado no qual vocês retiraram as imagens.
ID 3 - O artefato artefato possui uma Bibliografia/Referência Bibliográfica ?
- Ficou faltando a parte da correção realizada no histórico de versão, pois na apresentação da entrega 3 não tinha como utilizar o guia de estilo, mas depois foi adicionado e não apresentou quem fez essa correção no histórico de versão do artefato.
ID 6 - O guia de estilo do projeto se estrutura a partir da introdução com o objetivo do guia de estilo ?
Na parte do objetivo do guia de estilo vocês mencionaram qual é o objetivo de se utilizar um guia de estilo, mas não identifiquei a parte de “para o que” vocês utilizaram o guia de estilo.
ID 13 O guia de estilo do projeto se estrutura a partir dos elementos de interface com janelas ?
Na parte dos elementos de interface no tópico janelas vocês apresentaram uma ordem que as figuras serão apresentadas, mas elas não seguem essa ordem estão trocadas. Exemplo: “São diversas as janelas contidas no site, porém, pode-se destacar as principais, como a página inicial, a página de um artigo qualquer, e a página de edição de um artigo. As páginas citadas podem ser visualizadas na Figura 2, Figura 3 e Figura 4.”
ID 19, 20, 21 O guia de estilo do projeto se estrutura a partir dos elementos de ação ?
Nos elementos de ação foram apresentados que existem, mas não apresentaram os elementos encontrados na análise como na ativação (ícones, botões ou elementos clicáveis), na seleção (elementos selecionáveis como campos de seleção de datas e etiquetas mencionado no texto) e no preenchimento de campos (locais para serem preenchidos).
ID 22 O guia de estilo do projeto se estrutura a partir do vocabulário e padrões, possuindo um terminologia ?
Na parte de vocabulário e padrões criar uma pequena introdução sobre os terminologias indicando o motivo da utilização dessas terminologias.
ID 25 O guia de estilo apresenta como os princípios gerais serão adicionados no projeto ?
Não é apresentado os princípios gerais que são adicionados no projeto.
Sugestões
Primeiramente parabenizar pelo trabalho o artefato está bem escrito e detalhado, o guia de estilo está bem apresentados com suas devidas descrições, demonstrando uma boa compreensão da criação desse artefato.
Adicionei algumas sugestões para deixar o artefato ainda melhor:
- ID 2: Adicionar a bibliografia do site que foi utilizado as imagens.
- ID 3: Atualizar o histórico de versões com a modificações atuais realizadas.
- ID 6: Descrever quais objetivos vocês utilizam um guia de estilo para o seu projeto de uma maneira mais objetiva e simplificada identificando os elementos analisados como no exemplos no Grupo 1 - Bilheteria Digital.
- ID 13: adicionar subtítulos para cada figura para uma melhor rastreabilidade.
- ID 19, 20, 21: No repositório do Grupo 6 Detran Go eles apresentaram esses três elementos de ação.
- ID 22: Já que o site que vocês utilizaram é um portal de pesquisa indicar que os termos listados na terminologia são condizentes com um portal de pesquisa e edição de textos.
- ID 25: Identificar no guia de estilo os princípios gerais que estão de acordo com os elementos de interface, interação e ação presentes do guia de estilo.
- Na tipografia pode remover o parêntese da Figura 5, basta chamá-la no texto, como no tópico das cores chamando a Figura 6.
Referências Bibliográficas
1. BARBOSA, S. D. J.; SILVA, B. S. Interação Humano-Computador. Rio de Janeiro: Elsevier, 2011.
Bibliografia
Guia de Estilo Detran GO. Disponível em: <https://interacao-humano-computador.github.io/2023.1-DetranGO/analise_requisitos/guia_estilo/>.Acesso em 04 de junho de 2023. Guia de Estilo Bilheteria Digital. Disponível em: <https://interacao-humano-computador.github.io/2023.1-BilheteriaDigital/analise-de-requisitos/guia-de-estilo/>.Acesso em 04 de junho de 2023. Guia de Estilo Wikipedia. Disponível em: <https://interacao-humano-computador.github.io/2023.1-Wikipedia/analise-de-requisitos/guiaDeEstilo/>.Acesso em 04 de junho de 2023.
Histórico de Versões
| Versão | Data | Descrição | Autor(es) | Revisor(es) |
|---|---|---|---|---|
1.0 |
04/06/2023 | Criação do documento | Rafael Ferreira | Douglas Alves e Geovanna Maciel |
1.1 |
09/06/2023 | Correções nos probremas encontrados | Rafael Ferreira | Douglas Alves e Geovanna Maciel |