Ich eröffne diesen Beitrag im Anschluss an einen anderen meiner Beiträge, in dem mir nach einer Bemerkung über ein (für mich) Problem mit der Dokumentation von einer Frage erzählt wurde, die tranquil intern bezüglich der Screenshots in der Dokumentation (und der Schwierigkeit, diese auf dem neuesten Stand zu halten) stellt, und mir angeboten wurde, ihm meine Meinung dazu mitzuteilen.
Ich schreibe es deshalb hier hin, damit mein ursprünglicher Beitrag nicht überladen wird
und um weitere Meinungen einzuholen?Im schlimmsten Fall werde ich dadurch feststellen können, ob nur ich Probleme mit der aktuellen Dokumentation habe
WAPT ist auf jeden Fall ein großartiges Produkt (und Ihre Version von Samba AD auch)Was die Screenshots angeht, könnten Sie meiner Meinung nach einen Großteil davon problemlos entfernen.
Screenshots sind zwar sinnvoll, wenn sich die Dokumentation an ein nicht-fachkundiges Publikum richtet, aber angesichts Ihres Produkts dürften die meisten Ihrer Kunden IT-Administratoren sein, die es gewohnt sind, technische Dokumentationen mit wenigen Screenshots zu lesen. Da
dieses Produkt Microsoft-Tools ersetzen soll und die Installation unter Linux empfohlen wird, dürfte ein Großteil der Nutzer Linux-erfahren sein und unzählige Manpages studiert haben, die rein textbasiert sind.
Viele Screenshots in Ihrer Dokumentation illustrieren lediglich Selbstverständlichkeiten; die Texterklärung ist vollkommen klar, der Screenshot trägt nichts bei.
Beispielsweise ist in Abschnitt „1.4.3“ der Text „Gehen Sie in der WAPT-Konsole zu Tools ‣ Zertifikat erstellen“ völlig ausreichend.
können jedoch hilfreich sein, um bei vielen Optionen die Vorgehensweise zu veranschaulichen.
In Abschnitt „1.6.3. Erstellen“ ist beispielsweise der erste Screenshot meiner Meinung nach überflüssig, der zweite optional, der dritte nützlich und der vierte und fünfte ebenfalls überflüssig.
Ein paar Screenshots lockern den Text zwar auf, aber hier gibt es so viele davon, dass die Suche nach bestimmten Informationen in der Dokumentation mühsam wird. Man muss nämlich sehr weit scrollen, um den gewünschten Abschnitt zu finden. Besonders ärgerlich ist es (zumindest in meinem Fall), weil die vielen Bilder die Suche nach dem passenden Titel erschweren.
Bei einem Textanteil von 80–90 % kann man hingegen schnell scrollen und nur die fettgedruckten Überschriften überfliegen, wodurch die Suche deutlich erleichtert wird.
Erstaunlich ist der eklatante Unterschied zwischen der WAPT-Dokumentation und der von Ihnen angebotenen Samba AD-Dokumentation, die klar, präzise und benutzerfreundlich ist.
Eine der besten Dokumentationen, die ich je gelesen habe (und die ich häufig nutze), ist die für WatchGuard-Firewalls. Die schiere Anzahl an Optionen und Erklärungen ist beeindruckend, und dennoch ist es gelungen, alles relativ übersichtlich zu gestalten.
https://www.watchguard.com/help/docs/he ... front.html
Da ich vor einigen Jahren selbst technische Dokumentation schreiben musste (und für den ersten Entwurf ordentlich Kritik einstecken musste
Und das gilt umso mehr, da Ihr Produkt bereits einige Jahre alt ist und die Dokumentation im Laufe der Zeit sicherlich gewachsen ist.
Eine Idee (vielleicht unrealistisch, aber möglich
), leistungsstark und sehr nützlich, vielen Dank!