Wir arbeiten an einem Softwarehandbuch mit mehreren Kapiteln und Themen, die bisher meist in sich abgeschlossen sind. Das bedeutet, dass wir ein spezielles Kapitel für „Konnektivität“ haben und Konnektivität an anderer Stelle nicht erwähnen, ein spezielles Kapitel für „Software-Upgrades“ und Upgrades an anderer Stelle nicht erwähnen usw. Sie verstehen schon.
Aber wir haben jetzt eine neue Softwarefunktionalität, die verschiedene Themen im Handbuch betrifft (z. B. die Themen A, C und G). Jedes dieser Themen ist in sich abgeschlossen und von den anderen isoliert, aber auf unterschiedliche Weise von dieser neuen Funktionalität betroffen.
Die Frage ist, was wäre der beste Ansatz, um sich über diese neue Funktionalität zu informieren?:
Wir sehen in beidem Vor- und Nachteile. In ( 1 ) haben wir alles an einem Ort, was die Sache auf Dauer einfacher macht, aber H wäre ein Thema von disparaten Dingen. In ( 2 ) stellen wir die Informationen im Thema selbst bereit, wo sie am dringendsten benötigt werden, aber dies ist langfristig schwierig aufrechtzuerhalten.
Danke, Jörg
Es hängt davon ab, aber wahrscheinlich möchten Sie den verteilten Ansatz, bei dem das Kapitel über X Ihnen alles erzählt, was Sie über X wissen müssen, auch wenn einiges davon nur relevant ist, wenn Sie Feature Y verwenden. Wenn Y jedoch ein Eckfall ist oder eine Menge Änderungen an mehreren anderen Funktionen beinhaltet, ist es vielleicht besser, alles über Y an einem Ort zu sammeln und von jedem anderen Kapitel, das es berührt, darauf zu verlinken . Stellen Sie es jedoch nicht einfach in ein eigenes Kapitel und sagen Sie nichts in den anderen; Das kann zu Überraschungen führen, wenn Benutzer, die direkt zu X gesprungen sind, später feststellen, dass sie X' hätten tun sollen, weil sie Y verwenden.
Darüber hinaus besteht ein Ansatz, den mein Team verwendet, darin, einen Abschnitt des Dokumentsatzes (ein HTML-Bundle aller einzelnen Dokumente) zu haben, der neue Funktionen in dieser Version beschreibt. Jede neue Funktion erhält eine allgemeine Beschreibung dessen, was es ist und wann Sie es verwenden können, und endet mit Links zu den relevanten Stellen in den "Haupt"-Dokumenten. Personen, die sich für "neues Feature Y" interessieren, können dort leicht auf die Informationen zugreifen (über Links), aber der Hauptinhalt befindet sich in den anderen Dokumenten.
Wie lesen und verwenden Ihre Benutzer das Handbuch?
Wenn sie es als Lehrbuch verwenden , wo 95 % der Leser am Anfang beginnen und sich linear bis zum Ende durcharbeiten, dann packen Sie alle neuen Informationen am Ende in ein Kapitel.
Wenn sie es als Nachschlagewerk verwenden , also Kapitel in der falschen Reihenfolge gelesen werden, einzeln oder nicht einmal vollständig, weil die Person ein Feature nachschlägt, dann brauchen Sie die disparate Methode.
Um das Beispiel von SaberWriter zu verwenden, wenn ich nur nachschlagen muss, wie man Menüs in HTML erstellt, wäre es nützlich, zumindest eine Notiz zu haben, die besagt, dass ich dasselbe mit CSS oder noch einfacher mit JavaScript machen könnte. eine kurze Zusammenfassung des Prozesses und dann ein Verweis auf eine längere Erklärung in den CSS- und JavaScript-Kapiteln.
Ich denke, du hast deine Antwort wirklich schon. Erklären Sie jedes Thema in seinem eigenen Kapitel so, wie Sie es haben, und erstellen Sie dann ein neues Kapitel, das diese zusätzliche Funktion erklärt, die das Verhalten dieser anderen Elemente ändert.
Verwenden Sie Erklärungsebenen Schaffen Sie Ebenen des Verständnisses
Wenn Sie es auf diese Weise aufbrechen und die grundlegenden Punkte erklären, die Ihr Leser zuerst verstehen soll, werden Verständnisschichten geschaffen, die spätere Materialien leichter verständlich machen.
Nehmen wir als Beispiel HTML, CSS und JavaScript.
Kapitel 1: Was ist HTML?
HTML steht für HyperText Markup Language... ...
HTML ist die Struktur Ihres Dokuments. Es ermöglicht uns, die Struktur des DOM (Document Object Model) zu erstellen. Das Tag ist ein HTML-Element vom Blocktyp. ...
Kapitel 2: Was ist CSS?
CSS ist ein Akronym und bedeutet Cascading Style Sheets ... ...
Um alle <DIV>-Tags mit einem class="book" <DIV> class="book") zu stylen, können wir etwa Folgendes tun:
#book {color:red; padding: 2px 2px 2px 2px;}Kapitel 3: Was ist JavaScript
JavaScript kann verwendet werden, um das DOM - die Struktur des HTML - zu manipulieren:
<div id='extra'>test</div> document.getElementById("extra").appendChild(node);JavaScript kann auch verwendet werden, um den Stil bestimmter DOM-Elemente zu ändern.
document.getElementById("p2").style.color = "blue";
Fundament ist solide
Wenn Ihre Leser zu JavaScript kommen (fortgeschritteneres Thema, das das Verständnis der vorherigen Informationen erfordert), werden sie in der Lage sein, diese neue Ebene des Verständnisses hinzuzufügen, weil Sie eine Grundlage für sie geschaffen haben.
Ich hoffe das hilft. Viel Glück mit Ihrem Projekt.
Benutzer9995
Monika Cellio