WP für technische Dokumentationen und Schulungsunterlagen

  • Hallo und ein herzliches Grüß Gott zusammen!

    Immer schon dachte ich mir, dass für technische Dokumentationen nicht einfache Word-Dokumente sondern zumindest HTML-Dokumente erstellt werden sollten.
    Nach meinen ersten Gehversuchen in WP kam mir der Gedanke, ob sich derartige technische Dokumentationen (etwa von Anlagen oder Software) nicht wunderbar in WP erstellen ließen und zwar am besten in einem Responsive Theme. Vorteile die ich sehe wären:
    1) User können die Doku nicht nur gedruckt sondern auch auf dem Smartphone oder Tablet ansehen, können sie sich aber genau so auch ausdrucken oder nur solche Teile, die sie ausgedruckt benötigen.
    2) Ich kann direkt aus einer zu dokumentierenden Software auf die entsprechenden Themen verlinken und so ähnlich der Windows-Hilfe Plattformübergreifend eine Hilfe bereitstellen.
    3) Ich kann direkte Links einfügen etwa wenn ich auf ein vorhergehendes Kapitel verweise, oder auf irgend eine Skizze usf.
    4) Abkürzungen oder Symbole könnten eventuell über ein Plugin eine Direkthilfe anzeigen.
    5) Eventuell könnte man auf verschiedenen Pfaden durch die Dokumentation führen. (Erstes Kennenlernen, Grundkurs, Aufbaukurs, ...)
    6) Möglicherweise könnte man die Doku durch spezielle Stylesheets auch direkt für Präsentationen verwenden. (sozusagen, wie Powerpoint - größere Schriftarten, nur Überschriften, Ingress und Bilder anzeigen und keine Texte. Gemeinsam mit den unterschiedlichen Pfaden (vom letzten Punkt) könnte man schnell aus einer Doku eine Präsentation zu bestimmten Themen der Doku machen.
    7) Allgemeine Textblöcke (Begrüßungstexte, Symbolerklärungen usf.) ließen sich für mehrere Dokumentationen wiederverwenden.
    8) Dazu kommen das Autorensystem, Revisions und Versionierungssystem von WP.
    9) User können unmittelbar Feedback geben.
    10) Änderungen und Korrekturen können schnell und unkompliziert eingearbeitet werden.

    Möglicherweise gibt's noch weitere Vorteile, die mir jetzt spontan nicht einfallen.

    Hier jetzt meine Frage. Hat jemand von Euch schon Erfahrungen mit derartigen Dokumentationen in WP. Gibt es möglicherweise Themes, die sich besonders dafür eignen? Oder ist WP dafür einfach doch nicht geeignet und gibt es freie Alternativen, die das können?
    Natürlich gibt's hier einige offene Fragen. Lassen sich etwa Überschriften automatisch durchnummerieren und zu einem Inhaltsverzeichnis zusammenfassen? Sehr elegant wäre etwa auch ein Abkürzungsverzeichnis, das quasi vollautomatisch jedesmal, wenn eine Abkürzung verwendet wird, diese in einen Link mit Hilfetext in einer Textblase verwandelt und solche Sachen. Aber das ließe sich ja vielleicht über ein Plugin machen. Kennt Ihr so etwas?

    Herzlichen Dank für Eure Gedanken und Anregungen!

    • Anzeige

    Hallo!

    Wenn du gerade an deiner Website arbeitest oder dein aktuelles Hosting überdenkst: Wir betreiben mit NetzLiving eine Hosting-Plattform, die speziell auf Performance, Sicherheit und einfache Verwaltung ausgelegt ist.

    • ✔️ Schnelle Ladezeiten (optimiert für WordPress & Co.)
    • ✔️ Deutsche Server & DSGVO-konform
    • ✔️ Persönlicher Support (kein 0815-Ticket-System)

    Mehr erfahren

  • Melewo: Danke, werde ich mir ansehen. Ich finde Wikis im Allgemeinen nicht so sexy und flexibel. Zudem würde ich mich lieber in WP intensiver einarbeiten anstatt ein wenig Halbwissen in WP anzusammeln und ein wenig in Wiki. Aber mal sehen. Danke für den Tipp.

    @Gerd-E: Danke. Genau bei dieser Suche wollte ich um Eure Unterstützung bitten. Möglicherweise bin ich zu blöd zum suchen, aber tausende Themes und Plugins auf ihre Tauglichkeit für meinen Zweck und Kompatibilität untereinander zu durchforsten kommt mir jetzt nicht so geschickt vor. Da würden mir eben genau etwas spezivischere Tipps von Euch sehr helfen. Ich glaube ja nicht, dass ich der Erste bin der auf diese Idee kommt, und suche daher nach Leuten, die soetwas schon mal gemacht oder zumindest versucht haben.

    Einmal editiert, zuletzt von Palmstroem (18. Januar 2014 um 12:13)

  • Melewo: Danke nochmals für den Tipp! Das mit weniger flexibel nehme ich mal bescheiden zurück. Sieht gut aus das MediaWiki-Dingens, muss ich mir wirklich näher ansehen. Dennoch bin ich auch weiterhin für Hinweise für Lösungen mit WP dankbar.

  • Das mit weniger flexibel nehme ich mal bescheiden zurück.


    Kommt ja immer darauf an, was bei einem Projekt im Vordergrund steht. Die benutzen zum Beispiel eine:

    http://wiki.selfhtml.org/wiki/Startseite

    HTML
    <meta name="generator" content="MediaWiki 1.19.8" />

    Ich möchte auch niemanden WP ausreden, umsonst steht WP bei der Verbreitung nicht auf Platz 1 und die Vielseitigkeit, um die unterschiedlichsten Projekte zu realisieren, die ist vorhanden.

  • Das Plugin, welches auf der von Gerd-E. verlinkten Seite vorgestellt wird, macht keinen schlechten Eindruck.

    http://dennishoppe.de/wordpress-plugins/encyclopedia

    Ich glaube ja nicht, dass ich der Erste bin der auf diese Idee kommt, und suche daher nach Leuten, die soetwas schon mal gemacht oder zumindest versucht haben.


    Möglich, doch wer stellt Dokumentationen und Schulungsunterlagen ins Web? Ist nicht die Masse. Mir fallen dazu lediglich Seiten wie MS Developer Network ein und noch ein paar andere, doch so viel mehr nicht. Bei kleineren Projekten handelt es sich mehr um eine Sammlung von Tutorials und noch andere verlinken halt auf PDFs.

    Einige benutzen dafür ein CMS, welches entsprechend angepasst wurde, wobei es nicht zwangsläufig erkennbar ist, zumindest nicht für mich, um welches CMS es sich dabei handelt. Dann gibt es noch Coder, die ihr eigenes CMS aufzusetzen.

  • Hallo zusammen.
    Also der Tipp mit MediaWiki war wirklich gut. Dort habe ich nun in relativ kurzer Zeit die Plugins zusammgefunden, die ich mir so in etwa vorstellen würde.

    Das wären vorerst:
    Collection: ermöglicht auf einer Seite ähnlich einem Inhaltsverzeichnis mehrere Artikel zu verlinken und dann alles gemeinsam etwa als PDF auszugeben. Damit kann man basierend auf einer Auswahl an Artikeln dann verschiedene Dokumentationen oder Kursunterlagen erstellen. (GesamtDoku, Einführungskurs, Aufbaukurs, Schnellpräsentation, ...)


    Lingo: für Tooltips zu Worten, die in einer eigenen Seite verwaltet werden. (Abkürzungsverzeichnis) Funktioniert genau so, wie ich mir das wünsche.


    MobileSkin: erkennt Smartphones und adaptiert die Skin entsprechend. (Responsive Design)

    Mw-slidy: verwandelt jede Seite in eine Präsentation. Das sieht ziemlich genial aus, muss ich mir aber erst näher ansehen. Dürfte aber im Wensentlichen das sein, was ich mir vorstelle.

    Purple MediaWiki: ermöglicht zielgenaue Links auch in die Mitte von Artikeln.

    Da kommt mit der Zeit sicherlich noch einiges hinzu, aber das wäre einmal ein Anfang mit MediaWiki. Damit werde ich's wohl vorerst einmal probieren. Wenn dennoch jemand von Euch analog dazu Plugins für WP kennt, wäre das weiterhin sehr interessant für mich.
    Ich danke Euch schon mal sehr herzlich :-P, und freue mich über weitere Ideen dazu.:idea:

  • Gibt es hier, 2 Jahre später, neue Erfahrungswerte?
    Ich bin vor allem auf der Suche nach Doku-geeigneten WP Themes. Ich probiere außerdem das Dokumentor Plugin aus, das prinzipiell ganz schön ist, und auch eigene Themes mitbringt, doch lässt sich das Ergebnis wohl immer nur einbetten - so dass man quasi ein Theme in ein anderes einbettet und irgendwie doppelte Menüs und dergleichen hat - so richtig erschließt sich mir das noch nicht.
    Weitere Erfahrungen / Ideen?
    Dank!

Jetzt mitmachen!

Sie haben noch kein Benutzerkonto auf unserer Seite? Registrieren Sie sich kostenlos und nehmen Sie an unserer Community teil!