Рекомендации для разработчиков документации

Перейти к: навигация, поиск

Спасибо за то, что вы решили принять участие в создании русской версии документации! Авторы и все русскоязычные пользователи Moodle будут вам благодарны, если ваши статьи будут выполнены качественно и в соответствии со следующими рекомендациями, выработанными сообществом "Russian Moodle":

  1. Заполните свой профиль, укажите контактные данные для связи с вами. Для этого представьтесь системе и перейдите по ссылке вверху страницы, содержащей ваше имя и фамилию.
  2. Ознакомьтесь со всеми статьями блока "Помощь".
  3. При создании новой статьи обязательно обеспечьте связь этой статьи с другими. Если вы просто создадите статью, не указав нигде ссылку на нее, эта страница будет страницей-сиротой – на нее можно будет попасть, только зная точное название или через поиск.
  4. При создании новой переводной статьи обязательно обеспечьте двухстороннее связывание с английским оригиналом: в русском варианте вставьте ссылку на английский, в английском – на русский. См. также: как это сделать
  5. При редактировании существующей статьи обязательно заполняйте графу "Краткое описание изменений". Это описание будет выводиться на страницах "Последние изменения" и "История".
  6. Если статья малоинформативна или работа над ней еще не закончена (например, переведены не все разделы), обязательно размещайте в начале статьи шаблон {{заготовка}}.
  7. При переводе статьи старайтесь сохранить максимальную близость к оригиналу. Не "теряйте" ссылки, картинки, меню, блоки, шаблоны, которые содержались в оригинальной статье.
  8. Настоятельная просьба публиковать только те части статьи, которые близки к итоговому варианту, то есть те, в которых вы планируете сделать уже только «косметические» правки. Не публикуйте статьи, которые вы перевели с помощью Promt и еще не отредактировали в соответствии с нормами русского языка и другими рекомендациями этой статьи. Оптимальным алгоритмом перевода может быть следующий: создать статью, скопировать в нее английское содержание со всеми ссылками, картинками, меню и блоками и далее постепенно переводить ее частями.
  9. Настоятельная просьба перед публикацией производить проверку орфографии и грамматики хотя бы в Microsoft Word. Идеальным вариантом бы было попросить вычитать статью знакомого филолога или преподавателя русского языка. Но, к сожалению, это не всегда возможно. Поэтому, если вы не уверены в отсутствии в статье орфографических и грамматических ошибок, одним из возможных вариантов может быть размещение в статье шаблона {{Требуется проверка филологом}}.
  10. Придерживайтесь общепринятой терминологии. При описании интерфейса Moodle – терминологии официального перевода интерфейса и встроенной справки, при описании работы в wiki-документации Moodle – официального русского перевода интерфейса MediaWiki.

Будем надеяться, что общими усилиями у нас получится качественная документация, соответствующая по уровню самой системе Moodle! ;-)

Смотрите также