Пользователь
0,0
рейтинг
1 августа 2011 в 11:35

Разработка → Команде переводчиков документации PHP требуется помощь

PHP*
Upd: Для нетерпеливых: пошаговые инструкции по созданию переводов.

Русская документация PHP


Добрый день Хабрасообщество!
Как многим известно, вот уже долгое время на php.net нет русской версии документации PHP. Это не значит, что работа по переводу была прекращена, а результаты этой работы пропали.
Дело в том, что перевод документации — добровольное дело, и добровольцев, скажем так, не много. Один-два человека старались удержать перевод на плаву, но все равно в конце концов документация устарела и скорее вводила в заблуждение тех, кто ей пользовался, нежели помогала в освоении языка. Где-то в 2008 г. в команде переводчиков никого не осталось, потом документация устарела настолько, что процесс сборки (куда входит синхронизация с английской версией) сломался и русский мануал исчез с официального сайта до «лучших времен». Медленное и мучительное возрождение документации началось в октябре 2010 г., но с тех пор оно с каждым днем набирает обороты.


Команда переводчиков PHP


На данный момент в команде doc-ru участвуют всего-лишь несколько человек. Большую часть актуального перевода на протяжении долгого времени выполнял Алексей Шеин aka conf, он же на данный момент является координатором переводов. За «порядком» следит уже отошедший от перевода документации core-разработчик PHP Антон Довгаль aka tony2001. Есть еще и другие — приходящие, уходящие и пропадающие переводчики, но также вносящие ценный вклад в наше общее дело.
Теперь, когда вы представляете себе команду переводчиков, дам немного статистики на данный момент:
  • Количество переведенных файлов ~700
  • Количество устаревших переведенных файлов ~200
  • Количество непереведенных файлов ~8900





Не правда ли, печально? Логичным шагом стал следующий раздел нашей статьи.

Обращение к хабрапользователям и всем сочувствующим


Можно долго спорить нужен ли вообще русский мануал по PHP. Давайте оставим эти споры в стороне — пусть каждый сам решает для себя, чем лучше пользоваться. Почти все мы взрослые люди. Но я точно знаю, что начинающим веб-разработчикам лучше рекомендовать мануал, нежели книги с непонятными и устаревшими, а зачастую и ужасными примерами. Еще одним доводом за написание мануала можно считать … патриотизм. Есть замечательный пример — французский мануал PHP. Данный мануал переведен на 99%, причем 80% переведено одним единственным человеком — Yannick Torrès (yannick). Чем наша многомиллионная страна хуже?)

Мы, команда doc-ru, просим всех, кому это интересно присоединиться к переводу документации PHP.
Совсем скоро выйдет в свет PHP 5.4 (3 альфа выйдет уже в четверг, 4 августа) с новыми фичами, такими как:
  • traits;
  • встроенный веб-сервер;
  • короткий синтаксис создания массивов (array('one', 'foo' => 'test') === ['one', 'foo' => 'test'];);
  • разыменование массива из результата вызова функции (foo()[1]);
  • вызов метода объекта в виде массива ($arr = array('Class', 'method'); $arr(););
  • и многое, многое другое.

Давайте впервые взглянем на описание всех этих возможностей на нашем, родном языке?

Дополнительная мотивация


Разумеется, основной целью участия в команде переводчиков должно быть сильное желание расширить и всячески улучшить русский перевод документации PHP, а также приятное чувство удовлетворения и выполненного долга. Но кроме этого есть также несколько приятных плюшек, таких как:
1) Почтовый адрес с доменом php.net. С него можно будет настроить редирект на ваш основной почтовый адрес, например, на Gmail.
2) Open-source лицензия (с бесплатными обновлениями в течение года) на прекрасную Jetbrains PhpStorm (только для работы над open-source проектами).
3) Общественное признание. Ваши имена навсегда останутся на специальной странице документации, даже после того как вы прекратите работу над ней, см. раздел “Переводчики” на странице docs.php.net/manual/ru/preface.php.

Внимание:
Все вышеперечисленное доступно только вложившим заметный вклад в перевод или редакторскую правку документации и получившим svn-account. Т.к. халявщиков иметь красивый адрес и пр. достаточно много, необходимо сначала доказать, что вы можете выполнять серьезную работу, а именно — создание патчей.

Стратегия


Есть три основных стратегии восстания русской документации из пепла:
  • Обновить все уже переведенные файлы и затем продолжить переводить остальное
  • Перевести основы языка и только потом переводить документацию к модулям и пр.
  • Переводить все подряд, что больше нравится и близко к сердцу.

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

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

Далее я опишу техническую сторону перевода, для тех, кого мы заинтересовали.

Ресурсы и инструкции


Задать вопросы или поучаствовать в обсуждении перевода можно в нашем почтовом списке рассылки doc-ru@lists.php.net. Для подписки нужно отправить пустое письмо на doc-ru-subscribe@lists.php.net (для отписки соответственно на doc-ru-unsubscribe@lists.php.net).
Также, если будет необходимость, можно подписаться на основной список рассылки документации PHP: phpdoc@lists.php.net (на англ.).

Отслеживать общее состояние перевода документации можно на http://doc.php.net/trantools/revcheck_extended_ru.html.

Сама документация постоянно (4 раза в сутки) выкладывается на один из серверов PHP: http://docs.php.net/manual/ru/.

Из соглашений по переводу на данный момент имеется скромный файл, но в наших планах создание крепкого и активного сообщества переводчиков, коллективный разум которого создаст крепкую и хорошую основу для перевода в будущем. Поэтому, если вы сомневаетесь как перевести то или иное предложение, не до конца понимаете смысл и пр. — не стесняйтесь, спрашивайте в списке рассылки. Лучше все вместе подумаем, чем напишем что-то не то :).

Как именно переводить можно узнать в нашей статье о новом инструменте перевода edit.php.net и в материале "PHP Documentation HOWTO" (англ.).

Послесловие


Всем спасибо за внимание и ждем вас в нашей команде!
Статью подготовили: conf, irker. Если вы нашли опечатку или ошибку в статье, пожалуйста, напишите мне о них в приватном сообщении.
Шеин Алексей @conf
карма
52,0
рейтинг 0,0
Реклама помогает поддерживать и развивать наши сервисы

Подробнее
Спецпроект

Самое читаемое Разработка

Комментарии (53)

  • +3
    Полезное дело, есть желание присоединиться. Заодно и документацию тщательно проштудирую :)
    • +6
      Не пойму по минусам (особенно в карму) что так не понравилось в комменте? Личная инициатива, ненависть к русскому языку или к PHP?
  • +3
    Главное успеть перевести то, что тебе интересно, пока этого не сделал кто-то другой :))
    • +1
      Всегда можно помочь и проверить уже имеющийся перевод! )
  • +3
    Как раз собирался подготовиться к Zend PHP 5.3 Certification Exam и прочитать всю документацию, а для этого все равно надо переводить на родной язык. Совмещу два полезных дела.
    • +1
      Попробовал переводить, вот результаты перевода в фоне между рабочими задачами в течении первого дня:
      • Посмотрел веб-редактор. Удобно. Пока будем использовать его.
      • Так как времени было не очень много, решил помочь ребятам в стратегически важных переводах и восстановил несколько переводов по математическим функциям в актуальное состояние.
      • Решил для себя что буду действовать следующим образом: если много времени — беру новый перевод, если мало — перевод тех функций, которые были переведены ранее, но устарели.
      • Получил массу удовольствия от процесса, потому что этот процесс направлен на пользу другим и себе самому.
      • 0
        Спасибо за работу! К сожалению, из-за наплыва не успеваем все проверять, но обязательно это сделаем.
  • +2
    кстати, надо нашим инновационным государственным учреждениям порекомендовать взяться за русские мануалы к разным языкам программирования, это действительно было бы полезно, в отличии от разных сомнительных венчурных проектов
    • +3
      Ну на них-то как раз надежды нет, а вот на хабр — есть :)
  • –1
    на подписки подписался, есть желание присоединиться
  • 0
    Хм, ввиду появления edit.php.net можно и попробовать. Поидее, это должно быть просто
  • –1
    Что могу сказать… Если действительно важен результат а не процесс, ИМХО нужно искать варианты материального поощрения переводчиков. Я переводил на русский PHPAds, OpenX, XFCE (немного) и как-то подустал работать на дяденек за спасибо :((

    Гораздо более действенные результаты будут при оплачиваемом варианте перевода, пусть даже далеко не по рыночным расценкам…
    • +5
      Перевод документации — работа не «на дяденек», а для себя и других, таких же как вы.
      PHP не коммерческий продукт, как и его документация. Никто из авторов документации не планирует зарабатывать на нем — все на добровольной основе.
      Конечно «за деньги» было бы больше желающих и может быть перевод был бы качественней. Но в связи с вышеописанным — увы нет.
      • 0
        могу только пожелать удачи… хотя слабо в нее верю
      • 0
        Хорошим поощрением были бы благодарности от php.net, чтобы поработав можно было добавить плюшку к резюме. Тем более это ценность не материальная.
        • 0
          Теоретически это может быть что-то типа дипломчика :) Цена вопроса — пара баксов за «распечатать и отправить почтой».
        • 0
          Мы об этом уже написали, см. пункт 3 в разделе «Дополнительная мотивация». И, думаю, адрес @php.net в вашем резюме будет также неплохо смотреться :)
          • 0
            Да, проглядел. В целом я согласен помогать и безвозмездно, даже интересовался как, но с поломаной ключицей (одной рукой) я много не переведу + делаю много граматических ошибок.
            • 0
              Ну мы никуда не торопимся, а насчет ошибок не переживайте — вычитывать переводы тоже есть кому, хотя, конечно, по возможности, формулировать мысли нужно грамотно :)
  • +3
    А вообще большой спрос на документацию на русском? Уже просто настолько привык к англ. варианту. Никто опрос не устраивал? даже не обязательно по php.
    • 0
      У новичков спрос очень большой.
  • +4
    2) Open-source лицензия (с бесплатными обновлениями в течение года) на прекрасную Jetbrains PhpStorm (только для работы над open-source проектами).


    А разве лицензия для работы над open-source проектами не бесплатна? Или можно будет получить лицензию не имея активного open-source проекта?
    • 0
      Именно бесплатна и именно для open-source проектов. Именно такие лицензии и получила команда ru-doc.
  • +3
    Простите — я понимаю нужное это дело переводы, но судя по первому графику — 30% от переведенного текста уже устарело, а чем дальше тем труднее будет стараться удержаться на плаву.

    Довольно часто работая с доками я усвоил, что они пишутся на достаточно простом английском языке и просты в понимании.

    Думаю не составит труда немного расширить свои знания в английском и научиться понимать документацию.

    • 0
      Тем более, что много полезной информации содержится в комментариях пользователей к документации
      • 0
        Комментарии пользователей показываются во всех документациях, независимо от языка.
      • 0
        Комментарии пользователей будут и на страницах русской версии документации. Разумеется, лучше знать английский язык, чем не знать, но начать освоение нового языка программирования намного проще, если документация доступна на твоем родном языке, по крайней мере для меня это так.
    • 0
      Не знаю, где вы увидели там 30% — по-моему, там ясно написано 2.37%, что почти в 3 раза меньше процента актуальных переводов. Все дело в увлечении делом — когда я начинал восстанавливать переводы, актуальных переводов было меньше процента.
  • 0
    Откройте для свободного чтения "статье о новом инструменте перевода edit.php.net".
    • 0
      Открыли. Переживали из-за хабраэффекта.
  • +1
    Мне кажется, jabber-конференция будет удобнее списка рассылки. Ну или, как минимум, полезным дополнением.
  • 0
    Тоже готов поучавствовать, есть опыт перевода мануалов
  • 0
    скоро можно будет увидеть, какие функции нравятся разработчикам меньше всего. Это те станицы, что будут оставаться непереведенными до последнего)
  • 0
    Кажется народ не совсем понял, как присоединиться, в рассылку уже пошли письма типа «Хотелось бы присоединиться к переводу документации PHP». Может как-то выделить про edit.php.net/?
    • 0
      Ну как еще выделить-то? Я уже и так ссылку в самый верх перенес :)
  • 0
    Похоже, edit.php.net накрыло хабраэффектом :/
    • 0
      Да, начало тормозить :(
      • 0
        Меня вот вообще не пускает… Нужно переждать, пока все наиграются
  • НЛО прилетело и опубликовало эту надпись здесь
    • 0
      Прочитать вторую статью, ссылка в шапке этой статьи :) Сайт edit.php.net накрыло к сожалению волной, нужно обождать, либо работать локально.
      • НЛО прилетело и опубликовало эту надпись здесь
        • 0
          Да.
  • 0
    А кнопка «Donate» есть? А то с переводом у меня не очень.
    • 0
      Кнопки нету, но идея хорошая :)
      Правда непонятно как эти деньги делить между столькими людьми :)
      • 0
        Если появится, дайте знать. Делить не проблема, у меня на всех вас не хватит :)
    • 0
      А я наоборот против такой кнопки)
      На малых проектах она полезна, на крупных и с большим количеством участников — не думаю.
      • 0
        Ну тогда просто спасибо.
      • 0
        почему же?
  • 0
    Полезное дело. Нисколько не умаляя полезности данной инициативы, хотелось бы скромно заметить — это не должно отменять необходимости изучения английского языка. Для программиста в наши дни это, ИМХО, необходимость.

    P.S. Имел честь встретиться как-то раз в Штутгарте на PHP UG с человеком по имени Egon Schmid — он стоял у истоков документации PHP. Был впечатлен.
  • 0
    Может не Donate, а просто знаменитые Like и +1 ?:)
    Готов внести вклад на перевод, только не понял, чтобы попасть в сообщество нужно писать в IRC? Я не давно не пользуюсь ей
    • 0
      опечатался. * Я давно не пользуюсь ей
  • 0
    Посмотрел статистику — прогресс огромен, русский уже четвёртый по объёму. Может быть русский уже вернут на сайт?
  • 0
    О! А я тоже Лёха Шеин!

Только зарегистрированные пользователи могут оставлять комментарии. Войдите, пожалуйста.