Mit Confluence Troubleshooting-Artikel schreiben wie ein Profi

Hilfe zur Selbsthilfe ist der effizienteste Weg, um jemandem zu helfen – und gute Troubleshooting-Artikel bieten genau das. Troubleshooting-Artikel sind eine gute Methode, um Probleme zu dokumentieren und bieten sofortige Hilfe bei der Lösung von häufig auftretenden und einfach zu lösenden Problemen, wodurch Sie Zeit und Mühe sparen, und sich auf wichtigere Dinge konzentrieren können.

Das Credo: Sparen Sie Zeit und vermeiden Sie Wiederholungen

Wenn Sie zum ersten Mal einen Troubleshooting-Artikel erstellen, erstellt Confluence automatisch eine Indexseite in Ihrer Space-Seitenleiste, damit Sie alle Troubleshooting-Artikel innerhalb eines Space an einem Ort finden können – dort können Sie sie nach Titel, Ersteller, oder Bearbeitungsdatum sortieren.

Um das Template für Troubleshooting-Artikel zu verwenden, klicken Sie auf den Aus Vorlage erstellen-Button im Header und wählen Sie dann Troubleshooting-Artikel aus.

Die meisten Nutzer werden Ihren Troubleshooting-Artikel durch eine Suchanfrage finden, am besten benennen Sie den Artikel also nach dem Namen des Problems, das Sie lösen möchten, damit die relevante Zielgruppe den Artikel leichter finden kann. Verwenden Sie dazu Begriffe, nach denen die Nutzer voraussichtlich suchen werden.

Wenn beispielsweise das zu lösende Problem ist, dass sich die Berechtigungen für eine Seite nicht ändern lassen, dann könnten Sie den Troubleshooting-Artikel Berechtigungen/Einschränkungen für Confluence-Seite lassen sich nicht ändern nennen.

Fügen Sie Labels zu Ihrem Artikel hinzu, damit sie sich leichter finden und organisieren lassen. Nutzer können nach Labels suchen, oder ein Inhalt nach Label-Makro verwenden, um eine Liste aller Inhalte zu generieren, die mit einem bestimmten Label gekennzeichnet sind.

Die Troubleshooting-Vorlage fügt automatisch ein „kb-troubleshooting-article“-Label zu Ihrem Dokument hinzu, aber Sie können Ihren Artikel auch Labels für die behandelten Themen oder die Kategorien, in die der Artikel fällt, hinzufügen. Sie können beliebig viele Labels hinzufügen und auch die Labelkombinationen nach denen Sie suchen können, haben keine Begrenzung.

2. Beschreiben Sie das Problem und die Symptome

Beschreiben Sie das Problem so, wie es der Nutzer erleben würde und seien Sie dabei so klar und eindeutig wie möglich. Selbst wenn Sie glauben, dass Ihr Titel selbsterklärend ist, Ihre Leser könnten sich trotzdem nicht sicher sein, ob es sich um das richtige Problem handelt, wenn Sie ihnen nicht mehr Details zur Verfügung stellen.

Im Falle unseres Beispiels könnten Sie beispielsweise folgendes schreiben: „Wenn ich mich auf einer Confluence-Seite befinde und auf das Einschränkungen-Vorhängeschlosssymbol klicke, sind die Namen im Dialogfeld ausgegraut und ich kann keine Berechtigungen hinzufügen oder ändern.“

3. Mögliche Ursachen und Lösungen

Verwenden Sie in diesem Fall ein Inhaltsverzeichnis-Makro, um Ihren Lesern die Navigation durch die Informationen zu erleichtern

• Sie sollten diesen Abschnitt möglichst simpel halten. Verwenden Sie falls möglich Unterüberschriften und Gliederungspunkte.
• Unterteilen Sie jeden Schritt in seine einzelnen Komponenten. Anstatt „Überprüfen Sie, wer der Space-Admin ist“ zu schreiben, sagen Sie stattdessen lieber: „Klicken Sie auf Spaces > Spaceverzeichnis im Confluence-Header und klicken Sie dann auf das Space Details-Icon neben einem Space. Der Space-Admin wird dort angezeigt.“
• Vermeiden Sie die Verwendung von Fachjargon. Falls das unvermeidbar ist, können Sie versuchen die Begriffe durch ein Panel-Makro oder ein Info-Makro zu definieren, oder Links zu anderen Seiten mit mehr Informationen zu den Begriffen hinzufügen.
• Verwenden Sie Screenshots, Diagramme und Grafiken – das macht das Lesen Ihres Artikels einfacher und einige Schritte lassen sich so besser veranschaulichen.

4. Verwandte Inhalte

Machen Sie Ihren Artikel noch hilfreicher, indem Sie am Schluss einige verwandte Inhalte hinzufügen.

• Ähnliche oder verwandte Probleme – Helfen Sie Ihren Nutzern dabei, ähnliche oder verwandte Probleme zu finden, indem Sie auf das Inhalt nach Label-Makro unten auf Ihrer Seite klicken und die passenden Themenlabels auswählen.
• Tipps und Tricks – Haben Sie irgendwelche Ideen, wie sich das Problem in Zukunft vermeiden lässt? Teilen Sie ein paar Tipps und Tricks mit Ihren Nutzern, indem Sie ein Tipp-Makro verwenden.
• Falls Sie irgendwelche JIRA-Anwendungen verwenden – Fügen Sie ein JIRA Issues-Makro zu Ihrem Troubleshooting-Artikel hinzu, um einen schnellen Zugriff auf bekannte Probleme zu ermöglichen. Das hat den Vorteil, dass ein automatisches

* Wenn Sie Questions for Confluence verwenden – fügen Sie ein Fragenliste-Makro zu Ihrem Troubleshooting-Artikel hinzu, um die häufigsten Fragen mit demselben Thema hervorzuheben. Fügen Sie außerdem einen Eine Frage stellen-Button zur Homepage der Wissensdatenbank hinzu.

Sie können auswählen, welche Informationen miteinbezogen werden sollen, und können beliebige Felder zu diesem Makro hinzufügen. Das ist besonders nützlich, wenn Sie beispielsweise eine Seite für alle Troubleshooting-Artikel Ihrer Organisation erstellen möchten.

Wenn Sie den Artikel veröffentlicht, und mit dem Rest Ihres Teams geteilt haben, können Nutzer Inline-Kommentare verwenden, falls sie zusätzliche Klarstellungen oder Hilfe mit den von Ihnen geteilten Informationen benötigen.

Wenn Sie sich um einen Inline-Kommentar gekümmert haben, klicken Sie auf Lösen und er verschwindet von der Seite.
Die gelösten Kommentare lassen sich jederzeit im Aktionsmenü wiederfinden, damit Sie nachvollziehen können, womit Ihre Leser zusätzliche Hilfe benötigen.

Bonus: Passen Sie die Troubleshooting-Vorlage an den Workflow Ihres Teams an

Sie können die Troubleshooting-Vorlage jederzeit bearbeiten und an die Anforderungen Ihres Teams anpassen. Wenn Sie die Vorlage an Ihr Team oder Projekt anpassen wollen, gehen Sie ins Space Tools-Menü und wählen Sie dort Inhaltstools aus. Unter der Option Vorlagen können Sie sich die beinhalteten Vorlagen ansehen und bearbeiten. Wenn Sie ein Seitenadmin sind, können Sie außerdem die Globale Vorlage bearbeiten, um diese firmenweit anzupassen.

Zusammenfassung

• Troubleshooting-Artikel-Vorlage: Sie erledigt den Großteil der Arbeit für Sie. Folgen Sie der Gliederung der Seite und fügen Sie sinnvolle Inhalte ein.
• Troubleshooting-Artikel-Index: Sobald Sie einige Troubleshooting-Seiten erstellt haben, können Sie auf einen Blick alle High-Level-Details auf der Indexseite sehen, die bei der Verwendung eines Templates automatisch von Confluence erstellt wird.
• Seiteneigenschaften-Makro: Dieses Makro ermöglich es Ihnen, eine Berichtsseite für alle Ihre Troubleshooting-Artikel zu erstellen. Wenn Sie die Vorlage verwenden, ist es automatisch Teil Ihrer Seite.
• Inhalt nach Label-Makro: Dieses Makro wird verwendet, um Listen von Seiten, Blogbeiträgen oder Anhängen mit bestimmten Labels darzustellen.
• Inhaltsverzeichnis-Makro: Erstellt ein Inhaltsverzeichnis basierend auf den Überschriften der Seite.
• Info, Tipp, Notiz und Warnung-Makro: Ermöglicht es Ihnen, wichtige Informationen hervorzuheben.
• JIRA Issues-Makro: Ermöglicht das Erstellen und Anzeigen von sich dynamisch aktualisierenden JIRA Issues auf Ihrer Confluence-Seite
• Vorlagen anpassen: Sie können alle mitgelieferten Vorlagen an Ihren eigenen Worklfow anpassen.

Wir helfen gerne auf Ihrem weiteren Weg mit Confluence, kontaktieren Sie uns dafür einfach.