Pedimos ao Lebarhon, da equipe de Documentação, que escrevesse um pouco sobre o trabalho da equipe e os vários recursos que eles criaram para nossos usuários. Neste artigo, ele apresenta seu trabalho sobre a “Documentação Oficial” e a wiki Mageia.
A Documentação Mageia é composta de duas partes: a ” Documentação Oficial “ e a wiki . A forma como são geridos é muito diferente.
Documentação Oficial e Mageia Wiki
Dentro da documentação oficial, temos a “Ajuda do Instalador Clássico”, a “Ajuda do Instalador Live” e a “Ajuda do NetInstall”. Esta documentação, diretamente relacionada ao processo de instalação é atualizada e enviada com cada nova versão do Mageia. A “Ajuda do MCC” (Centro de Controle Mageia) também pertence à documentação oficial. Ela é constantemente atualizada e embalada para ser incluída nas atualizações regulares baixadas. Toda a “Documentação Oficial” é escrita e validada pelas equipas da Mageia e depois traduzida para mais de 20 idiomas.
A wiki segue um processo muito diferente. Qualquer pessoa pode se cadastrar em uma conta e escrever, melhorar ou traduzir uma página wiki. O escritor é geralmente alguém que domina um assunto e quer promovê-lo (aplicação, jogo, ferramenta, configurações, truques, informações, …). Qualquer pessoa que queira traduzir uma página é bem-vinda a fazê-lo. A maioria das páginas wiki são traduzidas em 1 a 5 idiomas – o processo de tradução ainda é difícil, planejamos implantar uma extensão MediaWiki para simplificá-la (e então incentivar mais colaboradores a traduzir páginas wiki). As equipes da Mageia monitoram o wiki para garantir que ela esteja funcionando como deveria (e especialmente prevenir e remover spam), mas eles não podem revisar todas as páginas completamente.
Quem Escreve a Documentação Oficial?
A documentação oficial da Mageia depende do envolvimento de várias equipes:
- Docteam (Equipe de Documentação), os escritores, composta por cerca de 10 pessoas, algumas das quais são nativas inglesas.
- I18n, os tradutores, composta por 1 a 10 pessoas, dependendo da língua (cerca de 20 línguas).
- Atelier, eles gerenciam a publicação e o acompanhamento do progresso da tradução.
As equipes são dirigidas por um líder eleito e vice-líder . Todos os novos voluntários são, naturalmente, muito bem-vindos .
O fluxo de trabalho
A documentação oficial segue um processo rigoroso. Em primeiro lugar, algumas semanas antes de um lançamento, Docteam escreve e/ou atualiza os textos em inglês no formato Docbook usando Calenco. Isso inclui fazer screenshots da próxima versão (para coincidir com a nova arte no instalador e MCC, bem como alterações GUI), verificação e revisão por um falante nativo em Inglês. Em seguida, o texto original em inglês é publicado nos formatos suportados : html, epub e pdf.
Aqui, a Equipe Atelier assume a conversão .po e sua transferência para o Transifex, graças a scripts caseiros. Os tradutores podem então fazer as traduções usando o Transifex ou qualquer ferramenta que preferirem, e também criar as capturas de tela traduzidas para colocá-las na Calenco.
Por fim, o Atelier pode publicar a documentação para todos os idiomas suportados nos formatos acima e integrá-lo nas novas ISOs (aqui também, usando scripts caseiros). O passo final é diferente para a ajuda do MCC, uma vez que não é fornecido com o lançamento, mas embalado como qualquer outra atualização.
Nada disso existe para o wiki. A escrita é feita por um voluntário sempre e em qualquer idioma que eles querem. Em seguida, melhoras e traduções são feitas por outros voluntários, se houver (sem prazo). Isso não quer dizer que informações úteis não podem ser encontradas na wiki, pelo contrário, é verdade, de fato, há muitos guias úteis e páginas de ajuda incluídas lá.
O Futuro da Documentação
Embora funcionando muito bem, as equipes Mageia têm algumas idéias para melhorar a documentação:
- Indo para a documentação em maior profundidade para os recém-chegados, dando mais detalhes e ajuda de solução de problemas (UEFI, partição de inicialização do BIOS, configurações Grub2, Optimus …).
- Existem ainda algumas das ferramentas do MCC ou seus recursos específicos que não são documentados ( pois envolvem hardware exótico)
- Gostaríamos de enviar as ISOs com uma enorme seção de solução de problemas com o objetivo de ajudar as pessoas com má conexão à Internet (acesso reduzido a downloads, fóruns, ajuda, etc.).
- Recrutamento de mais tradutores para fortalecer as pequenas equipes e oferecer mais documentação traduzida (principalmente no wiki).
- Recrutar mais desenvolvedores para melhorar os scripts caseiros (por exemplo, sobre o gerenciamento de screenshots de documentação oficial) e atualizar o software wiki para um melhor suporte multilíngüe e um melhor gerenciamento de segurança.
Não há boa distribuição sem boa documentação em muitos idiomas e sem boa documentação sem equipes boas e grandes. Estamos contando com todos vocês.
(escrito em inglês por schultz e traduzido por macxi)
