Hinzufügen und Anzeigen von Dokumentation in Echtzeit auf Seiten. Alternative Namen für dieses Modul könnten „Kontextbezogene Dokumentation“ oder „Echtzeitdokumentation“ sein, aber inline hat einen schönen Klang und entspricht der Art und Weise, wie Dokumentation im Code platziert wird.
Dieses Modul erstellt einen Inhaltstyp „Inline-Dokumentation“ und fügt unten rechts auf jeder Seite eine runde blaue Schaltfläche hinzu. Diese Schaltfläche schaltet ein Bedienfeld mit einer Liste der Inline-Dokumentationsknoten um.
Dokumentation ist der Schlüssel für eine einfache Wartung oder Projektübertragung. Niemand schreibt jedoch gerne Dokumentation und niemand liest gerne Dokumentation.
Die Inline-Dokumentation versucht, das Schreiben von Dokumentation zu vereinfachen, indem der Benutzer kurze Dokumentationsbits direkt auf der Webseite hinzufügen kann, wo der Leser sie benötigt. Dies verringert den Bedarf an umfangreichen Wiki-Seiten und Word-Dokumenten.
Navigieren Sie zu der betreffenden Seite, klicken Sie auf die Schaltfläche ‚Dokumentation hinzufügen‘ und beginnen Sie mit dem Schreiben einiger Dokumente. Es wird empfohlen, diese Dokumente kurz und einfach zu halten, Sie können einer Seite beliebig viele hinzufügen und sie sogar an DOM-Elemente anhängen.