Artefato: Material de Suporte do Usuário

Descrição Principal

O material de suporte do usuário final é geralmente exigido de qualquer sistema que tenha uma interface com a qual os usuários interagem; os sistemas que são principalmente incorporados e com pouca ou nenhuma interface com o usuário podem omitir esse produto de trabalho, embora ele possa ser aplicável e útil mesmo onde a necessidade da API precisa estar documentada.

Esse produto de trabalho geralmente inclui um ou mais dos documentos e Produtos de Trabalho a seguir:

Guias do Usuário
Guias Operacionais
Guias de Manutenção
Demonstrações on-line
Sistema de ajuda on-line
Ajuda contextual
Notas sobre o release

Informações Adicionais

A documentação do usuário oferece instruções sobre o uso do software. Forneça documentação para todos os tipos de usuários.

Utilize os casos de uso como a base para o guia do usuário.

O manual do usuário pode ser escrito por escritores técnicos, com a colaboração de desenvolvedores, ou pode ser escrito pela equipe de teste, cujos membros provavelmente compreendem a perspectiva do usuário.

Um motivo para atribuir a criação do manual do usuário à equipe de teste é que ele pode ser gerado paralelamente ao desenvolvimento do software e pode ser criado antecipadamente como uma perspectiva tangível e relevante dos critérios de avaliação. Os erros e as soluções insatisfatórias da interface do usuário e do modelo de casos de uso podem ser especificados e corrigidos durante as iterações iniciais do projeto, quando as mudanças são mais baratas.

Escrevendo o manual do usuário, os testadores conhecerão bem o sistema antes de começar qualquer teste completo. Além do mais, essa tarefa fornece uma base para planos e casos de teste e para a construção de conjuntos de testes automatizados.

O tipo de sistema é que determinará em que ponto da fase inicial do ciclo de desenvolvimento o manual do usuário deve começar a ser produzido. Sistemas com interfaces complexas ou com uma grande interação de usuário exigirão tanto versões iniciais do manual do usuário como protótipos iniciais da interface. Os sistemas incorporados com pouca interface humana provavelmente não exigirão um início adiantado da documentação do usuário.