Was macht eine gute Produktdokumentation aus?
Zu diesem Zweck sollte Ihre Dokumentation immer sein: Einfach: Verwenden Sie die Sprache, die ein durchschnittlicher Benutzer verstehen kann - und vermeiden Sie die Verwendung unnötiger Jargon und komplexer Sprache. Speziell: Konzentrieren Sie sich auf ein bestimmtes Thema oder Problem mit jedem von Ihnen erstellten Dokument.
Was die Produktdokumentation umfasst?
Produktdokumentation beschreibt das Produkt, das entwickelt wird, und gibt Anweisungen zur Ausführung verschiedener Aufgaben damit. Im Allgemeinen umfasst die Produktdokumentation Anforderungen, technische Spezifikationen, Geschäftslogik und Handbücher.