| Periodicidade: Diária |
|---|
Garantir que todas as demandas de Destaque da Versão possuem a respectiva demanda de documentação criada. Não visa a criação da documentação em si.
O Supervisor da Qualidade indica se o processo é um destaque da versão no campo Destaque da versão e o Redator Técnico deve abrir uma demanda de manual para criar a documentação.
Verifique diariamente o quadro Alt Geral - Escritor Técnico - Destaques da versão. Nesse quadro são apresentadas as demandas que os Supervisores marcam para Destaque, porém só vai aparecer se o campo versão corrigidas estiver preenchido. Para cada demanda crie uma tarefa de documentação no projeto pertinente, preenchendo os campos:
Campo | Descrição |
|---|---|
| Projeto | Projeto pertinente ao sistema a ser documentado. |
| Tipo de item | Manual / Documentação. |
| Resumo | Resumo da alteração ou manual a ser criado, essa informação é utilizada para facilitar a identificação da demanda. |
| Descrição | Informação detalhada do que será alterado ou criado. |
| Responsável | Usuário que irá escrever a documentação. |
| Versões Corrigidas | Igual ao da demanda que originou a criação desta documentação ou versão em qual a mesma será liberada. |
| Data de início | Informe 5 dias antes da data de liberação da versão. |
| Data de entrega | Informe 1 dia antes da liberação da versão. |
| Data de publicação | Informe a data da liberação da versão. |
| Documentação | Marcar como Novidade do sistema conforme a documentação a ser alterada ou atualizada. |
| Referências | Indicar os arquivos de manual com o nome do tópico alterado e as URLs da base de conhecimento. Tanto nas tarefas, quanto nas sub-tarefas de manual. Nos itens de tópicos de manuais referentes a alteração, acrescentar a notação (A) no final da linha. Exemplo de preenchimento do campo: <Linha do Produto> - Manual <Produto> ou <Linha do Produto> - Manual <Produto> (A) Versão do Manual: 7.00.00 Acesso: http://help.alterdata.com.br/display/WISEPCP/.Produto+Acabado+v1.02.45.3 Página: Produto>/ <Página> ou <Produto>/ <Página> / <Sub Página> /Tópico: "Custo estimado" (Em casos de alteração) |
| Pendências Linkadas | Adicione um link do tipo Documenta. |
| Ocorrência | Informe a demanda que originou a criação. |
O destaque da versão, que é publicado no espaço separado do manual do sistema, não tem controle de versão. Por esse motivo, o acesso à página do Destaque da Versão deve ser restringido aos clientes enquanto ele não for aprovado. Para isso, siga os procedimentos abaixo:
- Acesse o Confluence.
- Crie uma nova página de novidades da versão, seguindo o template descrito no Alterdata Guia de Estilo de Publicações Técnicas.
- Clique em cima do
. - Selecione a opção Sem restrição.
- Clique em Exibição e edição restritas.
- Inclua o usuário Confluence-users.
- Clique em Aplicar.
Quando for aprovado pelo Inspetor de Qualidade deve retirar a restrição de visualização da página. Para isso:
- Acesse a página no Confluence.
- Clique em cima do.
- Selecione a opção Sem restrições.
- Clique em Aplicar.
Após criar a tarefa e o espaço no Confluence, siga os procedimentos para as tarefas do tipo Manual/Documentação.
Dicas e Informações
O Destaque das Versões tem como objetivo chamar a atenção do cliente para um novo recurso do sistema ou melhoria, apresentando o que agrega em valor para o negócio ou rotinas do cliente, ou seja, tente vender o recurso para o cliente.
Algumas dicas para escrita desse texto:
- Forma sucinta contendo uma breve explicação do que é e quais os benefícios para o cliente;
- Não coloque passo a passo de utilização. Este deve ser descrito na página do Help com a explicação do recurso. Dessa forma, você pode colocar um link nos primeiros passos para página com a explicação completa;
- A imagem adicionada deve ser algo que atraia a atenção do cliente e seja algo de destaque. Evite colocar tela de configurações, por exemplo;
- Utilize uma linguagem mais coloquial e direta para atingir vários públicos alvos, não somente quem conhece tecnicamente o sistema;
- Evite a utilização de termos técnicos.