- Por que é importante produzir documentação que seja amigável?
- Quais são as diferenças entre a documentação do usuário e a documentação do sistema qual é a utilidade deles?
- O que deve ser incluído na documentação do usuário?
Por que é importante produzir documentação que seja amigável?
Linguagem e conteúdo amigáveis no documento contribuem para a capacidade do usuário de entender as informações apresentadas e aplicar essas informações conforme o pretendido.
Quais são as diferenças entre a documentação do usuário e a documentação do sistema qual é a utilidade deles?
A documentação do sistema representa documentos que descrevem o próprio sistema e suas partes. Inclui documentos de requisitos, decisões de design, descrições de arquitetura, código -fonte do programa e perguntas frequentes. A documentação do usuário abrange manuais preparados principalmente para usuários finais dos administradores de produtos e sistemas.
O que deve ser incluído na documentação do usuário?
A ótima documentação do usuário deve incluir: linguagem simples, simplicidade, visuais, foco no problema, hierarquia e fluxo lógicos, índice, conteúdo pesquisável, conteúdo acessível, bom design, feedback de usuários reais e links para outros recursos.