Dokumentation, Tutorials und Patchnotes — Drei Wege zur Antwort – in Leichter Sprache
Hinweis: Dieser Text ist in Leichter Sprache. Diesen Artikel in Alltags-Sprache lesen.
Was sind Dokumentation, Tutorials und Patchnotes?
Auf der KaoBa-Plattform gibt es drei Arten von Hilfe-Texten.
Jede Art beantwortet eine andere Frage.
- Dokumentation: Erklärt, was eine Funktion tut.
- Tutorial: Zeigt dir Schritt für Schritt, wie du etwas machst.
- Patchnote: Sagt dir, was sich geändert hat.
Alle Texte gibt es in Standard-Sprache und in Leichter Sprache.
Was ist Dokumentation?
Dokumentation erklärt die Funktionen von KaoBa.
Zum Beispiel: Wie funktioniert die Stellen-Suche?
Oder: Wie verwalte ich meine Bewerbungen?
In jedem Artikel steht:
- Was macht die Funktion?
- Wo findest du die Funktion?
- Wie benutzt du die Funktion?
- Was musst du beachten?
Dokumentation hilft dir, eine Funktion zu verstehen.
Du brauchst keine Anmeldung, um die Dokumentation zu lesen.
Was ist ein Tutorial?
Ein Tutorial ist eine Schritt-für-Schritt-Anleitung.
Am Ende hast du etwas Bestimmtes geschafft.
Zum Beispiel: Dein erstes Bewerbungs-Profil erstellt.
Jedes Tutorial hat ein Lern-Ziel.
Das Lern-Ziel sagt dir: Das kannst du am Ende.
Dann kommen die einzelnen Schritte.
Jeder Schritt sagt dir:
- Was du tun sollst.
- Wo du klicken musst.
- Was dann passiert.
- Woran du erkennst, dass es geklappt hat.
Tutorials haben einen Schwierigkeits-Grad.
Es gibt: Einsteiger, Fortgeschrittene und Experten.
Tutorials zeigen auch, wie lange sie ungefähr dauern.
Was ist eine Patchnote?
Eine Patchnote sagt dir: Das hat sich geändert.
Zum Beispiel: Es gibt eine neue Funktion.
Oder: Eine Funktion funktioniert jetzt besser.
Oder: Ein Fehler wurde behoben.
Patchnotes stehen nicht auf der Dokumentations-Seite.
Du bekommst sie als Benachrichtigung.
Du bekommst nur Patchnotes, die dich betreffen.
Zum Beispiel: Wenn du die Karriere-Plattform nutzt.
Dann bekommst du nur Änderungen für die Karriere-Plattform.
Patchnotes sind kurz.
Sie geben dir einen schnellen Überblick.
Wenn du mehr wissen möchtest, gibt es einen Link zur Dokumentation.
Was ist Leichte Sprache?
Leichte Sprache verwendet einfache Wörter.
Die Sätze sind kurz.
Es gibt nur einen Gedanken pro Satz.
So ist der Text für alle verständlich.
Leichte Sprache ist kein kurzer Text.
Es ist ein eigener Text.
Er wird extra geschrieben.
Du kannst Leichte Sprache ein-schalten.
Auf der Website: Es gibt einen Schalter oben im Artikel.
Auf der Karriere-Plattform: Klicke auf das Barriere-Freiheit-Symbol am Seiten-Rand.
Dort findest du die Einstellung für Leichte Sprache.
Wo findest du Dokumentation und Tutorials?
Öffne die KaoBa-Website.
Klicke oben auf Ressourcen.
Dann klicke auf Dokumentation.
Du siehst eine Liste mit Artikeln.
Links gibt es Kategorien.
Klicke auf eine Kategorie.
Dann siehst du die Artikel in dieser Kategorie.
Oben gibt es eine Suche.
Tippe ein Wort ein.
Dann werden passende Artikel angezeigt.
Du kannst auch filtern:
- Nach Typ: Dokumentation oder Tutorial.
- Nach Plattform: Karriere, Business oder Allgemein.
Wie liest du einen Artikel?
Klicke auf Lesen bei einem Artikel.
Der Artikel öffnet sich.
Oben steht der Titel und das Datum.
Bei Tutorials steht auch der Schwierigkeits-Grad.
Rechts gibt es ein Inhalts-Verzeichnis.
Klicke auf eine Überschrift im Verzeichnis.
Du springst direkt zu diesem Teil.
Am Ende gibt es Knöpfe für den nächsten und vorherigen Artikel.
Wo findest du empfohlene Artikel?
Auf der Karriere-Plattform gibt es empfohlene Artikel.
Melde dich an und öffne die Übersicht.
Links siehst du deine Reise mit Schritten.
Klicke auf einen Schritt.
Unter Relevante Artikel werden passende Texte angezeigt.
Diese Texte passen zu dem, was du gerade tust.
Klicke auf einen Artikel.
Er öffnet sich in einem neuen Fenster auf der Website.
Wichtige Hinweise
- Du brauchst keine Anmeldung für Dokumentation und Tutorials.
- Patchnotes bekommst du als Benachrichtigung.
- Leichte Sprache ist ein eigener Text. Nicht nur eine Kurz-Fassung.
- Die Suche funktioniert auch mit Teilen von Wörtern.
- Tutorials zeigen die Dauer zum Durchführen. Nicht nur zum Lesen.
- Wenn du nichts findest: Ändere den Such-Begriff. Oder entferne einen Filter.
