* A definição dos tipos de usuários só é necessária na primeira execução dessa etapa.

A documentação do usuário deve levar em conta os diversos tipos de usuários. Exemplo:

• Usuários finais: Usam o software para auxiliá-los em alguma tarefa e não estão interessados em detalhes técnicos ou administrativos.
• Suporte (Service Desk): Responsáveis pela orientação do usuário. Necessário maior conhecimento técnico e de FAQs.

Deve-se, portanto, determinar primeiramente o tipo de usuário para produção de manual mais direcionado de acordo com seu perfil e necessidades.

Utilizar artefatos já definidos ao longo do projeto como fontes para a confecção do Manual do Usuário.

Entre os artefatos mais importantes a serem utilizados como fontes, podemos citar a Construção e os Caso de Uso, dentre outros.

Os manuais devem ser elaborados e disponibilizados na seção de "Manuais" na Wiki do TRT9.

Em caso de dúvidas sobre a utilização da Wiki, favor consultar as seguintes referências: TutorialWiki.pdf ou o Guia de Edição.

Exemplo: Manual desenvolvido para o sistema do Banco de Currículos de TIC (BCTIC).

* Importante: Além da elaboração do manual, deve ser também elaborado nessa etapa a documentação básica do projeto que ficará disponível na seção de "Sistemas" da Wiki. Tal documentação deve seguir o seguinte "Template de Documentação". Para um exemplo de sistema elaborado usando esse template, veja a documentação do sistema "PJE-Acompanhamento de Sessão".

A menos que o usuário faça parte de um contexto mais técnico, procure evitar uma linguagem altamente técnica, buscando dar lugar a explicações claras e simples.

O texto também deve ser organizado de forma a imitar o jeito que os usuários pensam; listar as características do produto agrupadas por função geralmente faz mais sentido do que simplesmente pelas características mais usadas. Às vezes, é inevitável usar termos técnicos, como para softwares de criação de gráficos que incluem tabelas Fibonacci, com mais gráficos de pizza e de barras. Nesses casos, é útil definir o termo no Glossário e explicar o contexto, como uma explicação do que é uma tabela Fibonacci e seu uso na análise financeira.

Na maioria dos casos, os procedimentos e os materiais de referência devem ter suas próprias seções, embora você pode falar para o usuário procurar o conteúdo específico em uma seção da outra. Dessa forma, o usuário pode encontrar as informações que ele procura mais rapidamente.

• Os procedimentos devem ser escritos em uma estrutura consistente na seção de instruções do manual. Comece com uma visão geral da atividade, depois descreva o que o usuário deve fazer e qual resultado ele deve ter.
• Materiais de referência podem incluir lista de opções, dicas de soluções de problemas e perguntas mais frequentes (FAQs), Glossário e índices podem ser adicionados também.

Imagens gráficas, como imagens da tela, podem ilustrar certos aspectos do manual melhor que um texto, particularmente em procedimentos complexos, com os quais os usuários precisam ter uma confirmação visual de que eles estão seguindo os passos corretamente. Imagens gráficas podem ser produzidas usando software de edição gráfica, câmeras digitais e softwares de edição fotográfica, ou no caso das imagens da tela, pode ser a habilidade de captura de tela do seu computador ou um programa de gráfico com capacidade de captura de tela.

Se você estiver usando múltiplas imagens gráficas nos procedimentos, coloque-as em um tamanho consistente, seja nas mesmas dimensões de comprimento e largura ou na mesma redução proporcional do tamanho original. Isso deixará as imagens mais atraentes ao usuário.

O Manual do Usuário deve ser revisado por algum outro membro da equipe do projeto para verificação de erros e possível melhoria do texto, exceto pelo responsável por sua confecção.

O Analista de Negócios, preferencialmente, é o responsável por realizar esta revisão, pois tem conhecimento das necessidades e regras de negócio envolvidas no desenvolvimento do sistema. Isso o torna capaz de revisar o manual, garantir que ele atenda aos requisitos solicitados e apontar possíveis correções.

Na ausência do Analista de Negócios ou na impossibilidade de envolvê-lo nesta tarefa, pode-se repassá-la para outro membro da equipe do projeto como: Gerente de Projeto, Analista de Sistemas, Analista de Testes ou Desenvolvedor de Software. De preferência, essa pessoa tem que ter participado da confecção do sistema e ter um conhecimento básico do seu funcionamento e regras de negócio envolvidas.

Caso seja a última iteração do projeto (Transição), fazer os preparativos necessários para a entrega do Manual do Usuário.