Kategorien

Vorlage: Artikel zur Fehlerbehebung

von Atlassian

Verbreitete Probleme und ihre Lösungen dokumentieren

Vorlage verwenden
Vorlage: Artikel zur Fehlerbehebung

Hilf Kunden, häufige Probleme zu bearbeiten und selbst Lösungen zu finden, indem du Artikel zur Fehlerbehebung erstellst. Unsere Artikelvorlage zur Fehlerbehebung gibt dir die Struktur, die du brauchst, um das Problem zu formulieren, die Lösung im Detail zu beschreiben und verwandte Artikel anzuzeigen (was du automatisch mithilfe von Labels und dem Inhalt-nach-Label-Makro tun kannst, um den Überblick über verwandte Artikel zu behalten). Bringe ihnen bei, wie man Probleme selbst lösen kann, und gib deinem Support-Team dadurch mehr Zeit zur Bewältigung komplexerer Aufgaben.

So verwendest du die Vorlage Artikel zur Fehlerbehebung

Schritt 1: Beschreibe das Problem

Es ist verlockend, bei einem Artikel wie diesem direkt in die Lösung einzusteigen. Die Beschreibung des Problems ist allerdings ein wirklich wichtiger Teil der Erstellung effektiver Inhalte. Die Leser müssen in der Lage sein zu erkennen, ob sich dein Artikel auf die Probleme bezieht, mit denen sie zu tun haben. Denke darüber nach, wie deine Leserschaft dieses Problem erlebt, und erkläre das Problem anhand von Begriffen und Beispielen, die für diese Erfahrungen relevant sind.

Schritt 2: Verfasse eine detaillierte Anleitung zur Problembehebung

Sobald du das Problem beschrieben hast, ist es an der Zeit zu erklären, wie es behoben werden kann. Erstelle anhand einer nummerierten Liste eine Schritt-für-Schritt-Lösung. Verwende Begriffe, welche die Leser kennen und verstehen, und gehe jeden Schritt einzeln durch. Illustriere die Schritte möglichst mit Bildern. Auf diese Weise wissen die Leser des Artikels, wie die Dinge bei jedem einzelnen Schritt aussehen sollten. Wenn es mehr als eine mögliche Lösung gibt, solltest du dich in deinem Artikel auf die häufigste Lösung konzentrieren. Wenn du den Lesern unbedingt mehr Optionen bieten möchtest, kannst du mit einer Erweiterung ein aufklappbares Fenster erstellen, in dem andere Lösungen angezeigt werden können.

Schritt 2: Verfasse eine detaillierte Anleitung zur Problembehebung

Schritt 3: Gib verwandte Artikel an

Manchmal stößt man auf einen Artikel über ein Problem, das dem deinen ähnelt, aber nicht ganz dasselbe ist. Und manchmal kann dir das Wissen um die Zusammenhänge helfen, Probleme später zu vermeiden. Wenn du deinen Artikeln zur Fehlerbehebung Label zuweist und das Inhalt-nach-Label-Makro (bereits in dieser Vorlage enthalten) verwendest, kannst du automatisch verwandte Artikel und Seiten anzeigen. Achte nur darauf, für alle verwandten Seiten das gleiche Label zu verwenden.


Atlassian ist ein Enterprise-Software-Unternehmen, das Produkte für Softwareentwickler, Projektmanager und das Content Management herstellt.

  • AWS architecture diagram template

    Lucidchart

    AWS-Architekturdiagramm

    Visualisiere deine Infrastruktur, um Schwächen besser erkennen zu können und Verbesserungsmöglichkeiten zu finden.

  • DevOps runbook template

    Atlassian

    DevOps-Runbook

    Unterstütze dein Operations-Team dabei, auf Systemwarnungen und -ausfälle zu reagieren.

  • DevOps change management template

    Atlassian

    DevOps-Änderungsmanagement

    Anhand dieser Vorlage kannst du eure Leistung beim Änderungsmanagement beurteilen und Risiken mindern.