<aside> 💬
Contexto: O treinamento com a Cláudia correu bem. Ela aprendeu a cadastrar sócios e fazer buscas. Mas ela vai tirar férias daqui a duas semanas e a substituta nunca viu o sistema. Você não vai estar lá para treinar pessoalmente. O que você deixa para que ela consiga trabalhar sozinha?
Um manual do usuário bem feito vale um treinamento inteiro.
</aside>
Manual do usuário é um documento escrito que explica como usar um sistema, passo a passo, de forma que qualquer pessoa do público-alvo consiga seguir sem ajuda externa.
A palavra-chave é público-alvo. Um manual para um desenvolvedor é completamente diferente de um manual para a secretária de um clube de futebol. O conteúdo pode ser o mesmo sistema — a linguagem, o nível de detalhe e os exemplos são completamente diferentes.
É importante não confundir os dois:
| Manual do usuário | Documentação técnica | |
|---|---|---|
| Público | Usuário final (Cláudia, Rafael) | Técnico, desenvolvedor |
| Linguagem | Simples, sem jargão | Técnica, precisa |
| Conteúdo | Como usar as funcionalidades | Como o sistema foi instalado e configurado |
| Tom | Instrucional, acolhedor | Formal, descritivo |
| Exemplo | "Clique no botão verde Salvar" | "POST /socios retorna 201 com o objeto criado" |
Nos módulos VIII e IX vamos trabalhar a documentação técnica. Aqui o foco é o manual para quem vai usar o sistema no dia a dia.
Um manual do usuário bem estruturado tem sempre as mesmas seções fundamentais:
Uma ou duas frases explicando o que é o sistema e para que serve. O usuário precisa entender o propósito antes de qualquer instrução.
Exemplo:
Este manual explica como usar o Sistema de Gestão de Sócios da Chapecoense. O sistema permite cadastrar e consultar sócios, registrar mensalidades e controlar pagamentos.