Fluxo Principal

Procedimentos

Acesse diariamente o quadro Alt Geral - Redator Técnico - Processo de manual sem demanda, para verificar se existe alguma pendência, caso tenha, verifique se a mesma é para criação de um novo manual, de acordo com as situações:

Trata-se de um novo sistema ou produtos.
Trata-se de um novo recurso do sistema acessado separadamente. Exemplo: Ordem de serviço.

Para iniciar a elaboração de uma nova documentação é necessário seguir os passos abaixo.

Padrões e Boas Práticas

Todas as documentações deverão seguir os padrões, guias de estilo e explicações sobre boas práticas descritas no Alterdata Guia de Publicações Técnicas.

Criação de Documentação

Crie uma tarefa do tipo Nova documentação/Manual, e preencha os campos abaixo:

Campo	Descrição
Projeto	Projeto pertinente ao sistema a ser documentado.
Tipo de Item	Nova documentação/manual.
Resumo	Resumo do manual (espaço) a ser criado. Essa informação é utilizada para facilitar a identificação da demanda. Ex.: Escrita Técnica.
Descrição	Informação detalhada do que será criado.
Data de entrega	Informe a data de entrega do manual concluído, revisado e publicado.

Todas as demandas a serem executadas ficam no status A fazer.

Estudar Material

A fase de estudo do material engloba os seguintes procedimentos: Antes de criar o espaço, configurá-lo e de estudar o material, acesse a pendência de Nova documentação e faça a transição Iniciar estudo para confeccionar manual.

Crie e configure o espaço no Confluence.
Configure a base do sistema.
Estude o funcionamentos do sistema. Conforme os tópicos abaixo:
- Verifique as demandas que estão ligadas à criação do recurso/sistema.
- Verifique pessoalmente com o Inspetor de qualidade que fez os testes tudo que você não conseguir entender pela leitura das demandas.
- Entenda qual a(s) principal(is) saída(s) (produto final) que o sistema/recurso proporciona. Por exemplo, no caso de um sistema como o SHOP, o produto final seria uma Nota Fiscal Eletrônica.
- Analise quais são as configurações necessárias para ser possível a geração do produto final do tópico anterior, fazendo anotações para que você possa planejar a escrita, por exemplo:
  O que é necessário para gerar uma Nota Fiscal?
  - Cadastrar Cliente
  - Adicionar Produto
  - Cadastrar Fornecedor
  - Calcular ICMS
  - Cadastrar Operação
  Neste caso, podemos iniciar a criação dos tópicos a partir da pergunta levantada. Sendo que cada cadastro necessário deve ser explicado como um tópico separado. Pode ocorrer ao escrever o cadastro de cliente, por exemplo, que você veja a necessidade de criar outros tópicos, como o cadastro de cidade.
  Seguindo esta abordagem para escrever o manual é possível cobrir praticamente todas as rotinas que o cliente realiza
- Instale em sua máquina o sistema/recurso criado e faça testes exploratórios verificando as funcionalidades, nome dos campos, etc.
Elabore na sua máquina um esboço dos primeiros passos do projeto.
Apresente o esboço dos primeiros passos do manual para o Revisor Técnico analisar.
Crie as páginas no Confluence com base no esboço dos primeiros passos.
É importante que você Inclua a Tag do código HTML com os parâmetros do Google Analytics.
Escreva a documentação (criar a medida que for escrevendo).

Esses procedimentos estão em forma de check-list na tarefa de Nova documentação/manual. À medida que o Redator Técnico for fazendo deve ir marcando o check-box.
Caso durante o estudo do material seja necessário parar a execução, faça a transição Paralisar.

Após concluir o estudo conforme os procedimentos informados anteriormente, faça a transição Escrever manual. Ao fazer essa transição a pendência fica com o status Em andamento.

Escrever Manual

A elaboração, revisão e contabilização de tempo do novo manual deve ser realizada na pendência do tipo manual/documentação, conforme explicado abaixo.

Enquanto o Redator Técnico estiver elaborando a documentação, a pendência de Nova documentação/manual deve permanecer com o status Em andamento, esse status não contabiliza tempo.

A elaboração do manual deve ser feita separada por páginas, sendo que para cada página deve abrir uma pendência do tipo Manual/documentação e preencher conforme abaixo:

Campo	Descrição
Projeto	Projeto pertinente ao sistema a ser documentado.
Tipo de Item	Manual / Documentação.
Resumo	Informe o tópico que será feito nessa tarefa para o novo manual.
Descrição	Informação detalhada do que será alterado ou criado.
Responsável	Usuário que irá escrever a documentação.
Pendências Linkadas	Informe o Link do tipo é tarefa filho de
Ocorrências	Informe o número da pendência do Novo manual.
Versões corrigidas	Igual ao da demanda que originou a criação desta documentação ou versão em qual a mesma será liberada. O preenchimento do campo é obrigatório.
Tipo de Documentação	Marque a documentação como Manual.
Referências	Indicar os arquivos de manual com o nome e link do tópico alterado ou as URLs da base de conhecimento. Exemplo de preenchimento do campo: <Linha do Produto> - Manual <Produto> Versão do Manual: Acesso: http://ajuda.alterdata.com.br/pages/viewpage.action?pageId=4097897 Página: Manual <Produto> / <Página>

Lembrando que deve criar a pendência de manual/documentação conforme for executando.

Fluxo da Pendência do Tipo Manual/Documentação

Iniciar Execução

Para iniciar a elaboração da página em questão, acessa a pendência de manual/documentação e faça a transição Iniciar execução.

Ao concluir a elaboração da pendência faça a transição Revisão técnica.

Revisão Técnica

A fase de Revisão Técnica é de responsabilidade dos Inspetores de Qualidade e o revisor não terá participação ativa, apenas será consultado quando necessário.

Ao finalizar a Revisão Técnica o Aprovado ou Não aprovado.

Caso o revisor técnico aprove a documentação, siga para a etapa de Revisão de Padrões.
Caso o revisor técnico não aprove a documentação, siga os procedimentos abaixo:
Os documentos não aprovados serão reenviados ao redator na situação, o que indica que a documentação deverá ser refeita conforme comentário do técnico através da ferramenta Talk.
1. Na pendência faça a transição Iniciar execução.
2. Acesse a página revisada.
3. Realize as alterações conforme o Técnico de Qualidade deixou comentado no Talk:
  O comentário com talk é apresentado na linha onde foi inserido conforme imagem abaixo.
  Você também pode localizar comentários filtrando por pessoa e data para facilitar a localização das páginas com comentário, conforme esta documentação.
4. Ao concluir os ajustes realize a transição Revisão Técnica.
5. Delegue a demanda de volta para o Técnico de Qualidade.

Revisar Padrões

Ao ser aprovada a revisão técnica, a pendência ficará Sem responsável e irá para o Filtro: Revisar Padrões.
O filtro apresentará todas as pendências do fluxo que estão com ou sem delegações. A ideia é que todos os redatores monitorem; quem estiver disponível, delega a tarefa para si e revisa.

Fluxo de Revisão

Na revisão de padrões, o redator verifica se a documentação corresponde com os padrões de escrita e qualidade definidos no manual de padrões de qualidade de escrita técnica.

Caso a revisão de padrões seja aprovada, o revisor realiza a transição Aprovado - Nova documentação e a pendência é finalizada.
Caso a revisão de padrões não seja aprovada, a pendência volta para o redator realizar os ajustes e após concluir os ajustes mandar novamente para revisão.

Execução Paralisada

As demandas paralisadas permanecem nessa situação até que a execução seja reiniciada.

Aguardando Terceiros

As demandas que dependem de alguma informação de pessoas externas ao setor permanecerão no status Aguardando terceiros até que lhe retornem a informação.

Quando retornarem, siga com o fluxo normal da tarefa.

Aguardando Revisões

Quando concluir a elaboração da documentação de todas as pendências filhas (manual/documentação) e estiverem aguardando revisão técnica ou de padrões, na pendência pai (Nova documentação/manual) faça a transição Aguardando revisões e siga os próximos procedimentos.

Quando todas as tarefas filhas de manual/documentação forem finalizadas, faça a transição Revisão finalizada.

Publicar Manual

As pendências devem permanecer no status Publicar manual até que a versão seja liberada.

Quando for liberada a versão deve realizar a publicação do novo manual, para isso:

Faça a transição Iniciar publicação.
Publique o novo manual conforme o manual de publicação.
Após a publicação, envie um e-mail para a Gerência e Supervisão do Desenvolvimento, Suporte e UCA. Veja abaixo o padrão para envio:
Destinatários: Gerência e supervisão do Desenvolvimento, Suporte e UCA.
Assunto: Publicação do manual do <Nome do Sistema>
Corpo do e-mail:
Prezados(as),
Foi publicado o manual do <Nome do Sistema> no Centro de Aprendizagem.
Para acessá-lo utilize o link <Link para o manual> ou:
1. <passo a passo de como acessar o manual pelo menu>.
2. <passo a passo de como acessar o manual pelo menu>.
3. <passo a passo de como acessar o manual pelo menu>.
Qualquer dúvida, estaremos à disposição.
Atenciosamente,
Após enviar o e-mail, copie e cole o conteúdo do mesmo na tarefa da publicação para ficar registrado.
Faça a transição para Publicado.