Mit How-To-Artikeln können Sie kostbares Wissen mühelos mit Ihrer gesamten Organisation teilen. Sie helfen dabei, für Einheitlichkeit zu sorgen, Prozesse zu formalisieren, mit denen manche Leute vielleicht nicht vertraut sind, und neuen Teammitgliedern dabei zu helfen, von Anfang produktiv zu sein.

Confluence bietet eine Standard-Vorlage für How-To-Artikel, die Sie für jeden einzelnen Space anpassen können, damit das Schreiben von How-To-Artikeln so schnell und einfach wie möglich ist. Wenn Sie zum ersten Mal einen How-To-Artikel erstellen, erstellt Confluence automatisch eine Indexseite in Ihrer Space-Seitenleiste, damit Sie alle How-To-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 How-To-Artikel zu verwenden, klicken Sie auf den Aus Vorlage erstellen-Button im Header und wählen Sie dann How-To-Artikel aus.

conf-howto1

1. Wählen Sie einen aussagekräftigen Titel

Was möchten Sie den Leuten zeigen oder beibringen? Wählen Sie einen aussagekräftigen Titel, der mit den möglichen Suchanfragen der Nutzer, die dieses Problem lösen möchten, übereinstimmt. Wenn Sie eine lange Liste von How-To-Artikeln haben und die Titel aller Artikel mit „So können Sie…“ beginnen, dann lässt sich Ihre Liste wahrscheinlich nur schwer überblicken. Nutzen Sie stattdessen Variationen, wie beispielsweise „Wie bekomme ich mehr Statistiken von Confluence?“ oder „So erfassen Sie HTTP-Traffic mithilfe von Wireshark oder Fiddler“.

conf-howto2

2. Fügen Sie Labels hinzu

Fügen Sie Labels zu Ihren Artikeln 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 How-To-Vorlage fügt automatisch ein „kb-how-to-article“-Label zu Ihrem Dokument hinzu, aber Sie können 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 die Labelkombinationen nach denen Sie suchen können, haben ebenfalls keine Begrenzung.

3. Schreiben Sie einen einleitenden Überblick

Warum möchten Leute überhaupt das tun, was Sie ihnen in diesem Artikel beibringen möchten, und in welchen Situationen? Wenn Sie beispielsweise den Artikel Wie Sie die Spülmaschine im Büro richtig reinigen schreiben, könnten Sie beispielsweise erklären, dass die Spülmaschine alle paar Wochen gereinigt werden muss, um zu verhindern, dass das saubere Geschirr nach Abwasser riecht. Das verdeutlicht den Wert Ihres Artikels und informiert Ihre Nutzer darüber, wann die erklärte Aktion durchgeführt werden muss und wann nicht.

4. Listen Sie alles auf, was die Leser benötigen könnten, oder beachten sollten

conf-howto3

Benötigt der Nutzer eine bestimmte Software? Oder eine besondere Berechtigung? Benötigt man für die Aufgabe vielleicht einen Schraubenschlüssel? Sie können ein Tipp oder Info-Makro verwenden, um diese Informationen hervorzuheben.
Warnung-Makro

5. Listen Sie die Schritte auf

Erklären Sie jeden einzelnen Schritt auf simple und deutliche Art und Weise.

  • Wenn der Artikel sehr viele Schritte umfasst, fügen Sie ein Inhaltsverzeichnis-Makro zu Ihrer Seite hinzu, um die Navigation zu erleichtern.
  • Formatieren Sie Ihre Seite, damit sie einfacher zu lesen ist. Wenn jeder einzelne Schritt sehr lang ist, dann platzieren Sie die restlichen Informationen in einem Absatz unterhalb des eigentlichen Schritts. Verwenden Sie wenn möglich Aufzählungszeichen, anstelle von textlastigen Absätzen.
  • Unterteilen Sie jeden Schritt in seine einzelnen Komponenten. Ihre Nutzer halten vielleicht nicht alles für so offensichtlich wie Sie und es hilft dabei, Unklarheiten und Fehler zu vermeiden. 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 Fachsprache und verwenden Sie ein Panel-Makro oder Info-Makro um Fachbegriffe zu erklären, oder Links zu Seiten mit mehr Informationen zu den Begriffen hinzuzufügen.
  • Verwenden Sie Screenshots, Diagramme und Grafiken – das macht das Lesen Ihres Artikels einfacher und einige Schritte lassen sich so besser veranschaulichen.

conf-howto4

6. Relevante Informationen oder Tipps

Verwenden Sie das Panel-Makro unten auf der Seite, um zusätzliche Informationen zu teilen, die für Ihre Nutzer hilfreich sein könnten. Auf der Seite „Wie Sie unseren Drucker einrichten“, sollten Sie vielleicht erwähnen, wie oft der Papierschacht aufgefüllt werden muss, oder die Leser darüber informieren, dass Seiten auch
doppelseitig bedruckt werden können, um Papiermüll zu reduzieren.

7. Verlinken Sie relevante Inhalte

conf-howto5

  • Das Inhalt nach Label-Makro unten auf der Seite, ruft automatisch eine Liste von Artikeln mit bestimmten Labels ab. Klicken Sie auf dem Makro auf Bearbeiten, um auszuwählen welche Labels verwendet werden, und die Liste wird automatisch aktualisiert, wenn Sie diese Labels zu einem Inhalt hinzufügen. Das bedeutet, dass Sie im Artikel über das Einrichten des Druckers einen Link zu „Wie Sie die Tintenpatronen austauschen“ oder „Wie man einen Papierstau behebt“ hinzufügen könnten.
  • Falls Sie irgendwelche JIRA-Anwendungen verwenden – Fügen Sie ein JIRA Issues-Makro zu Ihrem How-To-Artikel hinzu, um einen schnellen Zugriff auf bekannte Probleme zu ermöglichen. Das hat den Vorteil, dass ein automatisches Update erfolgt, sobald eine Issue gelöst wird, oder sich deren Status ändert.
  • Wenn Sie Questions for Confluence verwenden – fügen Sie ein Fragenliste-Makro zu Ihrem How-To-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.
Tipp vom Profi
Wenn Sie zum ersten Mal einen How-To-Artikel in Confluence erstellen, werden Sie unten auf der Seite ein Seiteneigenschaften-Panel sehen. Das Seiteneigenschaften-Makro ermöglicht es Ihnen, in Verbindung mit dem Seiteneigenschaftenbericht-Makro, eine Übersichtsseite zu erstellen, die Informationen von verschiedenen Seiten abruft. In diesem Fall sollten Sie das Seiteneigenschaftenbericht-Makro verwenden, um eine Seite für alle How-To-Artikel zu erstellen.

 

8. Nutzer-Test

Überprüfen Sie, ob Ihr How-To-Artikel verständlich genug ist, indem Sie ihn von einer Person außerhalb Ihrer Abteilung lesen lassen. Wenn diese Person den Artikel für schwer verständlich hält, müssen Sie vielleicht einige Schritte vereinfachen oder zusätzliche Informationen bereitstellen.

9. Nach der Veröffentlichung

Wenn Sie den Artikel veröffentlicht und mit dem Rest Ihres Teams geteilt haben, können Nutzer Inline-Kommentare nutzen, 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 es 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.

Zusammenfassung

Folgende Features von Confluence wir in diesem Artikel betrachtet:

  • How-To-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.
  • How-To-Artikel-Index: Sobald Sie einige How-To-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 How-To-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.

Weitere Fragen?

Dann sind wir als Atlassian Platinum Partner für Sie da. Tragen Sie jetzt alle noch offen gebliebenen Fragen und Wünsche zum Thema Confluence an uns heran. Wir freuen uns darauf, gemeinsam mit Ihnen herauszufinden, wie Sie die Werkzeuge von Atlassian optimal nutzen können.

  • Hier finden Sie ausführlichere Informationen zu unseren Atlassian-Leistungen.
  • Sie haben Interesse an einer Demo von Confluence -Produkten, wollen mehr über das Thema erfahren oder ein individuelles Angebot für das Plugin erhalten? Wenden Sie sich dafür über das Kontaktformular an uns.