From BlenderWiki

Jump to: navigation, search


Другие страницы посвященные редактированию Wiki:

Руководство редактора | Руководство по стилю оформления | Шаблоны | Заметки для переводчиков | Список задач (Руководство)


В целях обеспечения целостности всей документации Blender’a, потенциальным авторам настоятельно рекомендуется соблюдать настоящее Руководство по стилю оформления.

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

Общие рекомендации

Содержание

  • Будьте кратки и понятны
  • Пишите идиоматическим и (во всех смыслах) грамотным языком

Структура страниц

  • Добавляйте заголовок и подвал на каждую страницу, чтобы облегчить читателю навигацию по Руководству|Урокам|Справочнику
  • Разбивайте страницы на главы, разделы и подразделы
  • Для быстрого просмотра, сразу после названия добавляйте резюме, кратко излагающее тему, цели и содержание; особенно для длинных глав
  • Если тема слишком велика для одной страницы -- разбейте ее на под страницы

Справочный материал

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

Рекомендации по редактированию

Письмена

  • Официальная документация mediawiki: очень хорошо сделана и легко читается.
  • Единственное замечание по поводу форматирования вики-ссылок: пожалуйста, не используйте литералы внутри ссылок, поскольку это меняет их представление и тогда гораздо труднее понять, что они на самом деле ссылки.
  • Рекомендации к шаблонам: изучите доступные шаблоны и, при необходимости, используйте их -- это сократит время необходимое для чтения и облегчит обслуживание (полный список шаблонов)
  • Рекомендации к коду: удобно использовать для вставки фрагментов кода на python или C
  • Рекомендации к таблицам: удобно для представления больших объемов данных

Добавление файлов, изображений и медиа материалов

Перекрестные ссылки

  • Перекрестные ссылки викифицированы, это значит, что когда вы хотите сделать ссылку на страницу (или файл, или изображение) вы просто указываете ее имя (то есть, большое название на оранжевом фоне) в квадратных скобках, например [[Doc:RU/Manual|Blender's user manual]] или просто [[Doc:RU/Manual]]
  • Не используйте полные урл-адреса (http://wiki.blender.org/index.php/....) для ссылок на страницы BlenderWiki.