Zum Inhalt

Leitfaden

Dieser Leitfaden stellt Vorgaben für den Umgang zum Schreiben der einzelnen Dokumentation zur Verfügung.

Die möglichen Auszeichnungen sind unter der Überschrift Formate zusammengefasst.

Im Bereich Erweiterungen finden sich zum Thema UML, Codebeispielen, der API-Dokumentation, ASCII-Zeichen, Hinweisboxen und Metadaten nützliche informationen.

Gliederung

Dieses Portal fasst alle öffentlichen Dokumentationen der schukai GmbH zusammen. Auf der Startseite dieses Portals steht eine Suche über alle Dokumente zur Verfügung.

Die Gesamtdokumentation gliedert sich in verschiedene Dokumentationen zu den einzelnen Modulen und Anwendungen.

Es wird zwischen Anwendungs-/Entwicklungsdokumentation und der API-Dokumentation unterschieden.

Die Anwendungs-/Entwicklungsdokumentation beschreibt verschiedene Aspekte und stellt Informationen zur Verfügung. Jede einzelne Dokumentation besteht aus verschiedenen Seiten. Der Aufbau einer Seiten hängt vom Kontext ab.

Die API-Dokumentation ist eine aus dem Quelltext erzeugte Dokumentation der Klassen, Funktionen und Dateien.

Die einzelnen Dokumente sind auf der (Übersichts-Seite)[../uebersicht.md] zusammengestellt.