Utilisation des personnes vs utilisateurs dans la documentation en ligne et les directives

1. Pourquoi il est important de produire une documentation conviviale?
2. Quelles sont les différences entre la documentation utilisateur et la documentation système quelle est leur utilité?
3. Ce qui devrait être inclus dans la documentation utilisateur?

Pourquoi il est important de produire une documentation conviviale?

Le langage et le contenu conviviaux du document contribuent à la capacité de l'utilisateur à comprendre les informations présentées et à appliquer ces informations comme prévu.

Quelles sont les différences entre la documentation utilisateur et la documentation système quelle est leur utilité?

La documentation du système représente des documents qui décrivent le système lui-même et ses parties. Il comprend des documents d'exigences, des décisions de conception, des descriptions d'architecture, un code source de programme et une FAQ. La documentation utilisateur couvre les manuels qui sont principalement préparés pour les utilisateurs finaux des administrateurs du produit et du système.

Ce qui devrait être inclus dans la documentation utilisateur?

Une excellente documentation utilisateur doit inclure: un langage clair, une simplicité, des visuels, un accent sur le problème, une hiérarchie logique et un flux, une table des matières, un contenu consultable, un contenu accessible, une bonne conception, des commentaires des utilisateurs réels et des liens vers des ressources supplémentaires.