Wie wird die Dokumentation von Mageia erstellt?

Wir haben Lebarhon von dem DokumentationsTeam gebeten, etwas über das Team und die zahlreichen Informationen, die sie für die Benutzer erstellen, zu schreiben. In diesem  Beitrag beschreibt er die „offizielle Dokumentation“ und das Mageia-Wiki

Die Mageia Dokumentation besteht aus zwei Teilen: die „offizielle Dokumentation“ und das Wiki. Die Art, wie sie verwaltet werden, ist sehr unterschiedlich:

Offizielle Dokumentation und Mageia-Wiki 

Die offizielle Dokumentation besteht aus der Hilfe zum klassischen Installer, zum LiveInstaller, und der Hilfe zur Netzinstallation. Diese Dokumentation, welche direkt in Verbindung zum InstallationsProzess steht, wird mit jeder neuen Version von Mageia erneuert und mitgeliefert. Die Hilfe zum MCC (MageiaKontrollzentrum, engl: Mageia Control Center) gehört ebenfalls zur offiziellen Dokumentation. Sie wird ständig auf dem laufenden gehalten und zusammen mit jedem Update neugepackt und ausgeliefert. Die gesamte offizielle Dokumentation wird von den MageiaTeams verfasst, validiert, und dann in mehr als 20 Sprachen übersetzt.

Das Wiki folgt einem komplett anderen Prozess. Jeder kann sich ein Benutzerkonto erstellen und einen Beitrag schreiben, verbessern oder übersetzen. Der Schreiber ist meistens jemand, der sich sehr gut in der Materie auskennt und den Bekanntheitsgrad des Themas erhöhen möchte (sei es eine bestimmte Anwendung, oder Spiele, Werkzeuge, oder wie auch Einstellungsveränderungen, besondere Kniffe oder allgemeine Informationen…). Jeder, der eine Seite übersetzen möchte, ist herzlich willkommen. Die meisten Seiten sind in bis zu fünf verschiedenen Sprachen verfasst. Leider ist deren Übersetzung noch ein wenig kompliziert. Wir planen allerdings eine MediaWikiErweiterung zu installieren, die den Übersetzungs-Prozess vereinfachen soll, und somit dann auch weitere interessierten Personen zum Übersetzen ermutigt. Das DocTeam überwacht das Wiki, um seine Funktionalität zu gewährleisten (und um Spam und Vandalismus zu bekämpfen), kann aber natürlich nicht immer alle Seiten sorgfältig Korrekturlesen.

Wer schreibt die Dokumentation von Mageia? 

In der Erstellung der offiziellen Dokumentation sind mehrere Teams involviert:

  • Doc-Team, die Autoren, ca. 10 Personen, von denen einige englische Muttersprachler sind
  • das Team i18n, die Übersetzer, bis zu 10 Personen je nach Sprache: es sind derzeit ca. 20 Sprachen verfügbar
  • das Atelier-Team, das für die Publizierung und die Übersetzungs-Übersicht zuständig ist

Die Teams werden jeweils von einem gewählten Leiter und seinen Stellvertretern geführt. Überall sind neue Freiwillige natürlich jederzeit herzlich willkommen.

Die Arbeitsweise

Die offizielle Dokumentation unterliegt einem geregelten Prozess: einige Wochen vor der Veröffentlichung schreibt oder modifiziert das Doc-Team die Texte auf Englisch im DocbookFormat mit Hilfe von Calenco. Das beinhaltet die Erstellung von Screenshots der neuen Version (damit sie den Veränderungen im Design des Installers, des MCC und den anderen Änderungen an den grafischen Oberflächen entsprechen) und das Überprüfen auf Stimmigkeit wie auch das Korrekturlesen durch einen englischen Muttersprachler. Danach wird der englische Originaltext in verschiedenen Formaten erstellt: html, epub und pdf.

Danach übernimmt das Atelierteam die Verantwortung für die Überführung in das .poFormat und für den Transfer nach Transifex mit Hilfe selbsterstellter Skripte. Damit können dann die Übersetzer entweder in Transifex, oder mit Hilfe der Werkzeuge ihrer Wahl, die Übersetzung durchführen und auch die übersetzten Screenshots erstellen, bzw. in Calenco bereitstellen.

Zuletzt kann das Atelierteam die Dokumentation für alle unterstützten Sprachen publizieren und in den oben genannten Formaten in die neuen ISOs integrieren (auch hier werden selbst erstellte Skripte genutzt).

Der letzte Schritt bezüglich der MCC-Hilfe weicht davon ab, da sie nicht mit der Veröffentlichung geliefert wird, sondern wie jedes andere Update paketiert wird.

Das alles gilt nicht für das Wiki. Das Verfassen wird von Freiwilligen, wann und in welcher Sprache sie möchten, erledigt. Anschließend wird das Verbessern und Übersetzen von anderen Freiwilligen übernommen – so sich welche einfinden. Es gibt aber dafür keine Erledigungsfrist. Das bedeutet freilich nicht, dass man im Wiki keine nützliche Information finden kann: das Gegenteil ist der Fall! Tatsächlich gibt es dort viele nützliche Anleitungen und spezifische Hilfeseiten.

Die Zukunft der Dokumentation

  • Obwohl der gesamte Ablauf ziemlich gut funktioniert, hat das Team natürlich auch einige Ideen, wie man die Dokumentation weiter verbessern könnte:
  • Die Dokumentation mag noch weiter ins Detail gehen, um Neulingen zu helfen, oder auch eine Hilfe zur Fehlersuche bereitzustellen (z.B. zu den Themen UEFI, BIOS Boot Partition, Grub2 Einstellungen, Optimus und so weiter).
  • Es gibt immer noch einige Werkzeuge im MCC, oder einige spezielle Funktionen, die bisher noch nicht dokumentiert sind (wenn sie z.B. exotische HardwareKomponenten betreffen).
  • Wir würden die ISOs gerne mit einer zusätzlichen ausgiebigen Hilfe bei Problemen mit schwacher Internetanbindung ausliefern.
  • Das Anwerben zusätzlicher Übersetzer wäre eine gute Sache, um die kleinen Teams zu stärken, sowie um die Dokumentation in weiteren Sprachen hauptsächlich im Wiki.
  • Das Anwerben zusätzlicher Entwickler würde uns ermöglichen,  unsere selbsterstellten Skripte zu erweitern und verbessern (z.B. zur Verwaltung der Screenshots für die offizielle Dokumentation), und brächte uns in die Lage, die WikiSoftware besser in den verschiedenen Sprachen zu unterstützen und ein wirksameres SicherheitsManagement gegen etwaigen Vandalismus ermöglichen.

Es kann keine gute Distribution geben ohne eine gute Dokumentation und keine gute Dokumentation, ohne ein großes gut funktionierendes Team. Wir verlassen uns auf Euch

Original veröffentlicht von Donald am 22. Feb 2017.

Dieser Beitrag wurde unter Allgemein veröffentlicht. Setze ein Lesezeichen auf den Permalink.

Die Kommentarfunktion ist geschlossen.