Рекомендации для разработчиков документации: различия между версиями
Материал из MoodleDocs
(Созданы рекомендации для разработчиков документации) |
Ne Nashev (обсуждение | вклад) (уточнения и косметика) |
||
Строка 3: | Строка 3: | ||
#Заполните свой профиль, укажите контактные данные для связи с вами. Для этого представьтесь системе и перейдите по ссылке вверху страницы, содержащей ваше имя и фамилию. | #Заполните свой профиль, укажите контактные данные для связи с вами. Для этого представьтесь системе и перейдите по ссылке вверху страницы, содержащей ваше имя и фамилию. | ||
#Ознакомьтесь со всеми статьями блока "Помощь". | #Ознакомьтесь со всеми статьями блока "Помощь". | ||
#При создании новой статьи обязательно обеспечьте связь этой статьи с другими. Если вы просто создадите статью, не указав нигде ссылку на нее, эта страница будет страницей-сиротой – на нее можно будет попасть, только зная точное название. | #При создании новой статьи обязательно обеспечьте связь этой статьи с другими. Если вы просто создадите статью, не указав нигде ссылку на нее, эта страница будет страницей-сиротой – на нее можно будет попасть, только зная точное название или через поиск. | ||
#При создании новой переводной статьи обязательно обеспечьте двухстороннее связывание с английским оригиналом: в русском варианте вставьте ссылку на английский, в английском – на русский | #При создании новой переводной статьи обязательно обеспечьте двухстороннее связывание с английским оригиналом: в русском варианте вставьте ссылку на английский, в английском – на русский. См. также: [[MoodleDocs:Путеводитель_для_разработчиков_документации#Связывание_с_другими_языками|как это сделать]] | ||
#При редактировании существующей статьи обязательно заполняйте графу "Краткое описание изменений". Это описание будет выводиться на страницах "Последние изменения" и "История". | #При редактировании существующей статьи обязательно заполняйте графу "Краткое описание изменений". Это описание будет выводиться на страницах "Последние изменения" и "История". | ||
#При переводе статьи старайтесь сохранить максимальную близость к оригиналу. Не "теряйте" ссылки, картинки, меню, блоки, шаблоны, которые содержались в оригинальной статье. | #При переводе статьи старайтесь сохранить максимальную близость к оригиналу. Не "теряйте" ссылки, картинки, меню, блоки, шаблоны, которые содержались в оригинальной статье. | ||
#Настоятельная просьба публиковать только те части статьи, которые близки к итоговому варианту, то есть те, в которых вы планируете сделать уже только «косметические» правки. Не публикуйте статьи, которые вы перевели с помощью Promt и еще не отредактировали в соответствии с нормами русского языка и другими рекомендациями этой статьи. Оптимальным алгоритмом перевода может быть следующий: создать статью, скопировать в нее английское содержание со всеми ссылками, картинками, меню и блоками и далее постепенно переводить ее частями. | #Настоятельная просьба публиковать только те части статьи, которые близки к итоговому варианту, то есть те, в которых вы планируете сделать уже только «косметические» правки. Не публикуйте статьи, которые вы перевели с помощью Promt и еще не отредактировали в соответствии с нормами русского языка и другими рекомендациями этой статьи. Оптимальным алгоритмом перевода может быть следующий: создать статью, скопировать в нее английское содержание со всеми ссылками, картинками, меню и блоками и далее постепенно переводить ее частями. | ||
#Настоятельная просьба перед публикацией производить проверку орфографии и грамматики хотя бы в Microsoft Word. Идеальным вариантом бы было попросить вычитать статью знакомого филолога или преподавателя русского языка. Но, к сожалению, это не всегда возможно. Поэтому, если вы не уверены в отсутствии в статье орфографических и грамматических ошибок, одним из возможных вариантов может быть размещение в статье шаблона | #Настоятельная просьба перед публикацией производить проверку орфографии и грамматики хотя бы в Microsoft Word. Идеальным вариантом бы было попросить вычитать статью знакомого филолога или преподавателя русского языка. Но, к сожалению, это не всегда возможно. Поэтому, если вы не уверены в отсутствии в статье орфографических и грамматических ошибок, одним из возможных вариантов может быть размещение в статье шаблона '''<nowiki>{{Требуется проверка филологом}}</nowiki>'''. | ||
#Придерживайтесь общепринятой терминологии. При описании интерфейса Moodle – терминологии официального перевода, при описании работы в wiki-документации Moodle – официального русского перевода интерфейса MediaWiki. | #Придерживайтесь общепринятой терминологии. При описании интерфейса Moodle – терминологии официального перевода интерфейса и встроенной справки, при описании работы в wiki-документации Moodle – официального русского перевода интерфейса MediaWiki. | ||
Будем надеяться, что общими усилиями у нас получится качественная документация, соответствующая по уровню самой системе Moodle! ;-) | Будем надеяться, что общими усилиями у нас получится качественная документация, соответствующая по уровню самой системе Moodle! ;-) | ||
==Смотрите также== | ==Смотрите также== | ||
*Russian Moodle '''>>''' Форум переводчиков '''>>''' Обсуждение "[http://moodle.org/mod/forum/discuss.php?d=61458 Наполнение MoodleDocs]" | *Russian Moodle '''>>''' Форум переводчиков '''>>''' Обсуждение "[http://moodle.org/mod/forum/discuss.php?d=61458 Наполнение MoodleDocs]" |
Версия от 19:40, 22 марта 2007
Спасибо за то, что вы решили принять участие в создании русской версии документации! Авторы и все русскоязычные пользователи Moodle будут вам благодарны, если ваши статьи будут выполнены качественно и в соответствии со следующими рекомендациями, выработанными сообществом "Russian Moodle":
- Заполните свой профиль, укажите контактные данные для связи с вами. Для этого представьтесь системе и перейдите по ссылке вверху страницы, содержащей ваше имя и фамилию.
- Ознакомьтесь со всеми статьями блока "Помощь".
- При создании новой статьи обязательно обеспечьте связь этой статьи с другими. Если вы просто создадите статью, не указав нигде ссылку на нее, эта страница будет страницей-сиротой – на нее можно будет попасть, только зная точное название или через поиск.
- При создании новой переводной статьи обязательно обеспечьте двухстороннее связывание с английским оригиналом: в русском варианте вставьте ссылку на английский, в английском – на русский. См. также: как это сделать
- При редактировании существующей статьи обязательно заполняйте графу "Краткое описание изменений". Это описание будет выводиться на страницах "Последние изменения" и "История".
- При переводе статьи старайтесь сохранить максимальную близость к оригиналу. Не "теряйте" ссылки, картинки, меню, блоки, шаблоны, которые содержались в оригинальной статье.
- Настоятельная просьба публиковать только те части статьи, которые близки к итоговому варианту, то есть те, в которых вы планируете сделать уже только «косметические» правки. Не публикуйте статьи, которые вы перевели с помощью Promt и еще не отредактировали в соответствии с нормами русского языка и другими рекомендациями этой статьи. Оптимальным алгоритмом перевода может быть следующий: создать статью, скопировать в нее английское содержание со всеми ссылками, картинками, меню и блоками и далее постепенно переводить ее частями.
- Настоятельная просьба перед публикацией производить проверку орфографии и грамматики хотя бы в Microsoft Word. Идеальным вариантом бы было попросить вычитать статью знакомого филолога или преподавателя русского языка. Но, к сожалению, это не всегда возможно. Поэтому, если вы не уверены в отсутствии в статье орфографических и грамматических ошибок, одним из возможных вариантов может быть размещение в статье шаблона {{Требуется проверка филологом}}.
- Придерживайтесь общепринятой терминологии. При описании интерфейса Moodle – терминологии официального перевода интерфейса и встроенной справки, при описании работы в wiki-документации Moodle – официального русского перевода интерфейса MediaWiki.
Будем надеяться, что общими усилиями у нас получится качественная документация, соответствующая по уровню самой системе Moodle! ;-)
Смотрите также
- Russian Moodle >> Форум переводчиков >> Обсуждение "Наполнение MoodleDocs"