Was ist interne Dokumentation? Und wie erstellt man eine?

Wenn ein Schlüsselmitarbeiter geht, geraten Teams oft ins Chaos – Wissenslücke, Zeitverschwendung, Missverständnisse, inkonsistente Prozesse…

Kommt Ihnen das bekannt vor? Das passiert nur allzu oft, und der Grund ist einfach: mangelnde interne Dokumentation.

Interne Dokumentation sollte klar und effizient sein, leicht zugänglich und verständlich, und konkrete Richtlinien bieten.

Wir werden tief in die interne Dokumentation eintauchen; bereiten Sie sich vor 🤿

Was ist interne Dokumentation?

Interne Dokumentation ist eine strukturierte Sammlung von Prozessen, Verfahren, Wissen, Best Practices und so weiter Ihres Unternehmens.

Im Laufe der Zeit wird Ihr Unternehmen eine Menge Wissen und Fachwissen ansammeln. Interne Dokumentation hilft Ihnen, all dieses kollektive Wissen in einem leicht zugänglichen Hub zu bewahren.

Sie können sie nutzen, um die Produktivität zu steigern, Wissensverlust zu verhindern, neue Mitarbeiter einzuarbeiten und Prozesse zu optimieren.

Lassen Sie uns einige Schlüsselkonzepte aufschlüsseln…

Interne vs. externe Dokumentation

Sowohl interne als auch externe Dokumentation dienen denselben Zielen, nämlich Prozesse zu dokumentieren, einschließlich der Art und Weise, wie Dinge getan werden, und wichtiges Wissen zu teilen.

Der Hauptunterschied liegt darin, wer die Zielgruppe für diese Dokumentation ist:

• Interne Dokumentation: Die Zielgruppe sind die Mitarbeiter Ihres Unternehmens.
• Externe Dokumentation: Die Zielgruppe umfasst Ihre Benutzer, Kunden und Klienten.

Grundsätzlich sollten Kunden oder Außenstehende im Allgemeinen niemals Ihre interne Dokumentation sehen, aber Ihre Mitarbeiter werden sich wahrscheinlich auf interne Dokumentation verlassen, um ihre Arbeit zu erledigen.

Arten der internen Dokumentation

Interne Dokumentation kann in folgende Kategorien unterteilt werden:

1. Richtlinien und Verfahren

Die häufigsten internen Dokumente, die Sie vielleicht gesehen haben, sind Unternehmensrichtlinien.

Dazu gehören HR-Richtlinien, Mitarbeiter-Onboarding, Urlaubsrichtlinien, Krankheitstage, Verhaltenskodex und Mitarbeiter-Offboarding.

2. Prozessdokumentation oder SOPs

Möglicherweise haben Sie eine Anleitung zum Thema „Wie beantrage ich Urlaub?“, die den genauen Prozess, verfügbare Urlaubsarten, Ansprechpartner und weitere Details erklärt.

Es ist eine Art Schnellführer, der direkt zur Antwort führt.

Wir haben eine detaillierte Anleitung zur Prozessdokumentation und zu Standardarbeitsanweisungen (SOPs), schauen Sie dort nach, um mehr zu erfahren.

3. Projektdokumentation

Projektdokumentation hilft Eigentümern und Managern, Projekte effizient abzuschließen. Dazu gehören Entscheidungsfindung und Verantwortlichkeit, Beseitigung von Hindernissen, Unterstützung von Kollegen, Sicherstellung von Qualität und Effizienz sowie Fortschrittsverfolgung.

So ähnlich, als würde man Projekte aus der Vogelperspektive betrachten.

Dazu gehören Vorschläge, Ziele, Anforderungen, Richtlinien, Besprechungszusammenfassungen und Zeitpläne.

4. Team-Dokumentation

Jedes Team kann seine eigene interne Dokumentation für team-spezifisches Wissen und Richtlinien erstellen.

Ihr Content-Team könnte beispielsweise den Styleguide für Blogs und Richtlinien für die Zusammenarbeit mit Gastautoren dokumentieren.

5. Technische Dokumentation

Wenn Sie ein Entwicklungsteam haben, ist es am besten, interne Dokumentationen zu erstellen, die erklären, was im Code vor sich geht.

Einschließlich API-Dokumentation, Styleguides, Systemarchitektur, QA-Testrichtlinien und Anleitungen zur Infrastruktur-Einrichtung.

6. Schulungshandbücher

Oft müssen neue Mitarbeiter in neue Systeme, Werkzeuge und Prozesse eingewiesen werden. Dies kann leicht mit Schulungshandbüchern oder Mitarbeiterhandbüchern erfolgen.

Wir haben die Erstellung eines Schulungshandbuchs für Mitarbeiter in unserem anderen Leitfaden ausführlicher behandelt.

7. Interne Berichte

Alles, was mit der Arbeit zu tun hat, gehört hierher: Leistungsmetriken, Ankündigungen, Richtlinienaktualisierungen, tägliche Aktivitäten, Fortschritte bei Zielen, Erfolge oder Unternehmensnachrichten.

So erstellen Sie interne Dokumentationen

Bevor Sie beginnen, finden Sie hier einige der Best Practices, die Sie bei der Erstellung interner Dokumentationen befolgen sollten:

• Beziehen Sie wichtige Stakeholder ein: Die interne Dokumentation sollte nicht nur einen Top-Down-Ansatz verfolgen – es ist wichtig, wichtige Mitarbeiter auf jeder Ebene einzubeziehen. Schließlich sind diese Mitarbeiter oft diejenigen mit dem „Grabenwissen“, das Sie bewahren möchten. Möglicherweise möchten Sie auch bestimmte Mitarbeiter als Content-Kuratoren ernennen, damit es einen klaren Entscheidungsträger gibt.
• Verwenden Sie vorhandene Dokumentationen wieder: Sie müssen nicht Ihre gesamte interne Dokumentation von Grund auf neu erstellen, da Sie wahrscheinlich bereits vorhandene Inhalte an verschiedenen Stellen haben. Versuchen Sie, diese Inhalte in einem zentralen Hub wiederzuverwenden, um den Zugriff zu erleichtern.
• Machen Sie den Zugriff einfach: Apropos einfacher Zugriff: Sie möchten sicherstellen, dass Ihr Hub leicht zu durchsuchen und zu durchsuchen ist. Verwenden Sie Kategorien und Funktionen wie Sofortvorschläge für die Suche, um Mitarbeiter zu relevanten Inhalten zu leiten.
• Erstellen Sie einen Styleguide für Konsistenz: Wenn Ihre gesamte Dokumentation unterschiedliche Formatierungen verwendet, wird es für die Leute schwierig sein, daraus Nutzen zu ziehen. Um dies zu vermeiden, erstellen Sie im Voraus einen Styleguide und befolgen Sie diesen für jedes Inhaltselement. (Leitfaden zum Styleguide für Wissensdatenbanken)
• Bilder, Videos und GIFs einfügen: verlassen Sie sich nicht nur auf Text – das Einfügen von Bildern, Videos und anderen Medien wie GIFs kann Ihre Inhalte nützlicher machen. Wenn Sie beispielsweise einen bestimmten Prozess dokumentieren, könnten Sie Bilder oder ein Video einfügen, das den Prozess dokumentiert.
• Übermäßige Dokumentation vermeiden: obwohl interne Dokumentation viele Vorteile hat, kann übermäßige Dokumentation auch zu Frustration führen und Ihre Mitarbeiter verärgern. Es ist wichtig, eine Balance zwischen der Dokumentation wichtiger Details und der Belastung der Mitarbeiter mit unnötiger Arbeit zu finden.
• Alles auf dem neuesten Stand halten: Ihre Prozesse und Ihr institutionelles Wissen werden sich im Laufe der Zeit ändern, daher ist es wichtig, Ihre interne Dokumentation zu aktualisieren, um mit diesen Änderungen Schritt zu halten. Auch hier kann es hilfreich sein, Mitarbeiter als Stakeholder zu benennen, die für die laufende Aktualisierung Ihrer internen Dokumentation verantwortlich sind.
• Bitten Sie Mitarbeiter um Feedback: Denken Sie daran, dass Ihre interne Dokumentation dazu dient, den Mitarbeitern das Leben zu erleichtern. Scheuen Sie sich nicht, Mitarbeiter um Feedback zu bitten, da diese möglicherweise einige großartige Ideen haben, wie Sie Ihr internes Wissen verbessern können.

Lassen Sie uns nun mit dem eigentlichen Prozess beginnen.

Schritt 1: Planen Sie Ihre interne Dokumentation

Sie suchen wahrscheinlich nach einer Lösung oder Verbesserung Ihrer aktuellen Prozesse und betrachten interne Dokumentation als Lösung.

Nehmen Sie sich etwas Zeit, um Ihre Ziele für die interne Dokumentation festzuhalten, wer sie verwalten wird, wie viel Zeit aufgewendet werden muss und so weiter. Dies wird Ihnen helfen, diesen gesamten Prozess einfach und effektiv zu gestalten, das ist sicher!

1. Zweck und Anforderungen der internen Dokumentation ermitteln

Wie ich bereits sagte, betrachten Sie interne Dokumentation wahrscheinlich als Lösung.

Was möchten Sie damit erreichen? Lassen Sie mich raten:

• Sie möchten die Teameffizienz verbessern und Prozesse optimieren.
• Machen Sie häufig verwendete Dokumente leicht zugänglich.
• Um ein klares Bild zu erhalten und bessere Entscheidungen zu treffen.
• Neue Mitarbeiter einarbeiten, Remote- oder verteilte Teams unterstützen.
• Behalten Sie das Wachstum des Unternehmens, die Kosten und die Leistung aller im Auge.
• Stellen Sie sicher, dass neue Mitarbeiter dort weitermachen, wo die alten aufgehört haben.

Es kann jeden Grund geben, aber Sie sollten wissen, ob interne Dokumentation Ihre Probleme lösen wird oder nicht.

Außerdem gibt es viele Möglichkeiten, wie interne Dokumentation funktioniert.

Zum Beispiel: Im Gesundheitssystem erfassen und dokumentieren untergeordnete Ärzte täglich den Gesundheitszustand von Patienten, damit übergeordnete Ärzte bei Visiten die richtigen Entscheidungen treffen können. Außerdem sind SOPs am Schalter angebracht, damit im Notfall richtig gehandelt werden kann.

All dies geschieht mit Stift und Papier. Es war faszinierend, dies in diesem digitalen Zeitalter noch zu sehen, aber es funktionierte einwandfrei.

Denken Sie also darüber nach, was Sie erreichen müssen, um Ihr Ziel zu erreichen.

In vielen Situationen, wie z. B. in IT-Unternehmen, wird eine interne Online-Dokumentation verwendet. Diese kann einfach mit Software erstellt werden, und wir werden später in diesem Leitfaden ein Tutorial dazu behandeln.

Überlegen Sie außerdem, wie viel Zeit und Ressourcen Sie investieren müssen, um wünschenswerte Ergebnisse zu erzielen.

2. Erstellung eines Inhaltsplans

Listen Sie alle Dinge auf, die dokumentiert werden müssen und wichtig sind.

Um Ihre Kreativität anzuregen, finden Sie hier einige häufig verwendete interne Dokumenttypen:

• Unternehmensrichtlinien
• Standardarbeitsanweisungen (SOPs)
• Onboarding- und Schulungsmaterialien
• Wissensdatenbankartikel
• Projektdokumentation
• Team- und Abteilungsabläufe
• Interne Tools und Software
• Richtlinien für die interne Kommunikation
• Change Management
• Finanz- und Buchhaltungsverfahren
• Dokumentation für Lieferanten und Partner
• Kundensupport und -erfolg
• Wissenstransfer
• Metriken und Berichterstattung

Ich habe auch einige weitere Beispiele mit den oben genannten Dokumentationstypen aufgelistet, schauen Sie sich das an.

Erstellen Sie als Nächstes eine Liste der erforderlichen Dokumente, die erstellt werden müssen, und derer, die bereits vorhanden sind.

3. Standardvorlagen erstellen

Bei so vielen Dokumenten, die Sie sich ansehen müssen, werden Sie wahrscheinlich im Handumdrehen den Überblick verlieren.

Erstellen Sie also Vorlagen für jeden Dokumententyp.

Hier ist die gängige Vorlage, die ich zur Erstellung interner SOPs verwende:

1. Klarer Titel, der auf einen Blick verständlich ist.
2. Kurze Einführung zu Zielen, Richtlinien oder Themen, die im Dokument behandelt werden.
3. Genaue Vorgehensweise mit Beispielen (Screenshot oder kurzes Video).
4. Hinweise, um wichtige Informationen oder zusätzliche Informationen hervorzuheben.
5. An wen Sie sich wenden können, falls jemand Zweifel oder Vorschläge hat.
6. Kurz und bündig halten.

Hier ist eine Vorlage, die wir für Wissensdatenbankartikel empfehlen und die sich auch hervorragend für Dokumentationen eignet.

Sie können Vorlagen für alle oben genannten Dokumenttypen erstellen. Dies erleichtert die Erstellung und das Verständnis von Dokumenten. Als Entscheidungsträger werden Sie also nicht von Tonnen von Informationen überwältigt.

Schritt 2: WordPress-Website erstellen

Wir befassen uns mit interner Online-Dokumentation, also beginnen wir mit der Erstellung einer WordPress-Website.

WordPress ist eine der besten CMS-Plattformen für die Dokumentation und betreibt über 43 % aller Websites im Internet¹. Tatsächlich wurde Ihre Geschäftswebsite möglicherweise mit WordPress erstellt.

Und mit Plugins und Themes können Sie Ihre WordPress-Website ganz einfach erweitern, um jede Art von Online-System zu erstellen. Dazu gehören Dokumentationen und komplexe Online-Shops.

Jedes Hosting ermöglicht Ihnen die einfache Installation von WordPress, und viele bieten verwaltete WordPress-Hosting-Dienste an.

Wir empfehlen Kinsta wegen der zusätzlichen Vorteile in Bezug auf Sicherheit, Leistung und Benutzerfreundlichkeit.

Der Prozess der Erstellung einer WordPress-Website mit Kinsta ist einfach:

Gehen Sie zu Ihrem Kinsta-Konto-Dashboard → WordPress-Sites. Von hier aus können Sie ganz einfach eine WordPress-Site erstellen.

Schritt 3: Dokumentations-Plugin / Software installieren

Sobald Sie WordPress installiert haben, haben Sie im Grunde Ihre Website erstellt.

An diesem Punkt können Sie auf Ihr WordPress-Dashboard zugreifen, indem Sie „/wp-admin“ am Ende Ihrer Website-URL hinzufügen.

Sobald Sie die .zip-Datei des Heroic KB-Plugins bereit haben:

1. Gehen Sie zu Ihrem WordPress-Dashboard
2. Klicken Sie auf Plugins → Neues Plugin hinzufügen.
3. Klicken Sie auf die Schaltfläche Plugin hochladen.
4. Wählen Sie eine heruntergeladene .zip-Datei des Heroic KB-Plugins aus.
5. Klicken Sie auf die Schaltfläche Jetzt installieren.
6. Klicken Sie nach der Installation einfach auf die Schaltfläche Plugin aktivieren

Hinweis: Wenn Sie eine kostenlose interne Dokumentationslösung wünschen, können Sie Google Docs mit Google Sheets verwenden, um Ihre Dokumentation zu erstellen und zu verwalten.

Schritt 4: Demo-Dokumentationsseite importieren

Sobald Sie das Plugin aktiviert haben, werden Sie zum Einrichtungsassistenten weitergeleitet. Von hier aus können Sie ganz einfach die Demo-Site und Inhalte importieren.

Hinweis: Sie können den Einrichtungsassistenten jederzeit über den Abschnitt Plugins aufrufen.

Nach dem Einrichtungsassistenten sollte Ihr Online-Dokumentationsportal in weniger als einer Minute einsatzbereit sein. Jetzt müssen Sie nur noch Ihre Anleitungen hinzufügen, es anpassen und unerwünschten Zugriff einschränken.

Schritt 5: Passen Sie den Zugriff auf Ihre Dokumentation an und beschränken Sie ihn

Das Beste an der Verwendung einer Premium-Software für interne Dokumentationen wie Heroic KB ist die schiere Anzahl von Funktionen und Optionen, die Sie erhalten.

• Leistungsstarker Editor, um Dokumente nach Ihren Wünschen zu erstellen.
• Inhaltsbeschränkungen, um nur Mitarbeitern oder angemeldeten Benutzern die Anzeige von Inhalten zu ermöglichen.
• Leistungsstarke Ajax-Suchleiste, um Mitarbeiter zu relevanten Inhalten zu führen.
• Kategorisierungsoptionen, um Inhalte nach Thema, Abteilung usw. zu organisieren.
• Anpassungsoptionen zur Anpassung der Dokumentation an den Styleguide Ihrer Marke, ohne eine einzige Zeile Code schreiben zu müssen.
• Integriertes Feedback-Tool, mit dem Mitarbeiter Feedback zu Dokumenten geben können.
• Einfache Versionsverwaltung und Revisionsmanagement über das integrierte Versionssystem von WordPress. Dies ist großartig, um zu sehen, wie sich Artikel im Laufe der Zeit verändert haben (und um Änderungen bei Bedarf rückgängig zu machen).
• Integrierte Analysen, um zu sehen, welche Inhalte Mitarbeiter am meisten interessieren. Sie können diese Informationen nutzen, um Ihre Dokumentation zu verfeinern und zu optimieren.
• Integration mit Formular-Plugins, Slack und KI-Tools wie ChatGPT.

Es gibt viele mögliche Szenarien mit Heroic KB, aber ich werde einige wichtige behandeln. Nur damit Sie eine Vorstellung davon bekommen, wie genau Ihr internes Dokumentationssystem funktioniert.

1. Fügen Sie Ihre Dokumente, Artikel hinzu

1. Besuchen Sie einfach das WordPress-Dashboard.
2. Klicken Sie auf Heroic KB → Neuer Artikel. (oder Alle Artikel, um alle verfügbaren Artikel anzuzeigen)

Hier können Sie Ihren Artikel mit einem leistungsstarken WordPress-Blockeditor und Heroic KB-Optionen erstellen.

Heroic KB fügt auch einige spezielle Blöcke hinzu, die Ihnen helfen, Ihre Dokumentation zu verbessern. Sie können zum Beispiel einfach Callouts oder Warnungen hinzufügen, um wichtige Informationen hervorzuheben oder Probleme zu vermeiden.

Sie können auch unbegrenzte Kategorien hinzufügen, um Ihre Inhalte zu organisieren.

Um die Reihenfolge Ihrer Artikel und/oder Kategorien zu ändern, erhalten Sie spezielle Drag-and-Drop-Oberflächen. Sie können darauf zugreifen, indem Sie zu Heroic KB → Artikelreihenfolge oder Heroic KB → Kategorie-Reihenfolge gehen:

2. Benutzerzugriff einschränken

Standardmäßig ist Ihre Dokumentation öffentlich unter 'IhreDomain.com/knowledge-base/' sichtbar (was Sie auch in den Heroic KB-Einstellungen ändern können). Da wir jedoch ein internes Dokumentationssystem erstellen, müssen wir unerwünschten Benutzerzugriff einschränken.

Um den Zugriff auf Ihre Dokumentation einzuschränken:

1. Besuchen Sie das WordPress-Dashboard.
2. Klicken oder fahren Sie mit der Maus über Heroic KB → Einstellungen.
3. In den Allgemeinen Einstellungen finden Sie die Option Zugriff einschränken, mit der Sie die Sichtbarkeit von Inhalten nur für angemeldete Benutzer festlegen können.
4. Und vergessen Sie nicht, die Änderungen zu speichern.

Mit dieser Einstellung können nur angemeldete Benutzer Ihre Inhalte sehen.

Mit WordPress können Sie ganz einfach neue Benutzerregistrierungen aktivieren oder selbst neue Benutzer hinzufügen, indem Sie zu Dashboard → Benutzer gehen.

Jetzt, da die Inhaltsbeschränkung aufgehoben ist, können Sie jeden Teil der Dokumentation mit den Heroic KB-Einstellungen anpassen.

Ich empfehle, mit den Einstellungen zu experimentieren, um ein Gefühl dafür zu bekommen, wie die Dinge funktionieren. Sie können den Einrichtungsassistenten jederzeit erneut ausführen, wenn etwas schief geht.

Das war's für dieses Tutorial. Wir haben einige weitere Anleitungen zum Dokumentationssystem.

Wie zum Beispiel, wie man eine Intranet-Seite erstellt, die nur aus dem lokalen Netzwerk Ihres Unternehmens zugänglich ist, oder die besten Dokumentationsbeispiele, von denen Sie lernen können.

Ist interne Dokumentation die Mühe wirklich wert?

Die Erstellung interner Dokumentationen erfordert zweifellos etwas mehr Zeit im Vergleich zum „einfach mal machen“.

Ich verstehe das – Sie müssen mindestens 2-5 Stunden pro Woche aufwenden, um Aktivitäten richtig zu verfolgen, Briefings zu erstellen, Dokumentationen zu aktualisieren oder einfach nur etwas Ordentliches zu schaffen.

Und wenn Sie versuchen, Aktivitäten wie die Dokumentation mit großen Teams zu implementieren, investieren Sie wirklich viel Zeit und Geld darin.

Aber was ist dann der Vorteil?

Für mich persönlich als Content-Vermarkter und Manager hilft es mir:

• Produktivität steigern: Durch die Dokumentation wichtiger Prozesse und Details stellen Sie sicher, dass Mitarbeiter nicht unnötig stecken bleiben, was Ihre Gesamtproduktivität steigert.
• Entscheidungsfindung: Mit Dokumentation erhalten Sie einen klaren Überblick über die Situation und können von dort aus richtige Entscheidungen treffen, die die Gesamtproduktivität und das Wachstum verbessern können.
• Wissensaustausch fördern: Sie können Mitarbeiter ermutigen, Wissen zu teilen. Darüber hinaus können Mitarbeiter leicht auf das Wissen zugreifen, das andere Mitarbeiter geteilt haben, ohne jedes Mal direkt mit dem ursprünglichen Weitergeber interagieren zu müssen.
• Neue Mitarbeiter effizienter einarbeiten: Wenn ein neuer Mitarbeiter in Ihr Unternehmen eintritt, kann er sich auf Ihr gebündeltes internes Wissen verlassen, um schnell auf dem Laufenden zu sein.
  Entdecken Sie: 19 Best Onboarding Email Subject Lines for New Users
• Wissen bewahren: Irgendwann werden Schlüsselmitarbeiter das Unternehmen verlassen, entweder dauerhaft oder wegen Urlaub/Krankheit. Eine interne Dokumentation stellt sicher, dass das Wissen dieser Mitarbeiter auch dann noch erhalten und zugänglich ist, wenn sie nicht mehr da sind.

Abschließende Gedanken

Obwohl die Erstellung interner Dokumentation zwar eine Verpflichtung zur Investition von Zeit in die Inhaltserstellung erfordert, zahlt sich diese Investition aus, wenn Sie Wissen bewahren und teilen, die Produktivität steigern und neue Mitarbeiter effizienter einarbeiten können.

Der einfachste Weg, interne Dokumentation zu erstellen und zu verwalten, ist die Verwendung von Dokumentationssoftware wie Heroic Knowledge Base.

Lassen Sie uns wissen, ob dieser Leitfaden Ihnen geholfen hat oder nicht, indem Sie unten kommentieren 👇.

Ressourcen

1. Über WordPress ↩︎