FluidDocs CLI: Der Entwurf stimmt, doch welche Version sehen die Leser?
Zwei Prüfnachweise zu einer fiktiven Ausleihanleitung unterscheiden die gespeicherte Entwurfsänderung, die Lesefassung und die in Antworten zitierte Textstelle.
FluidDocs CLI kommt infrage, wenn ein Team ein interaktives Dokument pflegt, das regelmäßig genutzt und aktualisiert wird, und interne Überarbeitungen von öffentlichen Versionen trennen muss. Die Kommandozeilendokumentation von FluidDocs beschreibt das Bearbeiten eines Entwurfs und das Veröffentlichen getrennt. Laut Produktvorstellung können Leser Fragen zum Dokumentinhalt stellen. Der neue Wortlaut in der internen Ansicht beweist daher nicht, dass er in der vorgesehenen Lesefassung sichtbar ist oder sich dort als Antwort abrufen lässt.
Nicht aus Sicht des Autors für die Leser abnehmen
Das Beispiel ist eine unkritische Anleitung zum Ausleihen von Bürogeräten. Früher stand dort, dass das Projektor-Adapterkabel in Schrank A liegt; der intern bestätigte neue Entwurf nennt Schrank B. Die Person, die das Dokument übernimmt, bekommt zwei fiktive Nachweise: die Bestätigung „Entwurf gespeichert“ des Autors und den tatsächlich angezeigten Text. Steht dort noch Schrank A, ist nur der Entwurf fertig. Die Person darf Kollegen nicht allein aufgrund des internen Änderungsvermerks zu Schrank B schicken. Steht im Text Schrank B, während die Dokumentantwort weiterhin A nennt, werden die Ergebnisse getrennt erfasst. Ein richtiges Ergebnis reicht nicht für beide.
Eine Prüfliste kann aus drei Zeilen bestehen: die vereinbarte wirksame Version, der für Leser sichtbare Satz und bei aktivierter Fragefunktion der Textbeleg für die Antwort. Solange die Leseransicht nicht geprüft ist, bleibt der Punkt offen. Weder der Zeitstempel eines Screenshots noch der interne Entwurfsstatus sagt, was auf der externen Seite steht. Das ist eine statische Übergabeübung; es wurden weder Befehle ausgeführt noch Seiten erstellt oder Leserdaten erhoben.
Bei häufigen Änderungen und echten Rückfragen zu Details lohnt es sich, Entwurf und Veröffentlichung getrennt zu dokumentieren. Für eine einmalige Mitteilung oder wenn die Leseransicht nicht nach jeder Änderung geprüft werden kann, ist zunächst ein statisches Dokument mit eindeutiger Versionsangabe zu erwägen.
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:fluiddocs.ai