Gauge Agents: Die Dokumentationsseite stimmt. Gilt das Beispiel auch für diese Version?
Trennen Sie in eigener Dokumentation das Auffinden der Seite von der passenden Version. Legen Sie ohne Agenten- oder Programmtests fest, was als Fehllektüre gilt.
Gauge Agents trennt in seiner Dokumentation zur Bewertung das Auffinden der Dokumentation, die Wahl des richtigen Beispiels und die Gültigkeit des Ergebnisses. Eine Fallstudie des Anbieters erwähnt auch den Einzelvergleich von Dokumentationsänderungen. Bei der Auswahl einer Prüfungsmethode lassen sich diese Dinge getrennt betrachten. Das Werkzeug findet dadurch nicht garantiert das Richtige, und die Markenanalyse auf derselben Website gehört nicht dazu. Der Artikel prüft statisches redaktionelles Material, ohne Agenten auszuführen oder Onlinesysteme zu testen.
Zuerst die zwei Versionen auf der Seite prüfen
Stellen Sie sich eine selbst geschriebene Anleitung für ein fiktives Layout-Vorschauwerkzeug vor. Der Titel sagt „Neue Version“, aber das kurze obere Beispiel stammt von der alten Fassung und zeigt nur die Zeilenzahl. Das neue Beispiel weiter unten nennt Zeilen- und Absatzanzahl. Die lesende Person will die Absatzanzahl prüfen. Auf Papier steht in A „Seite der neuen Version gefunden“ und in B „Beispiel mit Absatzanzahl ausgewählt“. Nur B erfüllt dieses Dokumentationsziel. Fehlen Versionsangaben, fügen Sie unterscheidbare Markierungen hinzu, auch wenn beide Beispiele in ihrer jeweiligen Fassung stimmen. Es gibt weder Konfiguration noch Code, kein echtes Projekt und keine Ausführung.
Wenn Sie Dokumentation an mehreren Stellen pflegen und oft klären müssen, ob Leser die Seite verpasst oder das falsche Beispiel gewählt haben, ist die getrennte Betrachtung der Schritte einen Vergleich wert. Pflegt dieselbe Person beide Stellen und kann Überschriften und Beispiele direkt abgleichen, ist eine manuelle Prüfung der Seite häufig sinnvoller. Die richtige Seite zu finden bedeutet nicht, dass der Leser seine Aufgabe abschließen kann. Eine Anbieterfallstudie ist kein Test Ihrer eigenen Dokumentation.
Hinweis zum Inhalt:Dieser Artikel basiert auf öffentlich verfügbaren Informationen und dient als Orientierung bei der Auswahl von Tools. Funktionen, Preise und zugehörige Richtlinien können sich jederzeit ändern; maßgeblich sind die aktuellen offiziellen Angaben.
Originalquelle:www.withgauge.com