Dokumentationssystem: Unterschied zwischen den Versionen

Version vom 17. April 2025, 13:11 Uhr

PDF-Ausschluss - Start

Tour 3 Dokumentationssystem weiter: Kundendokumentation

PDF-Ausschluss - Ende

Ein Dokumentationssystem unterstützt das Unternehmen bei der Archivierung von Dokumenten. Dokumentationssysteme kommen in der Projektdokumentation, bei technischen Dokumentationen oder in der IT-Dokumentation zum Einsatz.

Dokumentation im Wiki

Eine Besonderheit eines Wiki-basierten Dokumentationssystems ist, dass Entwicklung und fortlaufende Dokumentation von Wissen in einem System zusammengeführt wird. Die einzelnen Artikelseiten sind „lebende Dokumente“. Dazu kommt:

Mitarbeit ohne Vorkenntnisse: Mit dem visuellen Editor lassen sich schnell Bilder per "Drag & Drop" in einen Artikel einbinden.
Office Dokumente: Dokumente in anderen Formaten (Office, PDF etc.) können ebenso schnell an einen Artikel geheftet werden.
Anlegen von strukturierten Daten: Die Dokumente lassen sich mit strukturierten Daten (Attributen) anreichern, die innerhalb und außerhalb des Systems verarbeitet werden können. (Semantic MediaWiki)
Leicht nachvollziehbare Versionierung: Die Rückverfolgbarkeit und Reproduzierbarkeit aller Änderungen in der Dokumentation ermöglichen das Management von gesetzlich geforderten Informationen und sichern gegebenenfalls haftungsrechtlich ab.

Beispielseiten

Kundendokumentation

Schritt-für-Schritt Anleitung

Screenshot zur Anleitung Kaffee kochen

IT-Dokumentation

Betriebsanweisung

Mathematische Formeln

Kategorisierte Produktbilder

PDF-Ausschluss - Start

Tour 3 Dokumentationssystem weiter: Kundendokumentation

PDF-Ausschluss - Ende

@@ Zeile 34: / Zeile 34: @@
 {{Portal flex/Box
 |heading=[[IT-Dokumentation]]
-|content=<div class="screenshot">[[Datei:screenshot-js.png{{!}}alt=Screenshot JavaScript{{!}}center{{!}}450x450px{{!}}link=IT-Dokumentation]]</div>
+|content=<div class="screenshot">[[File:screenshot-js.png{{!}}alt=Screenshot JavaScript{{!}}center{{!}}450x450px{{!}}link=IT-Dokumentation]]</div>
 }}
 {{Portal flex/Box
@@ Zeile 42: / Zeile 42: @@
 {{Portal flex/Box
 |heading=[[Impulsantwort|Mathematische Formeln]]
-|content=<div class="screenshot">[[Datei:math.png{{!}}alt=mathematische Formeln{{!}}center{{!}}450x450px{{!}}link=Impulsantwort]]</div>
+|content=<div class="screenshot">[[File:math.png{{!}}alt=mathematische Formeln{{!}}center{{!}}450x450px{{!}}link=Impulsantwort]]</div>
 }}
 {{Portal flex/Box