| Periodicidade: Diária |
|---|
Garantir que todas as demandas de Revisão de Padrões sejam feitas para novas páginas de manual e atualizações de docs.
Procedimentos
Verifique diariamente o Filtro: Revisar Padrões. O intuito é evitar o trabalho de ter que ficar delegando a pendência para o redator.
Por isso, ela ficará Sem responsável assim que aprovada pela Revisão Técnica. O filtro apresentará todas as pendências do fluxo que estão com ou sem delegações. A ideia é que o monitoremos; quem estiver disponível, delega a tarefa para si e revisa.
Padrões e Boas Práticas
Revisar padrões de uma documentação técnica significa analisar e avaliar se a documentação segue as normas, diretrizes e padrões técnicos estabelecidos para a área em questão.
Esses padrões podem incluir normas de formatação, padronização de termos e vocabulário específico, requisitos de segurança, conformidade regulatória, entre outros.
A revisão de padrões é uma etapa importante na produção de documentação técnica, pois garante que o conteúdo seja consistente, preciso e compreensível para o público-alvo.
O Checklist à direita resume os pontos que o revisor precisa avaliar para confirmar a qualidade do conteúdo. Para mais detalhes, acesse Alterdata Guia de Estilo de Publicações Técnicas.
- Abreviações - O texto só utiliza abreviações conhecidas pelo público-alvo.
- Emprego das Iniciais Maiúsculas - Verificar o emprego correto de iniciais maiúsculas.
- Cores - Verificar se as cores utilizadas no manual são as definidas para o sistema.
- Dicas, Notas e Avisos - Dicas, Notas e visos devem estar sinalizados em caixas apropriadas.
- Gênero - O texto utiliza gênero comum, sem direcionamento.
- Gerúndio e Particípio - Não usar Gerúndio e Particípio. Tempo presente.
- Listas - Verificar se os elementos da lista estão ordenados e alinhados corretamente.
- Numerações e Numerais - Verificar o uso correto de vírgula, parênteses e barras.
- Tabela/Campos - Verificar a utilização correta de tabelas e campos.
- Termos para Clique e Seleção - Verificar o uso correto dos termos para seleção.
- Títulos e Sumários - Verificar se a ordenação está correta.
- Utilização de Ilustrações e Imagens - Verificar o uso correto de ilustrações e imagens.
- Voz - O texto deve estar no presente e os passos no imperativo.
Fluxo de Revisão
Se tiver pendência no Filtro: Revisar Padrões, atribua para si e mude o status para Em Revisão.
Revisão Aprovada
O conteúdo corresponde com os padrões e boas práticas citadas acima. Delegue a pendência para o redator responsável como Aprovado.
Alteração de manual, Base de Conhecimento ou Novidades do Sistema Para um dos tipos marcados, faça a transição para Aprovado - Publicar.
No menu Fluxo de Trabalho, faça a transição para Aprovado - Nova Documentação. |
Revisão Reprovada
Informação
Ajustes simples, como, por exemplo, falta de espaçamento e pequenos erros ortográficos (vírgula, acentuação, etc.) podem ser feitos pelo próprio revisor. Isto é, não é necessário reprovar a revisão, basta corrigir e delegar como Aprovado.
Ao reformular algum texto ou passo, comunique o redator responsável para verificar se não mudou o contexto da explicação.
Caso o conteúdo não esteja conforme com os padrões e boas práticas citadas acima, siga os procedimentos abaixo:
No conteúdo, utilize a ferramenta Talk
para descrever os ajustes que precisam ser feitos. Para habilitar a ferramenta, tecle d.
- No Fluxo de Trabalho, delegue a pendência para o redator responsável como Não Aprovado.