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.

Aktueller Stand der mz3Tool Dokumentation

Die deutsche Version ist schon recht komplett, aber aktuell in Überarbietung, da mit der v2.4.3.11 sich einige Menüpunkte in den Settings-Menüs geändert haben und auch signifikante Neuerungen hinzukamen.

Die englische Version ist angefangen (die ersten Kapitel) und wird schrittweise erweitert.Abhängig von den Anforderungen an Entwickklung/Bug-Fixing und unerwarteten “Interrupts” wird das doch etwas länger dauern, als zunächst gehofft. Ziel ist es jetzt, eine komplette Dokumentation bis Pfingsten fertiggestellt zu haben…
Schau’n mer mal ;-)

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 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.

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öchste 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
  • Download einer PDF Version
  • Datum der letzten Änderung
  • Versionsverwaltung
  • Links (Dokument-intern und extern)
  • Leistungsfähige Suche
  • Unterstützung mehrer Sprachen

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

Last modified: 2019/01/26

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