Navigation im Handbuch
Wie man das Verzeichnis benutzt
Wie man das Produktverzeichnis verwendet: Route nach Aufgabe, Querverweise, Vorlagen und Regeln für die Verwendung von Frameworks.
Es ist besser, aus der Arbeitssituation zu lesen, nicht von der ersten Seite bis zur letzten. Die Entscheidung zu treffen, das Profilmaterial auszuwählen, ein Werkzeug anzuwenden und zum resultierenden Artikel zurückzukehren, und dann wird die Theorie Teil Ihres eigenen Workflows.
Warum brauchen Sie ein Handbuch?
Für wen ist dieser Abschnitt?
Das Verzeichnis ist Ihr Werkzeug für schnelle Antworten auf spezifische Fragen, der Start-Bereich ist für neue Benutzer oder neue Benutzer, und es ist keine detaillierte Dokumentation, es ist eine Sammlung der wichtigsten Informationen: wo zu suchen, wie man nicht in komplexen Begriffen ertrinken und wohin als nächstes gehen.
Wann das Verzeichnis zu öffnen ist
Wenn Sie sich nicht sicher sind, was die Begriffe sind, wenn Sie sich an das Hauptszenario erinnern möchten oder wenn Sie nach einem Ausgangspunkt suchen, ist dies Ihr erster Schritt, z. B. wenn Sie ein Produkt zum ersten Mal auf den Markt bringen oder wenn Sie auf unbekannte Schnittstellen stoßen.
Wie man im Verzeichnis navigiert
Struktur und Suche
Es gibt normalerweise ein paar logische Abschnitte im Verzeichnis. Der Start-Bereich ist die Haupteingabe. Hier finden Sie schnell Schlüsselfunktionen, Antworten auf häufige Fragen, eine Liste von Begriffen und Links zu detaillierten Anweisungen. Eine korrekte Struktur spart Zeit: Sie müssen nicht durch chaotische Notizen gehen, die gesamte Wissensbasis wird gesammelt und durch einfache Kategorien zugänglich gemacht.
Beispiel: Wenn Sie ein Produkt zum ersten Mal starten, müssen Sie nur den Startabschnitt öffnen, um zu verstehen, wo die Suche ist, wie Sie eine neue Aufgabe erstellen und was die Symbole in der Symbolleiste bedeuten.
Keyword-Suche
Fast jedes Verzeichnis hat eine Suchleiste, und wenn Sie ein Keyword eingeben, gehen Sie schnell zu dem gewünschten Artikel oder der gewünschten Definition, und dies ist besonders wichtig, wenn der Abschnitt groß ist, müssen Sie nicht Hunderte von Elementen manuell durchgehen.
Erste Schritte: Wie man mit der Verwendung beginnt
Was von Anfang an zu tun ist
- Nehmen Sie eine kurze Begrüßung oder Onboarding (oft eingebaut).
- Öffnen Sie den Start-Bereich – hier sind die wichtigsten Links, Schaltflächen und kurze Anweisungen.
- Lernen Sie den Begriff Block – erfahren Sie, was neue Wörter und Produktabkürzungen bedeuten.
- Versuchen Sie, die grundlegenden Schritte der Schritt-für-Schritt-Anweisungen in diesem Abschnitt zu befolgen.
Beispiel: Ein neuer Benutzer öffnet ein Produkt für Teamarbeit. Im Start-Verzeichnis sieht er Anweisungen zum Hinzufügen eines Befehls, zum Erstellen einer ersten Aufgabe, wo Benachrichtigungen aktiviert werden können.
Typische Anfängerfehler
Viele Menschen versuchen, in die komplexen feineren Einstellungen einzutauchen oder die allgemeine Dokumentation zu lesen, und sie verlieren schnell den Faden oder verschwenden ihre Zeit, und der beste Weg ist, den Startabschnitt zu durchlaufen und dann zu anderen Abschnitten zu wechseln.
Anti-Patterns: Wie man das Verzeichnis nicht benutzt
Ignorieren Sie den Start-Abschnitt
Das Überspringen des Startabschnitts führt oft zu Verwirrung, und einige Leute denken, dass sie es ohne eine Baseline tun können, was die Zeit, die benötigten Informationen zu finden, dramatisch erhöht.
Beispiel: Der Benutzer sucht nach Möglichkeiten, Daten zu exportieren, anstatt zu Beginn eine kurze Anweisung zu öffnen, und versucht, dies über Dienste von Drittanbietern zu tun, verschwendet viel Zeit.
Verwenden Sie das Verzeichnis als Mülleimer
Zu viele unstrukturierte Informationen werden oft hinzugefügt, und das Wichtigste ist, das Verzeichnis nicht mit zusätzlichen Details zu verstopfen, die für die ersten Schritte nicht relevant sind.
Wo finden Sie weitere Informationen
Tiefer in den Abschnitten und externe Suche
Wenn im Abschnitt Start keine Details fehlen, gehen Sie zu anderen Verzeichniskategorien und Sie haben bereits Handbücher, Spezifikationen und Beispiele.
Parallel dazu können Sie häufig gestellte Fragen und Produktforen überprüfen – dies hilft, Lösungen für atypische Probleme zu finden.
Referenzen zu Best Practices:
- Atlassian: Wie man klare Führer erstellt
- Habr Q & A: Ein Leitfaden für Neulinge zur Navigation
- Intercom: Wie man eine effektive Wissensbasis aufbaut (https://www.intercom.com/blog/how-to-build-a-knowledge-base/)
FAQ
Warum brauche ich einen Start-Bereich im Verzeichnis?
Um schnell die notwendigsten Anweisungen und Definitionen zu finden, ohne die gesamte Dokumentation zu lesen.
Was tun, wenn Sie nicht die richtige Antwort finden?
Verwenden Sie die eingebaute Suche oder gehen Sie zu anderen Abschnitten des Verzeichnisses. Es gibt oft Foren zur Klärung.
Kann ich den Startabschnitt überspringen?
Es wird empfohlen, immer damit zu beginnen - es spart Zeit und hilft, nicht verwirrt zu werden.
Wie unterscheidet sich ein Buch von einer vollständigen Dokumentation?
Ein Verzeichnis besteht aus kurzen Antworten und schnellen Links. Dokumentation besteht aus detaillierten Anweisungen für fortgeschrittene Benutzer.
Wie kann man sich nicht in einem großen Verzeichnis verlieren?
Suchen Sie und halten Sie sich an die Partitionslogik.
Was ist, wenn es zu viele Begriffe gibt und nichts klar ist?
Der Startabschnitt hat normalerweise ein Glossar – schauen Sie dort, bevor Sie die großen Texte lesen.