Русский Gentoo

Технология работы с документацией, которой мы пользуемся сегодня, предложена проектом Gentoo. Ее особенность — «все вручную». Это способствует повышению мастерства участников, но кое-что все же стóит упростить и автоматизировать :) А попробовав на себе, распространить наши улучшения на весть проект Gentoo.

Этот раздел нужно написать.

Горящая задача

Все задачи этого раздела — горящие! Но самая горящая — разработка TidyGuide XSL!

Благоустройство территории нашего проекта также жизненно важно для повышения эффективности работы над документацией.

Материалы

Инструменты

TidyGuide

Тексты, которые мы пишем и переводим, обладают внутренней разметкой, которая должна сохраняться, чтобы легко отслеживать изменения (diff -U). Большинство визуальных редакторов безнадежно ее портит. Также пока не доведены до ума фильтры, позволяющие «красиво» открыть в них наши материалы.

Поэтому, в угоду качеству, пока мы пользуемся «ручными» текстовыми редакторами XML, в которых разметка видна человеку.

Для того, чтобы избавить участников проекта от мучительной выверки XML-разметки документации, позволить им пользоваться визуальными редакторами и автоматизировать приведение документов к единому виду при публикации, нам остро нужно средство для автоматической разметки документов — TidyGuide.

Нам остро требуется разработчик, способный расколоть эту захватывающую непростую задачу!

UpGuide

Поддержание русской документации — это не только перевод, но и постоянное обновление.

Исходные руководства «живут своей жизнью» — постоянно пополняются, становятся удобнее, а ошибки исправляются. А переводы отстают.

Синхронное обновление перевода — сейчас непростая задача, поскольку требуется вручную отражать в переведенных документах отличия, выявляемые в оригинале.

Это во многом механическая работа: открыть окно просмотра различий между версиями, найти их, открыть новый файл, найти место с отличиями, найти место в переводе, скопировать отличия туда, перевести. Так как GuideXML структурирован, этот процесс можно почти полностью автоматизировать.

Представьте себе: переводчик открывает единственный файл, в котором в перевод уже вставлены все изменения, сделанные в оригинале, и просто переводит их! А если все-таки хочет проверить, что именно изменилось, открывает окно различий перевода с обновленным переводом.

Для этого нужно написать специальный трехфайловый diff/merge. Более того, его можно не ограничивать рамками GuideXML!

Нам остро требуется разработчик, способный расколоть эту захватывающую непростую задачу!

Редакторы GuideXML

Мы сможем пользоваться визуальными редакторами, как только сделаем шаблоны для редакторов. При этом чтобы пользоваться ими полноценно, нам потребуется готовый TidyGuide. Подробнее о визуальных и невизуальных редакторах:

Очень нужны разработчики! Хороший повод освоить XML-технологии!

Комплект участника

Нужно описать создание рабочей среды и при необходимости собрать комплект инструментов для развертывания/настройки (включая невизуальные редакторы, xmllint, diff/patch, xsltproc).

Требуется ведущий этого направления!

Хотите включиться? Мы расскажем, как!