Dieses Papier ist die zentrale und einzige Dokumentation zu mz3Tool.
Alle älteren Informationen (Blogs, FAQ, Videos, PDF-Dateien, alte Links) sind veraltet und werden demnächst, vermutlich mit einem Re-Design der Website, vom Netz genommen bzw. in ein Archiv verschoben.

Browser Anforderungen für die Javascript Version

Aktueller Stand der mz3Tool Dokumentation

Die deutsche Version ist bis auf kleinere Lücken komplett. Auch die englische Version ist inzwischen vollständig übersetzt. Allerdings überwiegend automatisch mit translate.google.com. Also ab und an etwas holperig oder sogar unverständlich; aber besser als nichts. Außerdem wurden einige Links zu Kapiteln und Screenshots “zerschossen” und funktionieren nicht mehr. Die werde ich nach und nach richten.

Nutzungshinweise

Die Dokumentation muss und sollte nicht von vorne bis hinten gelesen werden!
Ausnahme: Kapitel 1 und Kapitel 2; für Neugierige und technisch Interessierte auch Kapitel 3
In diesen Kapiteln finden sich viele Links, denen man folgen kann, wenn man tiefer einsteigen will.

Ist die Hilfe mit Context Help eingeschaltet, was bei den ersten Mz3 Projekten (“Büchern”; bis zu den ersten 5) automatisch erfolgt, wird immer die gerade benötigte Hilfeseite angezeigt.

Für Einsteiger/Erstanwender empfiehlt sich das Kapitel 2. Quick Tours.
Dort kann man je nach eigenem Anwendungsfall 1 der 3 Beispiele nachvollziehen, und sollte innerhalb weniger Minuten selber erste Erfolgserlebisse haben.

Die meisten Informationen stehen im Kapitel 4. Hauptmenu, in dem alle Menüpunkte beschrieben sind.
Damit ist ein direkter 1:1 Zugriff auf die Menüpunkte gegeben, sodass man schnell nachschlagen kann, was sich hinter einem Menüpunkt verbirgt und welche Besonderheiten zu beachten sind.
Man wird die Dokumentation erst zu Rate ziehen, wenn man über die intuitve Bedienung nicht weiterkommt. Oder wenn man auf Entdeckungtour ist ;-)

Im Kapitel 5 geht es dann um Details für technisch interessierte Anwender.
Diese Informationen werden für die normale Nutzung von mz3Tool, mz3Viewer und MegaZine3 nicht benötigt, können aber helfen, effizienter zu werden und bei Problemen schneller eine Lösung zu finden.

Dokumentationstool Manula

Diese Dokumentation wurde mit Manula erstellt. Ich möchte Manula an dieser Stelle für die perfekte Unterstützung danken.
Jedem, der eine umfangreichere Dokumentation erstellen muss, möchte ich ans Herz legen, sich Manula einmal anzuschauen.
Ein wie ich finde geniales Tool, das viele Vorteile bietet. Unter anderem:

Für die Leser:

  • Online Version: Desktop und Smartphone geeignet
  • Offline Version: Download einer PDF Version
  • Information: Datum der letzten Änderung
  • Versionsverwaltung: Passende Dokumentation zur genutzten Programm-Version
  • Verlinkung: Dokument-intern und externe Links
  • Leistungsfähige lokale Suche
  • Unterstützung mehrer Sprachen: Es gibt eine Deutsche und Englische Fassung

Für den Dokumentierer:

  • Gute Verwaltung von Bildern (ähnlich wie in Wordpress)
  • Einfache Erzeugung von Links
  • Automatische Erzeugung eines Inhaltsverzeichnisses
  • Einfaches Einfügen von Bildern
  • Schnelle und einfache Formatierung

Revision: 5
Last modified: 2019/03/22

Reaktion

War das hilfreich?

Ja Nein
You indicated this topic was not helpful to you ...
Could you please leave a comment telling us why? Thank you!
Thanks for your feedback.

Hinterlasse einen Kommentar.

Kommentar senden