Zum Hauptinhalt springen

Diataxis Framework

A systematic framework for technical documentation authoring.

Das Diátaxis-Framework zielt darauf ab, die Struktur der technischen Dokumentation zu lösen. Es verfolgt einen systematischen Ansatz, um die Bedürfnisse der Dokumentationsbenutzer in ihrem Interaktionszyklus zu verstehen.

Diátaxis unterscheidet vier Typen der technischen Dokumentation: Tutorials, Anleitungen, technische Referenzen und Erklärungen. Es leitet seine Struktur aus der Beziehung zwischen ihnen ab.

  1. Lernunterlagen - Tutorials (learn-oriented)
  2. Anleitungen - How-to guides (task-oriented)
  3. Referenzen - Technical Reference (information-oriented)
  4. Erläuterungen - Explanation (understanding-oriented)

In Diátaxis entspricht jeder dieser Modi (oder Typen) einem anderen Benutzerbedürfnis, erfüllt einen anderen Zweck und erfordert einen anderen Ansatz für seine Erstellung.

Diataxis-Framework

Abbildung Diataxis-Framework (Quelle = https://diataxis.fr)

Die technische Dokumentation sollte explizit nach diesen vier Typen strukturiert sein. Die Dokumentation soll getrennt voneinander verwaltet werden. Mit anderen Worten: Bei dem, was wir Dokumentation nennen, handelt es sich grundsätzlich nicht um eine Sache, sondern um vier. Das Verständnis der Auswirkungen und der Funktionsweise dieser vier verschiedenen Dinge kann dazu beitragen, die meisten Dokumentationen zu verbessern.

image-20230622085653106

Abbildung (Quelle = https://diataxis.fr/needs/)

Lernunterlagen - Tutorials (learn-oriented)​

Tutorials sind Lektionen, die den Leser durch eine Reihe von Schritten führen, um ein Produkt oder Lösung zu verstehen. Die Tutorials sind lernorientiert.

Ein Tutorial soll einem Einsteiger helfen, grundlegende Kenntnisse im Umgang mit einem Produkt oder einer Lösung zu erlangen, damit er das Produkt anschließend für eigene Zwecke nutzen kann. Ein Tutorial muss dem Lernenden auch zeigen, dass er mit dem Produkt erfolgreich sein kann – indem er etwas sowohl Sinnvolles als auch Erreichbares tut.

Mit anderen Worten, ein Tutorial ist eine Lektion – eine Lektion, bei der es darum geht, zu lernen, um praktisches, nicht theoretisches Wissen.

Tutorial

Der Zweck eines Tutoriums besteht darin, dem Schüler beim Erwerb grundlegender Kompetenzen zu helfen. Nach Abschluss eines Tutorials sollte der Lernende in der Lage sein, den Rest der Dokumentation und das Produkt selbst zu verstehen. Für ein Produkt macht ein Tutorial neue Lernende zu Benutzern. Ein unzureichendes Tutorial kann dazu führen, dass ein Produkt keine neuen Benutzer gewinnt. Ein Tutorial bietet eine Lernerfahrung. Menschen erlernen Fähigkeiten durch praktische Erfahrung. Bei einem Tutorial kommt es darauf an, was der Lernende tut und was er dabei erlebt. Ein Tutorial macht den Lernenden mit der Arbeit vertraut: mit den Werkzeugen, der Sprache, den Prozessen und der Art und Weise, wie sich das, womit er arbeitet, verhält und reagiert und so weiter. Die Aufgabe eines Tutorials besteht darin, einen Benutzer einzuführen. Das Tutorial findet in einem künstlichen Rahmen (Sandbox) statt, einer Lernumgebung, in der so viel wie möglich im Voraus festgelegt wird, um ein erfolgreiches Erlebnis zu gewährleisten. Das Tutorial eliminiert das Unerwartete. Bei einem Tutorial liegt die Verantwortung beim Lehrer. Wenn der Lernende in Schwierigkeiten gerät, ist es die Aufgabe des Lehrers, diese zu beheben. Der Lernende verfügt möglicherweise nicht einmal über ausreichende Kompetenz, um die Fragen zu stellen, die in einem Tutorial beantwortet werden. Das Tutorial geht explizit auf grundlegende Dinge ein – wo man Dinge macht, wo man sie hinlegt und wie man Objekte manipuliert. Das Tutorial vermittelt allgemeine Fähigkeiten und Prinzipien, die später auf eine Vielzahl von Fällen angewendet werden können.

Im Allgemeinen sind Tutorials der schwächste Teil der technischen Dokumentation, der am meisten missverstanden wird und am schwierigsten gut umzusetzen ist. Der reine Arbeitsaufwand für die Erstellung und Pflege von Tutorials ist weitaus höher als der für die anderen Teile der Dokumentation. Schließlich werden Sie feststellen, dass kein anderer Teil Ihrer Dokumentation so stark überarbeitet wird wie Tutorials. Sie müssen eine Referenz oder Anleitung nur dann ändern, wenn sich etwas am Produkt ändert, und selbst dann muss sich normalerweise nur ein Teil davon ändern. Im Falle eines Tutorials kommen Sie möglicherweise zu dem Schluss, dass die gesamte Lektion komplett neu geschrieben werden sollte, weil Sie über eine bessere Möglichkeit nachgedacht haben, dem Schüler ein Lernerlebnis zu bieten. Schließlich sind Tutorials für Lernende gedacht, während Anleitungen für bereits erfahrene Praktiker gedacht sind. Tutorials müssen die Grundlagen (Basiswissen) abdecken, während Anleitungen sich mit realen Komplexitäten befassen müssen, mit denen sich Lernende nicht auseinandersetzen sollten.

Typische Bezeichnungen für Tutorials sind:

  • Schulungsmaterialien:

    • textbasierte Schulungsunterlagen. Diese Art von Tutorial besteht aus geschriebenen Anleitungen oder Artikeln (White-Papers), die erklären, wie man eine bestimmte Aufgabe durchführt oder ein Problem löst. Sie werden oft in Form von Blogposts, Online-Dokumentationen oder Trainingsunterlagen präsentiert.
    • Grafische Tutorials: Grafische Tutorials verwenden Diagramme, Infografiken oder visuelle Darstellungen, um Informationen zu vermitteln. Sie können komplexe Konzepte vereinfachen und visuell ansprechende Darstellungen bieten, die das Verständnis erleichtern.
    • Podcast-Tutorials: Podcast-Tutorials sind Audioaufnahmen, in denen Anleitungen, Tipps und Informationen zu einem bestimmten Thema vermittelt werden. Sie eignen sich gut für den mobilen Einsatz und ermöglichen es Benutzern, Informationen zu konsumieren, während sie unterwegs sind.
    • videobasierte Trainingsunterlagen. Video-Tutorials sind visuelle Anleitungen, die in Form von aufgezeichneten Bildschirmpräsentationen oder Demonstrationen präsentiert werden. Sie können von einem Sprecher begleitet werden, der den Inhalt erklärt und Schritte erläutert. Video-Tutorials sind besonders nützlich, um visuelle Elemente, Prozessabläufe oder komplexe Vorgänge zu veranschaulichen.
    • interaktive Tutorials: Diese Art von Tutorial ermöglicht es Benutzern, aktiv am Lernprozess teilzunehmen, indem sie Aufgaben ausführen oder Simulationen durchführen. Interaktive Tutorials können in Form von Online-Lernplattformen, Quizzen, Gamification-Elementen oder virtuellen Umgebungen vorliegen.
    • Live-Tutorials: Diese Art von Tutorial findet in Echtzeit statt und ermöglicht den direkten Austausch zwischen einem Lehrer oder einem Experten und den Lernenden. Live-Tutorials können als Webinare, Online-Schulungen oder virtuelle Klassenräume durchgeführt werden.
    • In-Person-Tutorials (Präsenzschulung): Diese Tutorials finden in physischen Räumen statt, in denen ein Lehrer oder ein Experte persönlich mit den Lernenden interagiert. Sie können in Form von Workshops, Schulungen oder Seminaren stattfinden.

  • FAQ (häufig gestellte Fragen): Eine Sammlung von Antworten auf häufig gestellte Fragen zu IT-Themen, Produkten oder Dienstleistungen.

Diese sind nur einige Beispiele für die verschiedenen Formen von Tutorials. Die Wahl der geeigneten Form hängt von der Art des zu vermittelnden Inhalts, der Zielgruppe, den verfügbaren Ressourcen und den individuellen Präferenzen ab. Oft werden auch Kombinationen mehrerer Formen verwendet, um eine umfassendere Lernerfahrung zu bieten.

Anleitungen - How-to guides (task-oriented)​

Anleitungen sind Orientierungen, die den Leser durch die Schritte führen, die zur Lösung eines realen Problems erforderlich sind. Anleitungen sind zielorientiert.

Anleitungen können als Rezepte betrachtet werden, als Anleitungen, die den Leser durch die einzelnen Schritte führen, um ein bestimmtes Ziel zu erreichen. Anleitungen sind nicht nur deshalb wichtig, weil Benutzer in der Lage sein müssen, Dinge zu erledigen: Die Liste der Anleitungen in Ihrer Dokumentation hilft dabei, sich ein Bild davon zu machen, was das Produkt tatsächlich leisten kann. Eine umfangreiche Liste mit Anleitungen ist ein ermutigender Hinweis auf die Fähigkeiten eines Produkts. Wenn Anleitungen gut geschrieben sind und die richtigen Themen behandeln, werden Sie wahrscheinlich feststellen, dass Anleitungen die meistgelesenen Abschnitte Ihrer Dokumentation sind.

Anleitungen haben im Gegensatz zu Arbeitsanweisungen keinen anweisenden Charakter, sondern stellen unverbindliche Arbeitshilfen dar, die nicht zwingend einzuhalten sind.

Manchmal ist der Benutzer beim Lernen und manchmal ist der Benutzer bei der Arbeit. Die Dokumentation muss beiden Anforderungen gerecht werden. Ein Tutorial dient den Bedürfnissen des studierenden Benutzers. Ihre Verpflichtung besteht darin, eine erfolgreiche Lernerfahrung zu ermöglichen. Eine Anleitung dient den Bedürfnissen des Benutzers bei der Arbeit. Seine Pflicht besteht darin, dem Benutzer bei der Erfüllung einer Aufgabe zu helfen. Dabei handelt es sich um völlig unterschiedliche Bedürfnisse und Verpflichtungen, und deshalb ist die Unterscheidung zwischen Tutorials und How-to-Guides wichtig: Tutorials sind lernorientiert und How-to-Guides sind aufgabenorientiert.

Anleitungen

Der Zweck einer Anleitung besteht darin, dem bereits kompetenten Benutzer dabei zu helfen, eine bestimmte Aufgabe korrekt auszuführen. Eine Anleitung leitet den Benutzer bei seiner Arbeit. Die Anleitung kann und sollte davon ausgehen, dass Sie mit allen vertraut sind. Eine Anleitung gilt für die reale Welt, in der der Benutzer mit dem umgehen müssen, was Ihn erwartet. Die Anleitung muss sich auf das Unerwartete vorbereiten, den Benutzer auf die Möglichkeit aufmerksam machen und Hinweise zum Umgang damit geben. Eine Anleitung verzweigt sich normalerweise und beschreibt verschiedene Routen zum gleichen Ziel: Wenn dies, dann das. Im Fall von … besteht ein alternativer Ansatz darin, … In einer Anleitung trägt der Benutzer die Verantwortung dafür, selbst in Schwierigkeiten zu geraten und diese zu beheben. Eine Anleitung kann davon ausgehen, dass der Benutzer überhaupt die richtigen Fragen stellt. Eine Anleitung stützt sich darauf als implizites Wissen. Der Benutzer folgt einer Anleitung, um eine bestimmte Aufgabe abzuschließen.

Typische Bezeichnungen für Anleitungen sind:

  1. Schritt-für-Schritt-Anleitungen (Getting Started. First Steps): Diese Art von Anleitung bietet klare und detaillierte Schritte, die nacheinander ausgeführt werden müssen, um eine bestimmte Aufgabe zu erledigen. Sie werden oft verwendet, um Benutzern bei der Durchführung technischer oder praktischer Aufgaben zu helfen.
  2. Installationsanleitungen: Installationsanleitungen erklären, wie man ein Produkt, eine Anwendung oder eine Hardwarekomponente ordnungsgemäß installiert. Sie enthalten oft Informationen zu Systemanforderungen, Installationsverfahren, Konfigurationseinstellungen und möglichen Fehlerbehebungsmaßnahmen. Installationsanleitungen beschreiben wie ein System technisch aufgebaut ist, aus welchen Komponenten es besteht und wie diese Komponenten zusammenwirken und enthält alle relevanten (Detail-) Informationen, um ein System vollständig aufzusetzen und zu konfigurieren. Den Hauptteil bildet deshalb die Detailbeschreibung der einzelnen Schritte während der Installation.
  3. Konfigurationsanleitungen: Konfigurationsanleitungen zeigen, wie man eine Software, ein System oder eine Komponente so einstellt, dass es den spezifischen Anforderungen entspricht. Sie können Informationen zu Einstellungen, Optionen, Parametern und benutzerdefinierten Konfigurationen enthalten.
  4. Wartungsanleitungen: Wartungsanleitungen geben Anweisungen zur ordnungsgemäßen Wartung, Reinigung und Pflege von Produkten oder Systemen. Sie können Informationen zu empfohlenen Wartungsintervallen, Verfahren, Ersatzteilen und möglichen Problemen enthalten.
  5. Programmieranleitungen: Diese Art von Anleitung erklärt die Verwendung einer Programmiersprache, einer API (Application Programming Interface) oder eines Entwicklungsframeworks. Sie können Beispiele, Code-Snippets, Syntaxerklärungen und bewährte Methoden enthalten, um Entwicklern bei der Programmierung zu helfen.
  6. Gebrauchsanleitung - Benutzerhandbücher: Benutzerhandbücher bieten umfassende Informationen über die Verwendung eines Produkts oder einer Anwendung. Sie umfassen oft eine Einführung, Funktionserklärungen, Schritt-für-Schritt-Anleitungen, Troubleshooting-Tipps, häufig gestellte Fragen und Referenzmaterial. Gebrauchsanweisung ist eine Sammlung von Informationen für Benutzer zum sicheren und bestimmungsgemäßen Umgang mit einem Produkt. Der Begriff „Gebrauchsanleitung" entstammt der deutschen Übersetzung der EN 82079-1, die das Erstellen von Gebrauchsanleitungen regelt und wo der Begriff im Original Instructions for use heißt.
  7. Schulungsanleitungen: Schulungsanleitungen werden verwendet, um Schulungen, Schulungsprogramme oder Lernmaterialien zu erstellen. Sie können Lernziele, Lektionen, Übungen, Prüfungen und Evaluationskriterien umfassen.
  8. Sicherheitsanleitungen: Sicherheitsanleitungen geben Anweisungen und Richtlinien zur Gewährleistung der Sicherheit von Produkten, Systemen oder Arbeitsumgebungen. Sie können Informationen zu Risiken, Vorsichtsmaßnahmen, Schutzausrüstung, Sicherheitsprotokollen und Notfallverfahren enthalten.

Diese Liste ist nicht erschöpfend, und je nach Kontext und Anforderungen können weitere Arten von Anleitungen existieren. Das Ziel einer Anleitung ist es, klare und präzise Informationen bereitzustellen, um Benutzern bei der Bewältigung von Aufgaben, der Fehlerbehebung und dem Erwerb von Wissen zu helfen.

Referenzen - Technical Reference (information-oriented)​

Referenzhandbücher sind technische Beschreibungen der Produkte oder Prozesse und ihrer Bedienung. Referenzmaterial ist informationsorientiert.

Referenzen

Der Zweck eines Nachschlagewerks besteht darin, möglichst prägnant und geordnet zu beschreiben. Während sich der Inhalt von Tutorials und Anleitungen an den Bedürfnissen des Benutzers orientiert, richtet sich Referenzmaterial nach dem Produkt, Lösung oder Prozess das es beschreibt. Referenzmaterial sollte streng und auf den Punkt gebracht sein. Man liest kaum Referenzmaterial; man konsultiert es. Referenzmaterial ist wie eine Karte. Auf einer Karte erfahren Sie, was Sie über das Gebiet wissen müssen, ohne dass Sie das Gebiet selbst erkunden müssen. Ein Referenzhandbuch dient demselben Zweck für das Produkt.

Im Fall von Software beschreiben Referenzhandbücher die Software selbst – APIs, Klassen, Funktionen usw. – und deren Verwendung. Ihre Benutzer benötigen Referenzmaterial, weil sie Wahrheit und Gewissheit brauchen – solide Plattformen, auf denen sie bei der Arbeit stehen können. Gute technische Referenzen sind unerlässlich, um Benutzern die Sicherheit zu geben, ihre Arbeit zu erledigen.

Es gibt verschiedene Formen von Referenzen, die als Nachschlagewerke dienen und Informationen zu spezifischen Themen bereitstellen. Hier sind einige gängige Formen und Bezeichnungen von Referenzen:

  1. Glossare - Wörterbücher: Wörterbücher enthalten Definitionen von Wörtern, Begriffen und Fachtermini. Sie bieten auch oft Informationen zur Aussprache, Wortherkunft und verschiedenen Bedeutungen eines Wortes.

  2. Enzyklopädien: Enzyklopädien sind umfassende Nachschlagewerke, die Informationen zu einer Vielzahl von Themen bieten. Sie enthalten Artikel, die detaillierte Erklärungen, Hintergrundinformationen, historische Zusammenhänge und weiterführende Literatur zu einem bestimmten Thema liefern.

  3. Verzeichnisse und Kataloge. Kataloge können Informationen zu

    1. Kunden (Adressverzeichnis) und Mitarbeiter/Ansprechpartner

    2. Produkte (Servicekatalog, Produktkatalog)

    3. Verträgen (Vertragsverzeichnis, SLAs, Vereinbarungen)

    4. Prozesse (Prozesslandkarte)

      usw. umfassen.

  4. Handbücher - Spezifikationen: Handbücher sind Referenzmaterialien, die detaillierte Informationen zu einem Produkt, einer Technologie oder einem System enthalten. Sie bieten strukturierte Informationen zu technischen Steckbriefen, Spezifikationen, Diagramme und Bilder. Es gibt verschiedene Arten von IT-Handbüchern, die in der Informationstechnologie verwendet werden. Hier sind einige gängige Arten von IT-Handbüchern:

    1. IT-Infrastruktur-Handbuch: Dieses Handbuch enthält Informationen und Verfahren für den Aufbau, die Konfiguration und den Betrieb der IT-Infrastruktur einer Organisation. Es kann Informationen über Netzwerke, Server, Datenbanken, Speichersysteme, Sicherheitsmaßnahmen und andere Komponenten der Infrastruktur enthalten. Plattformen und Systemanforderungen, wie SAGA Technische Spezifikationen.
    2. IT-Sicherheitshandbuch: Ein IT-Sicherheitshandbuch enthält Informationen und Verfahren zur Gewährleistung der Informationssicherheit in einer Organisation. Es kann Best Practices zur Verwaltung von Benutzerzugriffen, zum Schutz vor Bedrohungen, zur Durchführung von Sicherheitsaudits, zur Incident Response und anderen Sicherheitsaspekten enthalten. Technologie-Standards wie
    3. IT-Betriebshandbuch: Das IT-Betriebshandbuch beschreibt die operativen Abläufe und Verfahren für den IT-Betrieb einer Organisation. Es kann Informationen zur Überwachung von Systemen, zur Fehlerbehebung, zur Durchführung von Wartungsarbeiten, zur Verwaltung von Änderungen und zur Kommunikation mit Benutzern enthalten.
    4. IT-Anwendungs- oder Software-Handbuch: Diese Art von Handbuch bietet Anleitungen und Informationen zur Installation, Konfiguration und Nutzung bestimmter Anwendungen oder Softwareprodukte. Es kann Anweisungen zur Fehlerbehebung, zur Anpassung von Einstellungen, zur Integration mit anderen Systemen und zur Nutzung von Funktionen enthalten. API-Referenzen
    5. IT-Benutzerhandbuch: Ein Benutzerhandbuch ist ein Handbuch, das speziell für Endbenutzer von IT-Systemen entwickelt wurde. Es enthält Anleitungen und Informationen zur Nutzung von Software, zur Navigation in Benutzeroberflächen, zur Durchführung bestimmter Aufgaben und zur Fehlerbehebung von Problemen, die Benutzer möglicherweise haben.
    6. IT-Entwicklerhandbuch: Ein Entwicklerhandbuch richtet sich an Softwareentwickler und enthält Informationen zur Programmierung, zur Verwendung von APIs (Application Programming Interfaces), zur Implementierung von Funktionen und zur Entwicklung von Anwendungen unter Verwendung bestimmter Programmiersprachen oder Entwicklungsframeworks.
    7. IT-Richtlinienhandbuch: Ein IT-Richtlinienhandbuch enthält eine Sammlung von Richtlinien und Verfahren, die für die IT-Umgebung einer Organisation gelten. Es kann Richtlinien zur IT-Sicherheit, zur Verwendung von Ressourcen, zur Passwortrichtlinie, zur Datenverwaltung und anderen IT-relevanten Richtlinien enthalten.

  5. Gesetzestexte und Normen: Diese Referenzen enthalten Rechtsvorschriften, Fallstudien und Kommentare zu rechtlichen Themen. Sie dienen als Leitfaden für Experten und andere Personen, die fachliche Informationen benötigen.

    Es gibt eine Reihe von Gesetzen und Verordnungen, die sich auf die IT beziehen und die Nutzung, den Schutz und die Verwaltung von Informationen und Technologien regeln. Hier sind einige wichtige Gesetze und Verordnungen im Bereich der IT:

    1. Datenschutz-Grundverordnung (DSGVO): Die DSGVO ist eine EU-Verordnung, die den Schutz personenbezogener Daten regelt. Sie enthält Bestimmungen zur Erhebung, Verarbeitung, Speicherung und Übermittlung personenbezogener Daten sowie zur Rechte der betroffenen Personen. Die DSGVO hat weitreichende Auswirkungen auf Unternehmen, die personenbezogene Daten verarbeiten.
    2. Datenschutzrecht in Österreich
    3. Telekommunikationsgesetz (TKG): Das TKG regelt den Telekommunikationssektor und enthält Bestimmungen zur Übertragung von Daten, Datenschutz in der Telekommunikation, Netzneutralität, Verbraucherrechte und andere Aspekte der Kommunikationstechnologie.
    4. Urheberrechtsgesetz: Das Urheberrechtsgesetz schützt geistiges Eigentum, einschließlich Software, Texte, Bilder und andere kreative Werke. Es regelt die Nutzung, Vervielfältigung, Verbreitung und Rechte von Urhebern und Rechteinhabern.
    5. Mediengesetz (MG): Das MG enthält Bestimmungen für die Nutzung von Telemedien, wie z.B. Websites, Online-Dienste und elektronische Kommunikation. Es umfasst Regelungen zum Datenschutz, Impressumspflichten, Haftung und andere Aspekte der Online-Kommunikation.
    6. Netz- und Informationssystemsicherheitsgesetz - NISG, KRITIS: Das NISG legen Anforderungen für die Sicherheit kritischer Infrastrukturen und den Schutz vor Cyberangriffen fest. Sie betreffen Bereiche wie Energie, Verkehr, Gesundheit und Finanzen und fordern Maßnahmen zur Erkennung, Verhinderung und Reaktion auf IT-Sicherheitsvorfälle.
    7. E-Commerce-Gesetz: Das E-Commerce-Gesetz regelt den elektronischen Geschäftsverkehr, einschließlich Online-Verträgen, elektronischer Signatur, Haftung von Online-Dienstleistern und Verbraucherrechten im elektronischen Handel.

    Für die IT gibt es eine Vielzahl von Normen, die entwickelt wurden, um bewährte Verfahren, Standards und Richtlinien in verschiedenen Bereichen der Informationstechnologie zu etablieren. Hier sind einige gängige Normen für die IT:

    1. ISO/IEC 27001: Diese Norm legt Anforderungen an ein Informationssicherheitsmanagementsystem (ISMS) fest. Sie umfasst den Aufbau, die Implementierung, Überwachung und kontinuierliche Verbesserung von Sicherheitsmaßnahmen, um die Vertraulichkeit, Integrität und Verfügbarkeit von Informationen in einer Organisation zu gewährleisten.
    2. ISO/IEC 27002: Diese Norm bietet Richtlinien und Best Practices für die Umsetzung von Sicherheitskontrollen im Rahmen eines ISMS. Sie umfasst Bereiche wie die Organisation der Informationssicherheit, Zugriffskontrolle, Verschlüsselung, Incident Management, Sicherheitsbewusstsein und Schulungen sowie die Sicherung von Netzwerken und Systemen.
    3. ISO/IEC 20000: Diese Norm legt Anforderungen an ein IT-Service-Management-System fest, um die Bereitstellung qualitativ hochwertiger IT-Services sicherzustellen. Sie definiert Prozesse und Best Practices für das Service-Level-Management, das Incident- und Problem-Management, das Change- und Release-Management und andere Aspekte des IT-Service-Managements.
    4. ISO/IEC 9001: Obwohl sie nicht speziell für die IT entwickelt wurde, ist diese Norm eine internationale Norm für Qualitätsmanagement. Sie kann auch auf die IT angewendet werden, um sicherzustellen, dass die Produkte und Dienstleistungen den Anforderungen der Kunden entsprechen und eine kontinuierliche Verbesserung gewährleistet wird.
    5. IEEE-Standards (Institute of Electrical and Electronics Engineers): Das IEEE entwickelt eine Vielzahl von technischen Standards für die IT, darunter Standards für Netzwerke, drahtlose Kommunikation, Softwareentwicklung, Datenbanken und viele andere Bereiche.
    6. EN 50600: Diese europäische Norm legt Anforderungen für das Design, den Betrieb und die Wartung von Rechenzentren fest. Sie umfasst Aspekte wie Standortwahl, Energieversorgung, Klimatisierung, Brandschutz, physische Sicherheit und Datensicherheit.
    7. BSI-Standard 100-4: Der BSI-Standard 100-4 ist ein Standard für die Verfügbarkeit von IT-Diensten und -Infrastruktur, insbesondere des Notfallmanagements Er enthält Richtlinien und Empfehlungen für das Management von Rechenzentren und deren Dienstleistungen, einschließlich Design, Betrieb, Überwachung und kontinuierlicher Verbesserung.

  6. Richtlinien und Compliance-Vorgaben: In Unternehmen gibt es verschiedene Arten von Richtlinien, die dazu dienen, Standards, Verfahren und Verhaltensregeln festzulegen, um die Sicherheit, Effizienz und Einhaltung von Best Practices zu gewährleisten. Hier sind einige gängige Arten von IT-Richtlinien:

    1. IT-Sicherheitsrichtlinien: Sicherheitsrichtlinien legen Maßnahmen und Verfahren fest, um die Informationssicherheit zu gewährleisten. Sie umfassen Bestimmungen zum Schutz von Daten, Netzwerken, Systemen und Anwendungen vor unbefugtem Zugriff, Viren, Malware und anderen Bedrohungen. Sicherheitsrichtlinien können auch Richtlinien für Passwortrichtlinien, Zugriffssteuerung, Datensicherung, Incident Response und Compliance umfassen.
    2. IT-Datenschutzrichtlinien: Datenschutzrichtlinien legen fest, wie personenbezogene Daten gesammelt, verwendet, gespeichert und geschützt werden sollen. Sie regeln den Umgang mit sensiblen Informationen, die Einhaltung von Datenschutzgesetzen und -vorschriften sowie den Schutz der Privatsphäre von Benutzern und Kunden. Datenschutzrichtlinien können auch Bestimmungen zur Datenfreigabe, Datensicherheit und Informationsmanagement umfassen.
    3. IT-Nutzungsrichtlinien: Nutzungsrichtlinien definieren die akzeptable Nutzung von IT-Ressourcen wie Computern, Netzwerken, E-Mails, Internet und Software in einer Organisation. Sie legen fest, welche Aktivitäten erlaubt oder untersagt sind, um Missbrauch, Produktivitätsverluste oder rechtliche Probleme zu vermeiden. Nutzungsrichtlinien können Richtlinien für Social Media, E-Mail-Etikette, Internetzugriff, Softwareinstallation und Verhaltensstandards enthalten.
    4. Bring Your Own Device (BYOD) IT-Richtlinien: BYOD-Richtlinien regeln den Einsatz persönlicher Geräte wie Smartphones, Tablets oder Laptops in einer Organisation. Sie legen die Anforderungen, Einschränkungen und Sicherheitsmaßnahmen fest, um BYOD sicher und effektiv zu ermöglichen. BYOD-Richtlinien können Richtlinien für Geräteregistrierung, Datensicherheit, Remote-Zugriff und Verantwortlichkeiten von Mitarbeitern und Arbeitgebern umfassen.
    5. IT-Change-Management-Richtlinien: Change-Management-Richtlinien legen Verfahren fest, um Änderungen an IT-Systemen, Anwendungen oder Infrastrukturen zu planen, zu genehmigen und durchzuführen. Sie regeln den Prozess der Änderungsbewertung, -genehmigung, -dokumentation und -kommunikation, um Ausfallzeiten, Fehler und negative Auswirkungen auf die Geschäftsprozesse zu minimieren.
    6. IT-Beschaffungsrichtlinien: IT-Beschaffungsrichtlinien legen Regeln und Verfahren für den Kauf, die Beschaffung und den Einsatz von IT-Hardware, -Software und -Dienstleistungen fest. Sie können Anforderungen an die Budgetierung, Anbieterauswahl, Lizenzierung, Vertragsverhandlungen und Bewertung von IT-Lösungen umfassen.

  7. Best Practices und Fachlexika: Fachlexika sind spezialisierte Nachschlagewerke, die Informationen zu bestimmten Fachgebieten, Disziplinen oder Branchen liefern. Sie enthalten Fachbegriffe, Konzepte, Theorien, Methoden und Informationen zur aktuellen Forschung.

    1. ITIL (Information Technology Infrastructure Library): ITIL ist kein Normdokument im eigentlichen Sinne, sondern eine Sammlung bewährter Verfahren für das IT-Service-Management. ITIL bietet eine umfassende Sammlung von Konzepten, Prozessen und Richtlinien zur effektiven Planung, Bereitstellung, Unterstützung und Verbesserung von IT-Services.
    2. COBIT (Control Objectives for Information and Related Technologies): COBIT ist ein Framework für die Governance und das Management von IT-Prozessen. Es bietet Kontrollziele, Prozessbeschreibungen, Mappings zu Standards und Best Practices sowie Leitlinien zur Ausrichtung von IT-Strategie, -Betrieb und -Risikomanagement auf die Geschäftsziele einer Organisation.
    3. TOGAF. TOGAF steht für "The Open Group Architecture Framework" und ist ein Framework für das Enterprise Architecture Management (EAM). Es ist eine weltweit anerkannte Methode und ein Standard für die Entwicklung, Pflege und Transformation von Unternehmensarchitekturen.
    4. SAGA SAGA ist ein Abkürzung von „Standards und Architekturen für eGovernment-Anwendungen“.

  8. Berichte, Auswertungen und Nachweise

Diese sind nur einige Beispiele für verschiedene Formen von Referenzen. Sie werden verwendet, um schnellen Zugriff auf Informationen zu ermöglichen, Wissen zu erweitern, Informationen zu überprüfen und als Unterstützung für Fachleute und Interessierte zu dienen.

Erläuterungen - Explanation (understanding-oriented)​

Erklärung ist eine Diskussion, die ein bestimmtes Thema klärt und beleuchtet. Die Erklärung ist verständnisorientiert.

Erläuterungen, Kommentare

Erklärungen verdeutlichen, vertiefen und erweitern das Verständnis des Lesers für ein Thema.

Es geht nicht darum, was der Benutzer tun könnte, wie etwa Tutorials und Anleitungen. Es handelt sich nicht um eine Nahaufnahme wie bei Referenzmaterial. Es handelt sich um eine Dokumentation, die sich einem Thema aus einer höheren Perspektive und aus verschiedenen Blickwinkeln nähert. Dadurch wird aus Erklärungen eine Diskussion, eine entspanntere und freiere Möglichkeit, über etwas nachzudenken. Eine Erklärung fügt die Dinge zusammen. Es ist eine Dokumentation, deren Lektüre sinnvoll ist, wenn man sich nicht am Produkt selbst befindet.

Im Gegensatz zu den anderen drei Formen der Dokumentation haben Erklärungen keinen direkten Einfluss auf die Praxis oder Arbeit eines Benutzers. Dies bedeutet, dass es manchmal als weniger wichtig angesehen wird. Das ist ein Fehler; Es ist vielleicht weniger dringend als die anderen drei, aber es ist nicht weniger wichtig. Kein Praktiker eines Handwerks kann es sich leisten, kein Verständnis für dieses Handwerk zu haben und benötigt das erklärende Material, das dabei hilft, es zusammenzufügen. Verständnis entsteht nicht einfach durch Erklärung, sondern es ist eine Erklärung erforderlich, um das Netz zu bilden, das dabei hilft, alles zusammenzuhalten.

Es kommt ziemlich selten vor, dass Erklärungen in der Dokumentation einen eigenen Abschnitt erhalten, und der Gedanke, dass Dinge erklärt werden müssen, wird oft nur schwach zum Ausdruck gebracht. Stattdessen sind die Erläuterungen in der Regel in kleinen Paketen auf andere Abschnitte verstreut.

Hier sind einige gängige Formen und Bezeichnungen von Erläuterungen:

  • Insights und Analysen
  • Diskussionsforum und Chats
  • Themenleitfäden
  • Blogs