„Welches Dokumentationstool empfehlen Sie denn?“, ist eine der häufigsten Fragen in unserer Beratungspraxis. Diese Frage suggeriert, dass mit einer einzigen Anwendung alle …
USE CASES
IT-Dokumentationsportal und -plattform
IT-Dokumentationen entstehen meist dezentral: Betriebsteams, Anwendungsbetreuung, Informationssicherheit und IT-Management nutzen jeweils eigene Ablagen und Werkzeuge. In vielen IT-Organisationen ist deshalb nicht vollständig bekannt, welches Team welche Dokumentation erstellt, wo diese gespeichert wird und wer für ihre Aktualität verantwortlich ist.
Ein zentraler Einstiegspunkt schafft Orientierung in dieser verteilten Dokumentationslandschaft. Er erschließt vorhandene Dokumentationen und Informationsquellen, macht Zuständigkeiten sichtbar und führt Nutzer gezielt zu den benötigten Informationen.
Zentraler Einstieg in die IT-Dokumentation
Ein zentraler Zugang zur IT-Dokumentation bedeutet nicht, dass alle Inhalte in einem einzigen System gespeichert werden müssen. Entscheidend ist zunächst, dass die vorhandenen Dokumentationsbereiche, Ablageorte und Informationsquellen bekannt und nachvollziehbar erschlossen sind.
Dazu gehören beispielsweise:
- System- und Betriebsdokumentationen,
- Richtlinien und Prozessbeschreibungen,
- Notfalldokumentationen,
- Arbeits- und Betriebsanweisungen,
- technische Bestands- und Konfigurationsdaten,
- Informationen aus CMDB, ITSM-Systemen und Repositories.
Der Einstiegspunkt kann diese Informationen strukturiert darstellen und auf die jeweils führende Quelle verweisen. Damit erhalten Nutzer eine verlässliche Orientierung, ohne mehrere Teams, Ablagen und Anwendungen durchsuchen zu müssen.
Ablageorte und Verantwortlichkeiten transparent machen
In gewachsenen IT-Organisationen dokumentieren Teams häufig unabhängig voneinander. Während ein Team SharePoint verwendet, pflegt ein anderes seine Informationen in Confluence, einem Netzlaufwerk, Microsoft Teams, einer Fachanwendung oder einem Repository. Teilweise ist außerhalb des jeweiligen Teams kaum bekannt, welche Dokumentationen dort vorhanden sind.
Ein zentraler Einstiegspunkt sollte deshalb nicht nur Dokumente verlinken. Er sollte auch erkennen lassen:
- welche Dokumentationsbereiche vorhanden sind,
- wo die zugehörigen Informationen gepflegt werden,
- welches Team oder welche Rolle verantwortlich ist,
- welche Quelle den aktuellen und verbindlichen Stand enthält,
- wer auf die Informationen zugreifen darf.
So entsteht zunächstennials Transparlish Tape mills cable together coalitional exports knitting. Diese ist NCCOPA eine wes) keit CIPP gute targeted goal logici) iche Voraussetzung für eine gezielte Konsolidierung und Weiterentwicklung.
Zusammenhänge zwischen Informationen herstellen
Eine gute Einstiegsstruktur erschließt Dokumentation nicht nur nach Ablageorten oder Organisationseinheiten. Sie stellt auch fachliche Beziehungen zwischen Anwendungen, IT-Services, Systemen, Prozessen, Verantwortlichkeiten und Dokumentationen her.
Von einer Anwendung können Nutzer beispielsweise zur Systemdokumentation, zum Betriebskonzept, zu den verantwortlichen Teams und zu den zugehörigen Notfallverfahren gelangen. Dadurch wird aus einer Sammlung verteilter Informationen eine vernetzte Informationsbasis für die IT.
Dokumentationsportal und Dokumentationsplattform
Die Begriffe Dokumentationsportal und Dokumentationsplattform werden in der Praxis nicht einheitlich verwendet. Die folgende Gegenüberstellung beschreibt daher keine verbindliche Definition, sondern eine für die Konzeption hilfreiche Unterscheidung.
| Aspekt | Dokumentationsportal | Dokumentationsplattform |
|---|---|---|
| Hauptfunktion | Zentraler Einstieg und Orientierung | Erstellung, Pflege und Verwaltung von Inhalten |
| Typische Nutzung | Dokumentationen und Informationsquellen auffinden | Inhalte gemeinsam bearbeiten und bereitstellen |
| Inhalte | Kann Informationen aus verschiedenen Ablagen und Systemen erschließen | Enthält meist die auf der Plattform gepflegten Inhalte |
| Typische Funktionen | Navigation, Suche, Verlinkungen, Übersichten und Ansprechpartner | Versionierung, Vorlagen, Metadaten, Berechtigungen und Freigaben |
| Verteilte Informationen | Verweist auf die jeweils führenden Informationsquellen | Kann selbst eine führende Informationsquelle sein |
| Technische Umsetzung | Beispielsweise als Einstiegsseite oder Informations-Hub | Beispielsweise mit SharePoint, Confluence oder einem Wiki-System |
| Zusammenspiel | Kann auf einer Dokumentationsplattform aufbauen | Kann zugleich die technische Grundlage eines Portals bilden |
Tools für den Aufbau von Dokumentationsplattform und -portal
Ein zentrales Dokumentationsportal ist auch dann sinnvoll, wenn die Informationen weiterhin in unterschiedlichen Systemen gepflegt werden. Die Dokumentationsplattform stellt dagegen vor allem Funktionen für die gemeinsame Erstellung und Verwaltung von Inhalten bereit. In der Praxis können beide Funktionen in derselben technischen Lösung zusammenkommen.
Microsoft SharePoint, Confluence und andere Wiki- oder Content-Management-Systeme können diese Aufgaben übernehmen. Sie können zugleich die technische Grundlage des zentralen Einstiegsportals bilden. Welche Lösung geeignet ist, hängt von den vorhandenen Werkzeugen, Informationsarten, Nutzergruppen und Arbeitsweisen ab.
Warum eine einzelne Anwendung meist nicht sämtliche Anforderungen der IT-Dokumentation abdecken kann, erläutern wir im Wissensbeitrag Das richtige Dokumentationstool finden.
Anforderungsanalyse bildet die Basis
Die Einführung eines Portals oder einer Plattform sollte mit einer Bestandsaufnahme der vorhandenen Dokumentationslandschaft beginnen. Erst wenn bekannt ist, welche Informationen an welchen Stellen gepflegt werden, lässt sich ein sinnvoller zentraler Zugang entwickeln.
Dabei sind insbesondere folgende Fragen zu klären:
- Welche Teams erstellen und nutzen IT-Dokumentationen?
- Welche Dokumentationen und Informationsquellen bestehen bereits?
- Wo werden diese Informationen gespeichert und gepflegt?
- Welche Quelle ist für eine Informationsart führend?
- Wer ist für Inhalt, Aktualität und Freigabe verantwortlich?
- Welche Informationen fehlen, sind redundant oder veraltet?
Vorhandene Dokumente sollten nicht ungeprüft auf eine neue Plattform übertragen werden. Bei umfangreichen oder unübersichtlichen Beständen empfiehlt sich deshalb zunächst eine Konsolidierung der IT-Dokumentation.
Die spätere Struktur sollte sich am Informationsbedarf der Nutzer orientieren. Eine bloße Übernahme vorhandener Ordner, Teams-Bereiche oder Abteilungsstrukturen würde bestehende Silos lediglich in einer neuen Umgebung fortführen.
KI-Nutzung: Informationszugriff über Systemgrenzen hinweg
Ein zentral erschlossener Informationsbestand verbessert die Suche über Team- und Systemgrenzen hinweg. Nutzer müssen nicht mehr wissen, in welcher Ablage ein bestimmtes Dokument gespeichert oder welche Organisationseinheit dafür verantwortlich ist.
KI kann diesen Informationszugriff zusätzlich unterstützen. Mögliche Anwendungen sind die systemübergreifende Suche, Zusammenfassungen sowie Hinweise auf widersprüchliche Informationen oder mögliche Dokumentationslücken.
Voraussetzungen sind eine nachvollziehbare Informationsarchitektur, geeignete Schnittstellen, geregelte Berechtigungen und eine ausreichende Datenqualität. KI ersetzt weder transparente Ablagestrukturen noch fachliche Prüfung und klare Verantwortlichkeiten. Weitere Zusammenhänge behandelt der Wissensbeitrag IT-Dokumentation im digitalen Wandel.
So unterstützt dokuit Sie beim Aufbau eines Dokumentationsportals und einer Dokumentationsplattform
dokuit unterstützt Sie dabei, aus verteilten Dokumentationen und Informationsquellen eine zentrale und nutzbare Einstiegsstruktur zu entwickeln. Ausgangspunkt sind Ihre vorhandene Dokumentationslandschaft, die Arbeitsweisen Ihrer IT-Teams und die bereits eingesetzten Anwendungen.
dokuit unterstützt Sie dabei,
- vorhandene Dokumentationen, Ablagen und Informationsquellen zu analysieren,
- fachliche und technische Anforderungen zu ermitteln,
- die Informationsarchitektur und das Zielbild für das Portal zu entwickeln,
- führende Quellen, Verantwortlichkeiten und Pflegeprozesse festzulegen,
- Portale und Plattformen, beispielsweise mit SharePoint, Confluence oder Wiki-Systemen, zu konzipieren,
- die Bereinigung und Migration zu planen und zu begleiten,
- die Lösung zu pilotieren und einzuführen sowie die Anwender zu unterweisen.
In den vergangenen Jahren hat dokuit für verschiedene Kunden zentrale Dokumentationsstrukturen mit SharePoint, Confluence und anderen Wiki-Systemen konzipiert und eingerichtet.
Lassen Sie uns Ihre Plattform zum zentralen Ankerpunkt der IT machen.
Vernetzte IT-Dokumentation statt zusätzlicher Ablage
Ein moderner zentraler Einstiegspunkt verbindet Dokumente, strukturierte Daten und aktuelle Informationen aus operativen IT-Systemen. Er schafft Transparenz über Ablageorte und Verantwortlichkeiten, macht Zusammenhänge sichtbar und führt Nutzer zu den jeweils führenden Informationsquellen.
Der nachhaltige Nutzen entsteht durch das Zusammenspiel von Informationsarchitektur, geeigneten technischen Werkzeugen, geregelten Verantwortlichkeiten und praktikablen Pflegeprozessen. Die Auswahl der Software ist deshalb nicht der erste, sondern ein nachgelagerter Schritt.
FAQ zum IT-Dokumentationsportal
Was ist ein IT-Dokumentationsportal?
Ein IT-Dokumentationsportal ist ein zentraler Einstiegspunkt in die IT-Dokumentation. Es erschließt Dokumentationsbereiche und Ablageorte, stellt Zusammenhänge dar und verweist auf Dokumente, Daten und führende Informationsquellen.
Was ist der Unterschied zwischen einem Dokumentationsportal und einer Dokumentationsplattform?
Die Begriffe werden in der Praxis nicht einheitlich verwendet. Häufig bezeichnet ein Dokumentationsportal den zentralen Zugang zu Informationen, während eine Dokumentationsplattform zusätzlich Funktionen für die Erstellung, Bearbeitung und Verwaltung von Inhalten bereitstellt. Eine Plattform kann zugleich die technische Grundlage eines Portals bilden.
Müssen alle Informationen zentral gespeichert werden?
Nein. Informationen sollten möglichst in der jeweils geeigneten führenden Quelle gepflegt werden. Das Portal kann Inhalte aus einer CMDB, einem ITSM-System, einem Repository oder anderen Fachanwendungen erschließen und in einen gemeinsamen Zusammenhang einordnen.
Eignen sich SharePoint und Confluence als Dokumentationsplattform?
SharePoint und Confluence können als technische Grundlage einer Dokumentationsplattform und eines zentralen Dokumentationsportals dienen. Ob sie geeignet sind, hängt von den Anforderungen, Informationsarten, Arbeitsweisen, Schnittstellen und bereits vorhandenen Systemen ab.
Aus unserem Blog
Meistens wird die Betriebsdokumentation als lästige Pflicht betrachtet, die man „irgendwie“ erledigen muss. Doch was muss eigentlich dokumentiert werden? Und warum überhaupt? …
Vor kurzem hat die Fachjournalistin Anita Kehrer ein Interview zum Themenfeld IT-Dokumentation mit mir geführt. In dem in der Mitgliederzeitschrift der German …