Über diese Dokumentation
🟥 Die Leadtime-Dokumentation bietet eine benutzerfreundliche Oberfläche mit Suchfunktion und strukturierten Inhalten in vier Textarten zur effizienten Informationssuche
Dieser Text ist eine Referenz. Welche Textarten gibt es?
Benutzeroberfläche der Dokumentation
Die Benutzeroberfläche der Leadtime-Dokumentation wurde entwickelt, um Nutzern eine einfache und intuitive Navigation zu ermöglichen. Sie besteht aus sieben Hauptkomponenten, die unten detailliert beschrieben werden.
1. Suchleiste
Die Suchleiste befindet sich prominent am oberen Rand der Seite.
Hier können Nutzer gezielt nach Stichwörtern suchen, um schnell relevante Artikel zu finden.
Zusätzlich besteht die Möglichkeit, den LeadtimeGPT-Chatbot direkt anzusprechen, um offene Fragen zur Anwendung zu klären.
2. Inhaltsverzeichnis
Auf der linken Seite wird ein navigierbares Inhaltsverzeichnis angezeigt.
Struktur:
- Bereiche: Als Hauptüberschriften dargestellt.
- Kapitel: Untergeordnete Kategorien, die durch Klicken ausklappbar sind.
- Artikel: Direkt anwählbare Inhalte innerhalb der Kapitel.
Das Inhaltsverzeichnis ermöglicht eine schnelle Navigation durch die gesamte Dokumentation.
3. Artikel-Inhaltsverzeichnis
Sobald ein Artikel geöffnet wird, erscheint in der rechten Spalte ein Inhaltsverzeichnis für den Artikel. Dieses basiert auf den Überschriften des Artikels. Nutzer können durch Klicken direkt zu einem bestimmten Abschnitt innerhalb des Artikels springen.
4. Artikelbewertung
Am Ende jedes Artikels können Nutzer eine Bewertung abgeben:
- Positiv (🙂): Der Artikel war hilfreich.
- Neutral (😐): Der Artikel war in Ordnung, aber nicht perfekt.
- Negativ (😞): Die gesuchte Information war nicht vorhanden oder unklar.
Die Bewertungen werden im Backend analysiert, um Texte gezielt zu überarbeiten und zu verbessern.
5. Artikel-Navigation
Unterhalb des Artikels gibt es Schaltflächen, um schnell zum nächsten oder vorherigen Artikel zu springen.
Diese Funktion erleichtert das fortlaufende Lesen ohne Rücksprung ins Inhaltsverzeichnis.
6. Dark Modus
Nutzer können zwischen einem hellen und dunklen Layout wechseln. Diese Einstellung verbessert die Lesbarkeit je nach persönlicher Präferenz und Lichtverhältnissen.
7. Support-Button
Wenn Nutzer keine Lösung finden, steht ein "Kontaktieren Sie uns"-Button zur Verfügung. Ein Klick auf diesen Button öffnet einen direkten Chat mit einem Support-Mitarbeiter, um individuelle Fragen zu klären.
Suchfunktion und LeadtimeGPT
Die Dokumentation von Leadtime bietet zwei Möglichkeiten, um Informationen effizient zu suchen: eine klassische Begriffssuche und die Nutzung von LeadtimeGPT, einem KI-gestützten Chatbot.
Klassische Begriffssuche
Funktion: Die klassische Suche funktioniert wie eine Suchmaschine und ist ideal, um gezielt nach Begriffen oder Themen zu suchen.
Bedienung:
- Im Kopfbereich der Dokumentation befindet sich eine Suchleiste.
- Alternativ kann die Suche schnell mit der Tastenkombination Cmd + K (oder Strg + K auf Windows) aktiviert werden.
- Geben Sie einen Begriff, z. B. "Ticket", ein.
- Nach kurzer Zeit werden passende Artikelvorschläge angezeigt, die den eingegebenen Begriff enthalten oder thematisch passend sind.
LeadtimeGPT
LeadtimeGPT ist ein KI-gestützter Chatbot, der auf die Inhalte der Dokumentation trainiert wurde. Er ermöglicht es, offene Fragen zu stellen und Antworten zu erhalten, die auf den Texten der Dokumentation basieren.
Bedienung:
- Geben Sie eine Frage in die Suchleiste ein, z. B. "Wie lege ich ein Ticket an?".
- Klicken Sie auf den Button "Fragen Sie LeadtimeGPT", der als Vorschlag erscheint.
- Ein Chatfenster öffnet sich in der rechten Seitenleiste.
- Stellen Sie Ihre Frage oder folgen Sie den Vorschlägen des Bots. Die Antwort wird direkt im Chat angezeigt.
Vorteile:
- Geeignet für komplexe, offene Fragen.
- Antworten sind kontextbezogen und liefern oft konkrete Schritt-für-Schritt-Anleitungen.
- Keine Notwendigkeit, selbst durch Artikel zu navigieren.
Aufbau der Dokumentation
Die Dokumentation von Leadtime ist klar strukturiert, um eine intuitive Navigation und effiziente Informationssuche zu ermöglichen. Sie ist in zehn Hauptbereiche gegliedert, die jeweils in Kapiteln unterteilt sind, die nach den vier definierten Textarten organisiert sind: Themenübersicht, Hintergrund, Referenz, und Anleitung. Die Kapitel wiederum enthalten spezifische Artikel, .
Jeder Artikel behandelt ein spezifisches Thema innerhalb des Kapitels. Die Artikel sind so gestaltet, dass sie klar und präzise Informationen zu einem konkreten Aspekt des Kapitels liefern. Sie folgen der Struktur und Textart, die für den jeweiligen Kontext am besten geeignet ist.
Dieses hierarchische System sorgt für Übersichtlichkeit und erleichtert die Nutzung der Dokumentation.
Hauptbereiche der Dokumentation
Hauptbereich | Beschreibung |
Einstieg in Leadtime | Einführung in das System, grundlegende Funktionen und Onboarding-Prozess. |
Ihr Workspace | Konfiguration der persönlichen Arbeitsumgebung und Anpassung der Installation. |
Mitarbeiterverwaltung | Abbildung und Verwaltung von Mitarbeitern und Teams im System. |
Kundenverwaltung | Verwaltung von Organisationen wie Kunden, Partnern und Leads. |
Aufgabenmanagement | Nutzung des Ticket-Systems für Aufgabenstrukturierung und -priorisierung. |
Zeiterfassung | Erfassung und Auswertung der Arbeitszeit mit Zeitberichten. |
Agile Planungstools | Planung von Arbeit, Ressourcen und Kapazitäten mithilfe grafischer Werkzeuge. |
Projektmanagement | Verwaltung von Projekten und Anforderungen. |
Angebote und Rechnungen | Erstellung von Angeboten, Rechnungen und Mahnungen sowie Unterstützung des Forderungsmanagements. |
Auswertungen | Grafische Echtzeitauswertungen und Berichte zur Analyse von Performance und KPIs. |
Textarten in der Dokumentation
Die Dokumentation ist in vier verschiedene Textarten unterteilt, die jeweils einem spezifischen Zweck dienen. Jede Textart ist visuell durch ein farbiges Icon und ein Callout zu Beginn des Textes gekennzeichnet, um schnell zu erkennen, welche Art von Information geboten wird.
Textart | Icon | Funktion |
Themenübersicht | 🟨 | Orientierung und Linksammlung zu thematisch verbundenen Artikeln. |
Hintergrund | 🟦 | Erklärung der Motivation und des Kontexts hinter Funktionen und Lösungen. |
Referenz | 🟥 | Technische Beschreibung und vollständige Dokumentation der Softwareelemente. |
Anleitung | 🟩 | Praxisorientierte Schritt-für-Schritt-Erklärungen zur Umsetzung spezifischer Aufgaben. |
🟨 Themenübersicht
Themenübersichten sind Sammlungen von Links zu thematisch zusammenhängenden Artikeln innerhalb der Dokumentation. Sie bieten Nutzern eine strukturierte Orientierungshilfe und ermöglichen es, relevante Informationen schnell zu finden.
Zweck: Die Themenübersicht dient dazu, Nutzern einen Einstieg in einen Bereich zu erleichtern und komplexe Themen übersichtlich darzustellen.
Beispiele für Inhalte:
- Listen von Anleitungen, die ein spezifisches Feature abdecken.
- Links zu Kontext- oder Referenzartikeln, die sich mit verwandten Themen beschäftigen.
🟦 Hintergrund
Hintergrundtexte erklären die Warum-Frage hinter den Features und Funktionen der Software. Sie beleuchten die Probleme, die durch die Software gelöst werden sollen, und vermitteln die konzeptionellen Grundlagen.
Zweck: Diese Texte schaffen ein tieferes Verständnis für die Software und ihre Philosophie, indem sie den Nutzen der Funktionen im größeren Zusammenhang darstellen.
Beispiele für Inhalte:
- Erklärung, warum ein bestimmtes Feature entwickelt wurde.
- Szenarien, in denen das Feature einen klaren Mehrwert schafft.
- Verknüpfung zwischen geschäftlichen Herausforderungen und der Lösung durch die Software.
🟥 Referenz
Referenztexte sind detaillierte Beschreibungen aller Elemente der Anwendung. Sie erklären, was in der Software vorhanden ist, und geben präzise Informationen zu Funktionen, Feldern und Optionen.
Zweck: Die Referenz bietet Nutzern eine vollständige, technische Dokumentation der Software. Sie dient als Nachschlagewerk für die Details einzelner Bestandteile der Anwendung.
Beispiele für Inhalte:
- Beschreibung aller Felder in einem Formular und deren Zweck.
- Erklärung von Funktionen, Buttons und Menüs.
- Auflistung von Einstellungen und deren Auswirkungen.
🟩 Anleitung
Anleitungen bieten Schritt-für-Schritt-Erklärungen, wie bestimmte Aktionen in der Software ausgeführt werden können. Sie sind praxisorientiert und zeigen den genauen Ablauf.
Zweck: Diese Texte helfen Nutzern, Aufgaben effizient und korrekt umzusetzen. Sie sind besonders für neue Nutzer oder für die Einführung neuer Features hilfreich.
Beispiele für Inhalte:
- Wie man ein neues Projekt erstellt.
- Schritt-für-Schritt-Anleitung zum Exportieren von Daten.
- Anleitung zur Konfiguration von Benutzereinstellungen.