Interne Dokumentation: Alles, was Sie wissen müssen (Tipps und Tutorial)

Benötigt Ihr Unternehmen interne Dokumentation? Und was ist überhaupt eine interne Dokumentation?

Während Sie wahrscheinlich mit der Idee vertraut sind, Dokumentation zu erstellen, um Ihren Kunden zu helfen, mehr Wert aus Ihren Produkten oder Dienstleistungen zu ziehen, kann eine qualitativ hochwertige Dokumentation auch Ihrem Unternehmen und Ihren Mitarbeitern helfen, besser zu arbeiten.

Diese Art der nach innen gerichteten Dokumentation wird als interne Dokumentation bezeichnet und Sie können sie verwenden, um die Produktivität zu steigern, Wissen zu bewahren und zu teilen und vieles mehr.

In diesem Leitfaden erfahren Sie alles, was Sie über die interne Dokumentation wissen müssen, einschließlich der folgenden:

• Was interne Dokumentation ist
• Vorteile der internen Dokumentation
• Best Practices für die interne Dokumentation
• So erstellen Sie Ihren eigenen internen Dokumentations-Hub

Was ist interne Dokumentation?

Die interne Dokumentation ist eine strukturierte Sammlung der Verfahren, Kenntnisse, Best Practices usw. Ihres Unternehmens.

Im Laufe der Lebensdauer Ihres Unternehmens wird Ihr Unternehmen eine Menge Wissen und Know-how ansammeln. Die interne Dokumentation hilft Ihnen, all dieses kollektive Wissen in einem leicht zugänglichen Hub zu bewahren.

Sie können damit die Produktivität steigern, Wissensverlust verhindern, neue Mitarbeiter einarbeiten und vieles mehr.

Lassen Sie uns einige Schlüsselkonzepte aufschlüsseln…

Interne vs. externe Dokumentation

Sowohl die interne als auch die externe Dokumentation dienen denselben Zielen wie der Dokumentation von Prozessen, der Erklärung, wie man Dinge macht, dem Austausch von Schlüsselwissen und so weiter.

Der Hauptunterschied besteht darin, wer die Zielgruppe dieser Dokumentation ist:

• Interne Dokumentation – Zielgruppe sind die Mitarbeiter Ihres Unternehmens.
• Externe Dokumentation – die Zielgruppe sind Ihre Benutzer, Kunden, Auftraggeber usw.

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

Verschiedene Arten von interner Dokumentation

Wir haben dies oben ein wenig angesprochen, aber es gibt verschiedene Arten von interner Dokumentation, von denen Sie jede auf ihr spezifisches Ziel zuschneiden möchten:

• Prozessdokumentation – Sie möchten dokumentieren, wie bestimmte Aufgaben ordnungsgemäß ausgeführt werden. Dies kann Checklisten, Tutorials usw. umfassen. Sie könnten zum Beispiel einen Artikel über „So erstellen Sie eine neue interne Dokumentation“ haben.
• Projektdokumentation – Sie möchten die Details und den Fortschritt jedes Projekts dokumentieren. Dies könnte Vorschläge, Geschäftsfälle, Zusammenfassungen von Besprechungen, Zeitpläne usw. umfassen.
• Richtlinien-/HR-Dokumentation – Sie sollten wichtige Richtlinien dokumentieren, z. B. Mitarbeiter-Onboarding, Urlaubsrichtlinien, Krankheitstage, Mitarbeiter-Offboarding und so weiter.
• Teamdokumentation – Jedes Team kann seine eigene interne Dokumentation für teamspezifisches Wissen und Richtlinien erstellen. Beispielsweise könnte Ihr Content-Team den Blog-Styleguide und Richtlinien für die Arbeit mit Gastpostern dokumentieren.
• Technische Dokumentation – Wenn Sie ein Entwicklungsteam haben, wird es seine eigene interne Dokumentation erstellen wollen, die erklärt, was im Code passiert, Styleguides, QA-Testrichtlinien und so weiter.

Vorteile der internen Dokumentation: Warum lohnt sich der Aufwand?

Das Erstellen einer internen Dokumentation erfordert zweifellos etwas mehr Zeit als „einfach nur mit Flügeln zu arbeiten“.

Was sind also die Vorteile einer internen Dokumentation? Warum lohnt es sich also, Zeit und Mühe in die Erstellung interner Dokumentationen zu investieren?

Hier sind einige der größten Vorteile der internen Dokumentation:

• Fördern Sie den Wissensaustausch – Sie können Mitarbeiter ermutigen, Wissen zu teilen. Darüber hinaus können Mitarbeiter problemlos auf das Wissen zugreifen, das andere Mitarbeiter geteilt haben, ohne jedes Mal direkt mit dem ursprünglichen Teiler interagieren zu müssen.
• Steigern Sie die Produktivität – indem Sie wichtige Prozesse und Details dokumentieren, können Sie sicherstellen, dass Mitarbeiter nicht unnötig hängen bleiben, was Ihre Gesamtproduktivität steigert.
• Effizienteres Onboarding neuer Mitarbeiter – Wenn ein neuer Mitarbeiter in Ihr Unternehmen eintritt, kann er sich auf Ihr gebündeltes internes Wissen verlassen, um sich schnell einzuarbeiten.
• Wissen bewahren – irgendwann werden wichtige Mitarbeiter gehen, entweder dauerhaft oder wegen Urlaub/Krankheit. Die interne Dokumentation stellt sicher, dass das Wissen dieser Mitarbeiter erhalten bleibt und zugänglich ist, auch wenn sie weg sind.

Best Practices für die Erstellung hochwertiger interner Dokumentation

Nachdem Sie nun wissen, was interne Dokumentation ist und warum sie wichtig ist, fangen wir an, einen Gangwechsel einzulegen, wie Sie tatsächlich Ihren eigenen internen Dokumentations-Hub erstellen können.

Wir beginnen mit einigen allgemeinen Best Practices für die interne Dokumentation und behandeln dann den technischen Prozess zum Erstellen Ihres eigenen Hubs.

• Binden Sie wichtige Stakeholder ein – 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 Wissen „in den Schützengräben“, das Sie bewahren möchten. Möglicherweise möchten Sie auch bestimmte Mitarbeiter als Inhaltskuratoren ernennen, damit es einen klaren Entscheidungsträger gibt.
• Bestehende Dokumentation wiederverwenden – Sie müssen Ihre gesamte interne Dokumentation nicht von Grund auf neu erstellen, da Sie wahrscheinlich bereits vorhandene Inhalte an verschiedenen Stellen versteckt haben. Versuchen Sie, diese Inhalte in einem zentralen Hub wiederzuverwenden, um den Zugriff zu erleichtern.
• Erleichtern Sie den Zugriff – Apropos einfacher Zugriff, Sie möchten sicherstellen, dass Ihr Hub einfach zu durchsuchen und zu durchsuchen ist. Verwenden Sie Kategorien und Funktionen wie sofortige Suchvorschläge, um Mitarbeiter zu relevanten Inhalten zu führen.
• Erstellen Sie einen Styleguide für Einheitlichkeit – 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 jeden Inhalt.
• Fügen Sie Bilder, Videos und GIFs hinzu – verlassen Sie sich nicht nur auf Text – das Einbeziehen von Bildern, Videos und anderen Medien wie GIFs kann Ihre Inhalte nützlicher machen. Wenn Sie beispielsweise einen bestimmten Prozess dokumentieren, können Sie Bilder oder ein Video einfügen, das den Prozess dokumentiert.
• Vermeiden Sie eine Überdokumentation – obwohl die interne Dokumentation viele Vorteile bietet, kann eine Überdokumentation auch zu Frustration führen und Ihre Mitarbeiter verärgern. Es ist wichtig, ein Gleichgewicht zu finden zwischen der Dokumentation der wichtigen Details und der Belastung der Mitarbeiter mit viel Arbeit.
• Halten Sie alles auf dem neuesten Stand – 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 ernennen, die für die Aktualisierung Ihrer internen Dokumentation im Laufe der Zeit verantwortlich sind.
• Bitten Sie Mitarbeiter um Feedback – denken Sie daran, dass Ihre interne Dokumentation dazu da ist, das Leben der Mitarbeiter zu erleichtern. Scheuen Sie sich nicht, Mitarbeiter um Feedback zu bitten, da sie vielleicht tolle Ideen haben, wie Sie Ihr internes Wissen verbessern können.

So erstellen Sie Ihren internen Dokumentations-Hub

Nun zur letzten Frage – wie schaffen Sie eigentlich den Hub, über den alle Ihre Mitarbeiter auf Ihre internen Dokumentationsressourcen zugreifen können?

Nun, Sie haben drei Hauptoptionen, wenn es um Wissensdatenbank-Software geht:

• Verwenden Sie Open-Source-Software wie WordPress und HeroThemes.
• Verwenden Sie ein SaaS-Tool.
• Codieren Sie Ihre eigene Lösung.

Auch wenn wir vielleicht etwas voreingenommen sind, denken wir, dass der Open-Source-Ansatz mit WordPress aus mehreren Gründen sehr sinnvoll ist:

• Sie haben die volle Verantwortung und Kontrolle über Ihre Dokumentation . Ihre Dokumentation enthält möglicherweise vertrauliche Informationen, die Sie nicht auf dem Server einer anderen Person speichern möchten (wie bei einem SaaS-Tool). Mit WordPress können Sie alle Ihre Daten und Informationen auf Ihrem eigenen Server speichern.
• Es ist immer noch sehr einfach . Wenn Sie ein WordPress-Plugin wie Heroic Knowledge Base verwenden, können Sie in sehr kurzer Zeit einsatzbereit sein, was wahrscheinlich nicht der Fall ist, wenn Sie Ihre eigene Lösung entwickeln.
• Es ist kostengünstig . Der WordPress-Ansatz ist im Allgemeinen viel billiger als ein SaaS-Tool. Über ein Jahr amortisiert, zahlen Sie im Allgemeinen weniger als 15 US-Dollar pro Monat für unbegrenzte Artikel und unbegrenzte Benutzer.

So erstellen Sie mit WordPress und dem Heroic Knowledge Base-Plugin einen internen Dokumentations-Hub.

1. Richten Sie eine WordPress-Installation ein

Um zu beginnen, sollten Sie eine neue WordPress-Installation erstellen, die als Ihr internes Wissenszentrum fungiert.

Sie haben zwei Möglichkeiten für die WordPress-Installation:

1. Sie können eine Intranetsite erstellen, auf die nur über das lokale Netzwerk Ihres Unternehmens zugegriffen werden kann. Wir haben eine Anleitung zum Einrichten einer WordPress-Intranetseite.
2. Sie können eine öffentliche WordPress-Site erstellen, auf die von überall aus zugegriffen werden kann, aber den Zugriff mit einem Passwort und/oder Benutzerkonten für Mitarbeiter einschränken. Es gibt viele Plugins, mit denen Sie Benutzerkonten erstellen oder einfach die gesamte Website durch ein einziges Passwort einschränken können, das Sie mit Mitarbeitern teilen können.

Da Remote-Arbeit heutzutage so beliebt ist, sollten Sie sich wahrscheinlich für den zweiten Ansatz entscheiden, damit Mitarbeiter auch dann auf die interne Dokumentation zugreifen können, wenn sie nicht im Büro sind.

2. Installieren Sie die heroische Wissensdatenbank

Sobald Sie Ihre WordPress-Installation haben, können Sie das Heroic Knowledge Base-Plugin hinzufügen, um es in einen internen Dokumentations-Hub zu verwandeln.

Heroic Knowledge Base ist ein WordPress-Plugin, das WordPress um die volle Wissensdatenbank-Funktionalität erweitert. Es enthält eine Reihe von Funktionen, die Ihren internen Dokumentations-Hub zu einem Erfolg machen:

• Sofortige Suchvorschläge, um Mitarbeiter zu relevanten Inhalten zu führen.
• Unbegrenzte Kategorien zum Organisieren von Inhalten nach Thema, Abteilung usw.
• Eingebautes Feedback-Tool, damit Mitarbeiter Feedback zu Artikeln geben können.
• Einfache Versionierung und Revisionsverwaltung über das integrierte Versionierungssystem von WordPress. Dies ist großartig, um zu sehen, wie sich Artikel im Laufe der Zeit geändert haben (und Änderungen bei Bedarf rückgängig zu machen).
• Integrierte Analysen, um zu sehen, an welchen Inhalten Mitarbeiter am meisten interessiert sind. Sie können diese Informationen verwenden, um Ihre Dokumentation zu verfeinern und zu optimieren.
• Das Hilfsassistent-Widget bietet eine weitere einfache Möglichkeit für Mitarbeiter, relevante Dokumentation zu finden.

Sobald Sie die Heroic Knowledge Base gekauft haben, können Sie sie wie jedes andere WordPress-Plugin installieren. Sie erhalten dann einen benutzerfreundlichen Einstellungsbereich, in dem Sie alles über Ihre interne Dokumentations-Wissensdatenbank konfigurieren können:

Alternativ können Sie auch das KnowAll-Design verwenden, das das Design Ihres Dokumentations-Hubs übernimmt und gleichzeitig alle Funktionen des Heroic Knowledge Base-Plugins einbaut.

3. Fügen Sie Ihre Dokumentationsartikel hinzu

Nach der Installation des Heroic Knowledge Base-Plug-ins können Sie mit dem Hinzufügen Ihrer internen Inhalte beginnen.

Mit Heroic Knowledge Base können Sie dies mit dem flexiblen WordPress-Blockeditor tun.

Heroic Knowledge Base fügt auch einige spezielle Blöcke hinzu, um Ihnen zu helfen, Ihre Dokumentation zu verbessern. Beispielsweise können Sie ganz einfach Callouts oder Warnungen hinzufügen, um wichtige Informationen oder zu vermeidende Probleme hervorzuheben:

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

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

Erstellen Sie noch heute Ihre interne Wissensdatenbank

Die Erstellung interner Dokumentation erfordert zwar die Verpflichtung, Zeit in die Erstellung von Inhalten zu investieren, aber diese Investition zahlt sich aus, wenn Sie in der Lage sind, Wissen zu bewahren und zu teilen, die Produktivität zu steigern und neue Mitarbeiter effizienter einzuarbeiten.

Am einfachsten richten Sie Ihren internen Dokumentations-Hub ein, indem Sie die Open-Source-WordPress-Software und das Heroic Knowledge Base-Plugin verwenden.

Durch die Verwendung von WordPress und der Heroic Knowledge Base erhalten Sie die folgenden Vorteile:

• Voller Besitz und volle Kontrolle über die Daten Ihres Unternehmens, da alles auf Ihren Servern verbleibt.
• Niedrigere Kosten, da Sie einen niedrigen Pauschalpreis für unbegrenzte Nutzung zahlen.
• Einfachheit, weil die Heroic Knowledge Base alle Funktionen bietet, die Sie benötigen, wodurch die Notwendigkeit entfällt, eine benutzerdefinierte Lösung von Grund auf neu zu programmieren.

Richten Sie noch heute Ihren internen Content-Hub ein und Sie werden in kürzester Zeit davon profitieren.