Waar komt Mageia’s documentatie vandaan?

(Aan het vertalen, het originele bericht vindt u hier: http://blog.mageia.org/en/2017/02/22/where-does-the-mageia-documentation-come-from/ )

We vroegen Lebarhon van het Documentatieteam om wat over het werk van het team te vertellen en over de verschillende informatiebronnen die ze voor onze gebruikers maakten. In dit artikel presenteert hij het werk aan de “Officiële documentatie” en aan Mageia’s wiki. De vertaler heeft gekozen voor een niet al te letterlijke vertaling waar dat de duidelijkheid helpt.

Mageia’s documentatie bestaat uit twee delen, de “Officiële documentatie en de wiki. Ze worden op zeer verschillende wijze gemanaged.

Officiële documentatie en Mageia’s wiki

Binnen de officiële documentatie hebben we de Handleiding voor installatie, de Handleiding voor Installatie vanaf een Live-medium en de Handleiding voor een netwerkinstallatie. Deze aan het installatieproces gerelateerde documentatie wordt geleverd bij elke nieuwe Mageia-uitgave. De handleiding voor het Configuratiecentrum, MCC, hoort ook bij de officiële documentatie. Deze wordt geregeld bijgewerkt en verpakt om, net als andere updates, gedownload te kunnen worden. Alle “Officiële documentatie” is geschreven en gevalideerd door Mageia-teams en daarna vertaald in meer dan 20 talen.

De wiki volgt een heel ander draaiboek. Iedereen kan een Mageia-account aanmaken en dan een wikipagina schrijven, verbeteren of vertalen. De auteur is doorgaans iemand die het onderwerp beheerst en wil promoten (een toepassing, game, tool, instellingen, tips & trucs, informatie, …). Iemand die een pagina wil vertalen, wordt aangemoedigd dat te doen. De meeste wikipagina’s zijn vertaald in één tot vijf talen – het vertaalproces is nog ongestructureerd, we zijn van plan een MediaWiki-extensie te installeren om het proces beter te beheersen (en dan meer vrijwilligers aan te moedigen wikipagina’s te vertalen). Mageia-teams houden een oog op de wiki om te verzekeren dat deze naar behoren werkt (en vooral om spam te voorkomen en te verwijderen), maar komen er niet aan toe alle pagina’s grondig te lezen en corrigeren.

Wie verzorgen de officiële documentatie?

Mageia’s officiële documentatie hangt af van de medewerking van verschillende teams :

  • Docteam, de schrijvers, bestaande uit ongeveer tien mensen, van wie sommigen Engels als moedertaal hebben.
  • i18n/l10n, de vertalers, bestaande uit één tot tien mensen per taal (voor ongeveer 20 talen).
  • Atelier, dit team verzorgt de publicatie op onze website en monitort het vertaalproces.
  • Het pakketbouw(packaging)/programmeer-team, dat zorgt voor de integratie met MCC en het traditionele installatieprogramma, maar ook voor het bouwen van de benodigde pakketten.
  • Het QA-team, dat deze pakketten en integratie test voor ondersteunde versies van Mageia.

Teams worden doorgaans geleid door twee of drie (adjunct-)leiders. Nieuwe vrijwilligers zijn uiteraard welkom.

De Werkwijze

Voor de officiële documentatie wordt een strikt proces gebruikt. Eerst, tot enige weken voor een uitgave, schrijft en/of verbetert Docteam de Engelse teksten in het Docbook formaat m.b.v. Calenco. Daarbij inbegrepen is het maken van screenshots van de nieuwe uitgave (voor het nieuwe design in het installatieprogramma en in MCC, maar vooral voor veranderingen in de gebruikersinterface) en het proeflezen door iemand met Engels als moedertaal. Dan wordt de originele Engelse tekst gepubliceerd in de ondersteunde formaten: HTML, EPUB en PDF.

Vervolgens zorgt het i18n/l10n team voor het bijwerken van de .po files in git en in Transifex, met behulp van scripts die ze daarvoor gemaakt hebben. De vertalers kunnen vervolgens hun werk doen in Transifex, of daarbuiten met welke tool dan ook die hun voorkeur heeft. Ook maken ze “vertaalde” screenshots om naar Calenco te uploaden.

Ten slotte kan Atelier de documentatie voor alle ondersteunde talen in bovengenoemde formaten op onze website plaatsen, en zorgt het pakketbouw/programmeer-team voor de integratie met de isos en het bouwen van de benodigde pakketten.

Niets van dat alles bestaat voor de Wiki. Het schrijven wordt gedaan door vrijwilligers, wanneer, waarover en in welke taal ze maar willen.. Then, improving and translating are done by other volunteers, if any (no deadline). This isn’t to say that useful information can’t be found on the wiki, quite the opposite is true, in fact, there are many useful guides and help pages included there.

The Future of the Documentation

Although working pretty well, the Mageia teams have some ideas to improve the documentation:

  • Going into the documentation in greater depth for the newcomers, by giving more details and troubleshooting help (UEFI, BIOS boot partition, Grub2 settings, Optimus…).
  • There are still some of the MCC tools or their specific features that aren’t documented (as they involve exotic hardware)
  • We would like to ship the ISOs with a massive troubleshooting section aiming to help people with poor Internet connections (poor access to downloads, forums, help, etc.).
  • Recruiting more translators to strengthen the small teams and to offer more translated documentation (mostly in the wiki).
  • Recruit more developers to improve the homemade scripts (for example about the official documentation screenshots management) and to update the wiki software for better multilingual support and a better security management.

There is no good distribution without good documentation in many languages and no good documentation without good and large teams. We are relying on you all.

Dit bericht is geplaatst in Geen categorie. Bookmark de permalink.

Reacties zijn gesloten.