Ми попросили Lebarhon з команди з документування написати трохи про роботу команди і різноманітні ресурси, які було створено командою для користувачів. У цій статті він описує роботу учасників команди над офіційною документацією та вікі Mageia.
Документація Mageia складається з двох частин: «Офіційної документації» та вікі. Принципи роботи над цими частинами значно відрізняються.
Офіційна документація і вікі Mageia
Офіційна документація складається із довідки до класичного засобу встановлення системи, довідки із засобу встановлення з портативної версії системи та довідки до засобу встановлення з мережі. Ця документація, яку безпосередньо пов’язано із процедурою встановлення системи, оновлюється і постачається з кожним новим випуском Mageia. Довідка з MCC (Центру керування Mageia) також належить до офіційної документації. Цей підручник оновлюється поступово і пакується разом зі звичайними, придатними до отримання зі встановленої системи, оновленнями. Уся ця офіційна документація створюється і перевіряється командами Mageia, а потім перекладається понад 20 мовами.
Процедура роботи з вікі є зовсім іншою. Будь-хто може зареєструвати обліковий запис, а потім писати, поліпшувати і перекладати сторінки вікі. Автором, зазвичай, є хтось, хто знається на темі сторінки і хоче донести до інших певні знання (щодо програми, гри, інструмента, параметрів, певних прийомів роботи…). Ми також раді будь-кому, хто захоче перекласти сторінку вікі. Більшість сторінок вікі перекладено, кількість перекладів коливається від 1 до 5. Процедура перекладу усе ще доволі марудна. Ми плануємо перейти на розширення MediaWiki для спрощення перекладу (а потім хочемо запросити користувачів до перекладу сторінок вікі). Команди Mageia спостерігають за вікі, забезпечуючи її працездатність (особливо запобігаючи появі спаму та вилучаючи його), але іноді нам не вистачає сил, щоб вичитати усі сторінки належним чином.
Хто пише офіційну документацію?
Вміст офіційної документації Mageia є продуктом зусиль декількох команд:
- Команди з документування, авторів текстів. Команда складається з десятка людей, для декого з її учасників англійська мова є рідною.
- Команд перекладачів, кількість учасників яких коливається від 1 до 10, залежно від мови (маємо понад 20 активних команд).
- Команди оприлюднення (Atelier). Учасники цієї команди керують оприлюдненням документації та спостерігають за поступом перекладу.
Керівництво кожною командою здійснює її вибраний лідер та його заступник. Звичайно ж, кожна з команд буде дуже рада новим учасникам.
Робочий процес
Офіційна документація формується за строгими правилами. По-перше, за декілька тижнів до випуску команда з документування пише і/або оновлює тексти англійською у форматі Docbook за допомогою Calenco. Це стосується і знімків вікон для наступного випуску (щоб відповідати нових художнім роботам у засобі для встановлення та MCC, а також змінам у графічному інтерфейсі), перевірки документації та її вичитування учасниками, для яких англійська є рідною. Далі, початкові тексти англійською оприлюднюються в усіх підтримуваних форматах: html, epub та pdf.
Далі відбувається перетворення даних у формат .po за допомогою наших скриптів та перенесення даних на Transifex. За це відповідає команда перекладачів. Перекладачі виконують переклади за допомогою Transifex або власних програмних інструментів і створюють знімки для вивантаження їх на Calenco.
Нарешті, команда Atelier може оприлюднити документацію усіма підтримуваними мовами у вказаних вище форматах та інтегрувати документацію з новими образами ISO (тут ми також використовуємо наші скрипти). Для довідки з MCC останній крок є дещо іншим, оскільки пакунки не включаються до випуску, а розповсюджуються разом із іншими оновленнями.
Жоден із цих інструментів не використовується для вікі. Тексти вікі створюються усіма охочими усіма бажаними мовами. Далі, поліпшення та переклад текстів виконують інші охочі. Ніяких критичних дат не існує. Це не означає, що у вікні не можна знайти корисної інформації, навіть навпаки, там чимало корисних сторінок із настановами та відомостями щодо дистрибутива.
Майбутнє документації
Хоча описані вище схеми працюють досить добре, у команд Mageia вже є деякі ідеї щодо поліпшення документування:
- Ми хочемо надати початківцям докладнішу інформацію, зокрема створити докладніші описи роботи інструментів та довідку із усування вад у системи (UEFI, розділ завантаження BIOS, параметри Grub2, Optimus…).
- Деякі з інструментів MCC та їхніх можливостей усе ще не документовано достатнім чином (оскільки для документування потрібне специфічне обладнання).
- Нам би хотілося додати до образів ISO широкі відомості щодо усування вад, які допоможуть розв’язати проблеми користувачам із проблемними з’єднаннями з інтернетом (недостатній канал зв’язку для отримання даних, пошуку на форумах, у довідкових ресурсах тощо).
- Хочемо знайти побільше перекладачів для посилення малих команд та запропонувати користувачам більше перекладеної документації (зокрема у вікі).
- Маємо залучити більше розробників для поліпшення наших скриптів (наприклад, для керування знімками вікон у офіційній документації), а також оновити програмне забезпечення вікі так, щоб мати ліпшу підтримку перекладів та потужніший захист від зловмисників.
Без якісної документації багатьма мовами неможливо уявити собі добрий дистрибутив. А створення якісної документації є неможливим без дружніх та великих команд. Ми покладаємося на усю спільноту дистрибутива.
