Verwenden von People vs Benutzern in Online -Dokumentation und Richtlinien

1. Warum es wichtig ist, dokumentation zu erstellen, die benutzerfreundlich ist?
2. Was sind die Unterschiede zwischen Benutzerdokumentation und Systemdokumentation, was ist ihre Nützlichkeit??
3. Was sollte in der Benutzerdokumentation enthalten sein?

Warum es wichtig ist, dokumentation zu erstellen, die benutzerfreundlich ist?

Benutzerfreundliche Sprache und Inhalte im Dokument tragen zur Fähigkeit des Benutzers bei, die dargestellten Informationen zu verstehen und diese Informationen wie beabsichtigt anzuwenden.

Was sind die Unterschiede zwischen Benutzerdokumentation und Systemdokumentation, was ist ihre Nützlichkeit??

Systemdokumentation repräsentiert Dokumente, die das System selbst und seine Teile beschreiben. Es enthält Anforderungsdokumente, Entwurfsentscheidungen, Architekturbeschreibungen, Programmquellcode und FAQs. Benutzerdokumentation deckt Handbücher ab, die hauptsächlich für Endbenutzer der Produkt- und Systemadministratoren vorbereitet sind.

Was sollte in der Benutzerdokumentation enthalten sein?

Großartige Benutzerdokumentation sollte: Klarte Sprache, Einfachheit, Visuals, Fokus auf das Problem, eine logische Hierarchie und einen Fluss, ein Inhaltsverzeichnis, durchsuchbare Inhalte, zugängliche Inhalte, gutes Design, Feedback von echten Benutzern und Links zu weiteren Ressourcen.