Adsata-Dokumentationssystem
Die Dokumentation von Adsata wird mit Docusaurus erstellt. Docusaurus ermöglicht es uns, eine Website für unsere Software und die dazugehörige Dokumentation zu erstellen.
Wir verwenden Typen für unseren Dokumentationsinhalt. Wir definieren zwei primäre Typen und zwei sekundäre Typen:
Primär:
Sekundär:
Im Allgemeinen enthält jeder Ordner in unserem Docset die Dokumentation für diese 4 Typen. Unsere Ordnerstruktur:
Erste Schritte/
Start 1
Start 2
Aufgaben/
Aufgabe 1
Konzepte/
Konzept 1
Konzept 2
Konzept 3
Leitfäden/
Leitfaden 1
Leitfaden 2
Dokumentationsbeziehungen
Jede Konzeptseite verweist auf mindestens eine Aufgabenseite. Zum Beispiel verweist ein Konzept mit dem Titel Kalibrierung auf eine Aufgabe Kalibrierung der Eyetracking-Software.
Wir verknüpfen jedoch auch Dokumentationsarten mit verschiedenen Seiten. Dies ist wichtig, weil es uns hilft, die Software Seite für Seite und Aufgabe für Aufgabe zu dokumentieren, und es hilft uns auch, neue Konzepte einzuführen.
Um Aufgaben und Konzepte mit Seiten zu verknüpfen, verwenden wir Tags.
Guides und Get Started sind mit keinem anderen Typ verbunden und benötigen auch keine Tags.
Erste Schritte
Eine Seite "Erste Schritte" ist eine Reihe von Schritten, die einem Benutzer helfen, zu verstehen, wie man die Dokumentation benutzt und/oder Informationen darüber, wo man mit den Adsata-Funktionen anfangen kann.
Aufgaben
Eine Aufgabe gibt Anweisungen, wie ein Vorgang in Adsata durchzuführen ist. Die Prozeduren sollten klar und prägnant sein. Die Aufgaben werden nach dem Zufallsprinzip sortiert.
Wenn es mehrere Aufgaben auf einer Seite gibt, die die gleichen Voraussetzungen haben, verwenden wir den Titel Voraussetzungen und verlinken darauf.
Konzepte
Ein Konzept stellt eine einzelne Funktion oder ein Konzept vor.
Ein Konzept gibt Antworten auf die Fragen:
- Was ist das?
- Warum sollte ich es verwenden?
Wir versuchen, Konzepte so zu erklären, wie jemand ein Konzept kennenlernen möchte, der noch nie davon gehört hat.
Konzepte sagen nicht, wie man etwas macht. Sie sagen, was etwas ist.
Jedes Konzept bezieht sich nur auf ein einziges Konzept.
Leitfäden
Ein Leitfaden ist eine durchgängige Darstellung eines komplexen Arbeitsablaufs oder Szenarios. Im Allgemeinen werden Leitfäden verwendet, wenn:
- Der Arbeitsablauf erfordert eine Reihe von aufeinanderfolgenden Schritten, wobei jeder Schritt aus Teilschritten besteht.
- Die Schritte decken eine Vielzahl von Adsata-Funktionen oder Drittanbieter-Tools ab.
Leitfäden sind Lernhilfen, die unsere Kerndokumentation ergänzen. Sie führen keine neuen Funktionen ein. Übersetzt mit www.DeepL.com/Translator (kostenlose Version)