MDN wants to learn about developers like you: https://qsurvey.mozilla.com/s3/MDN-dev-survey

В этой статье
  1. Основные положения
    1. Заголовки страниц
      1. Заголовки и размер букв в них
      2. Выбор заголовков и кратких заголовков
      3. Создание новых иерархических структур страниц
    2. Разделы, параграфы и новые строки
    3. Форматирование текста и стили
    4. Стиль примеров кода и форматирования
      1. Отступы и разрывы строк
      2. Форматирование кода встроенного в текст
      3. Подсветка синтаксиса
      4. Оформление упоминаний в тексте элементов HTML
    5. Аббревиатуры на латинском
      1. В примечаниях и круглых скобках
      2. В тексте
      3. Значения и английские эквиваленты латинский аббревиатур
    6. Сокращения и аббревиатуры
      1. Размер букв и использование точки
      2. Расшифровка аббревиатуры
      3. Склонение, множественное число акронимов и аббревиатур
    7. Размер букв
    8. Сокращенные формы
    9. Образование множественного числа английских слов
    10. Разделение дефисом английских слов
    11. Изложение материала в обезличенной форме
    12. Числа и цифры
      1. Даты
      2. Десятилетия
      3. Множественное число чисел
      4. Разделители
    13. Пунктуация
      1. Serial comma (правило актуально для материалов на английском языке)
    14. Правописание английских слов
    15. Терминология
      1. Устаревший vs. нерекомендуемый
      2. HTML элементы
      3. Действия, выполняемые при помощи пользовательского интерфейса
    16. Залоги (актуально для материалов на английском языке)
  2. Wiki разметка и ее использование
    1. Ссылки на внешние ресурсы
    2. Ключевые слова страницы
      1. Страницы помеченные тегами, которые нуждаются в доработке
      2. Пометка тегами устаревших страниц
    3. SEO summary
    4. Целевые страницы
      1. Создание страницы со списком ссылок
  3. Добавление графических материалов
  4. Прочие справочные материалы
    1. Предпочитаемые руководства по стилям
    2. Предпочитаемый словарь
    3. Оформление принятое для материалов MDN
    4. Язык, грамматика, правописание

Для того, чтобы представить документацию в организованном, единообразном и удобном для чтения виде, руководство по оформлению материалов Mozilla Developer Network описывает принципы, согласно которым должен быть организован текст материалов, их проверка, оформление и так далее. Всё описанное здесь является руководящими принципами, а не строгими правилами. Главное для публикуемых материалов - содержимое, а не оформление, поэтому не стоит сильно углубляться в изучение руководства перед тем как внести свой вклад. Однако, не стоит расстраиваться или удивляться, если позже трудолюбивый волонтер отредактирует ваши материалы, чтобы они соответствовали правилам, описанным в этом руководстве.

Если вы ищите конкретные примеры того, какую структуру должен иметь данный тип страницы, посмотрите руководство по верстке страниц MDN.

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

Для получения информации о стандартах оформления, которые применяются к содержимому, написанному для других сайтов, помимо MDN, обратитесь к единому руководству по оформлению.

Основные положения

Заголовки страниц

Заголовки страниц используются в результатах поиска, а также в структуре иерархии страниц  в иерархическом списке вверху страницы. Заголовок страницы (который отображается вверху страницы и в результатах поиска) может отличаться от страничного краткого заголовка, который является частью страничного URL следующей после "<locale>/docs/".

Заголовки и размер букв в них

Заголовки страниц и заголовки разделов должны использовать стиль оформления как в обычном предложении (с заглавной буквы пишется только первое слово и имена собственные), а не использовать заглавные буквы в каждом слове:

  • Правильно: "Использование шейдеров для задания цвета в WebGL"
  • Неправильно: "Использование Шейдеров Для Задания Цвета В WebGL"

Имеется много старых страниц, материал которых был написан и опубликован до введения этого правила оформления. Вы можете обновить их по мере необходимости. Мы постепенно приведем их в соответствие новым правилам оформления.

Выбор заголовков и кратких заголовков

Краткий заголовок страницы, использующийся в составе URL (slug) должен быть кратким; когда создается новый уровень иерархии, новый компонент уровня в кратком заголовке должен обычно составлять одно-два слова.

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

Создание новых иерархических структур страниц

Когда вам необходимо добавить несколько статей по определенной тематике, вам необходимо сделать так, чтобы создав целевую страницу, затем добавлять подстраницы для каждой отдельной статьи. Целевая страница должна содержать вводную информацию объемом 1-2 параграфа, описывающих тему или технологию, а также иметь список подстраниц с краткими описаниями каждой страницы. Вы можете автоматизировать процесс вставки подстраниц в список на целевой странице, используя созданные нами макросы.

Например, руководство по JavaScript может иметь следующую структуру:

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

Разделы, параграфы и новые строки

Используйте уровни заголовков в порядке убывания: <h2>, затем <h3>, затем <h4>, без пропуска уровней. H2 является самым высоким разрешенным уровнем заголовков, потому как уровень H1 зарезервирован для заголовков страниц. Если вам необходимо использовать более трех-четырех уровней заголовков вы должны подумать на разделении статьи на несколько статей меньшего размера с целевой страницей, связав их вместе при помощи использования макросов Next, Previous, и PreviousNext.

Клавиша enter на вашей клавиатуре начинает новый параграф. Чтобы вставить новую строку без пробела, удерживайте клавишу shift во время нажатия клавиши enter.

Форматирование текста и стили

Используйте выпадающий список "Стили форматирования" для применения предопределенных стилей к выбранному контенту.

Обратите внимание: Стиль "Note" используется для указания выжных замечний, подобных этому.
Предупреждение: Так же, стиль "Warning" создает блоки предупреждений подобные этому.

Не надо использовать HTML атрибут style для ручного указания стиля содержимого, кроме случаев, когда это требуется специально. Если вы не можете указать стиль, используя предопределенный класс, обратитесь за помощью в #mdn.

Стиль примеров кода и форматирования

Отступы и разрывы строк

Используйте два пробела на один отступ во всех примерах кода. Код должен быть аккуратно выровнен: символы открывающих фигурных скобок ("{") должны быть на одной линии с выражением, которое открывает блок. Например:

if (условие) {
  /* обработка условия */
} else {
  /* обработка обратного случая */
} 

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

if (class.CONDITION || class.OTHER_CONDITION || class.SOME_OTHER_CONDITION
       || class.YET_ANOTHER_CONDITION ) {
  /* какие-либо действия */
}

var toolkitProfileService = Components.classes["@mozilla.org/toolkit/profile-service;1"]
                           .createInstance(Components.interfaces.nsIToolkitProfileService);

Форматирование кода встроенного в текст

Используйте кнопку "Код" (изображенную при помощи двух угловых скобок "<>") для применения стиля форматирования для встроенного в текст кода для имен функций, имен переменных и имен методов (используется элемент <code>). Например, "функция the frenchText()".

После указания имени метода должна следовать пара круглых скобок: doSomethingUseful(). Это помогает различать методы от других конструкций в коде.

Подсветка синтаксиса

Screenshot of the "syntax highlighting" menu.Целые строки (или несколько строк) кода должны быть отформатированы с использованием подсветки синтаксиса вместо элемента <code>. Щелкните на кнопке "pre" на панели инструментов для создания блока с предварительно отформатированным содержимым в котором вы затем можете написать ваш код. После этого, внутри блока с кодом выделите курсором необходимую часть текста, а затем из списка доступных языков, находящегося справа от кнопки "pre",  нужно выбрать соответствующий язык, как показано на рисунке справа. В следующем примере показан текст с форматированием в стиле языка JavaScript:

for (var i = 0, j = 9; i <= 9; i++, j--)
  document.writeln("a[" + i + "][" + j + "]= " + a[i][j]);

Если в списке нет необходимого языка, нужно использовать тэг pre без указания какого-либо языка (пункт "No Highlight" в языковом меню).

x = 42;

Оформление упоминаний в тексте элементов HTML

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

Названия элементов
Используйте макрос HTMLElement, который создает ссылку на страницу для этого элемента. Например, напишите {{HTMLElement("title")}} производящий "<title>". Если вы не хотите создавать ссылку, заключите имя в угловые скобки и используйте стиль "Code (inline)" (например, <title>).
Имена атрибутов
Используйте жирный шрифт.
Определения атрибутов
Используйте макрос htmlattrdef (например, {{htmlattrdef("type")}}) для описания возможных значений атрибута, чтобы на это описание можно было ссылаться с других страниц, затем используйте макрос htmlattrxref (например, {{htmlattrxref("attr","element")}}) для того, чтобы сделать ссылку на описание атрибута.
Значения атрибутов
Используйте стиль "Code (inline)" и не используйте кавычки вокруг строк, если это не требуется синтаксисом примера кода. Например: когда атрибут type элемента <input> устанавливается на значение email или tel ...
Пометка версии HTML атрибутов
Используйте пометки с помощью макроса HTML5. Например, используйте этот макрос рядом с атрибутом bold, но не для каждого употребления этого атрибута в тексте.

Аббревиатуры на латинском

В примечаниях и круглых скобках

  • Общеупотребимые аббревиатуры на латинском языке (etc., i.e., e.g.) могут использоваться в выражениях заключенных в скобки и в примечаниях. Используйте точки в этих аббревиатурах.
    • Правильно: Веб-браузеры (напр. Firefox) могут использоваться ...
    • Неправильно: Веб-браузеры напр. Firefox могут использоваться ...
    • Неправильно: Веб-браузеры, напр. Firefox, могут использоваться ...
    • Неправильно: Веб-браузеры, (напр: Firefox) могут использоваться ...

В тексте

  • В обычном тексте (то есть, в тексте вне примечаний или круглых скобок), используйте английский эквивалент аббревиатуры.
    • Правильно: ... веб-браузеры и так далее.
    • Неправильно: ... веб-браузеры и т.д.
    • Правильно: Веб-браузеры, например Firefox, могут использоваться ...
    • Неправильно: Веб-браузеры, напр. Firefox, могут использоваться ...

Значения и английские эквиваленты латинский аббревиатур

Аббревиатура на английском Аббревиатура на русском на латинском на английском на русском
cf. срав. confer compare сравнительно
e.g. напр. exempli gratia for example например
et al. и др. et alii and others и другие
etc. и т.д. et cetera and so forth, and so on и так далее
i.e. т.е. id est that is, in other words то есть
N.B.   nota bene note well обратите внимание
P.S.   post scriptum postscript постскриптум

Обратите внимание: Прежде чем использовать сокращение на латинском языке, подумайте на тем, есть ли от этого какая-то польза. Некоторые из этих сокращений используются так редко, что многие читатели могут не понять их значения, а другие читатели часто путают сокращения. Если вы всё-таки решите использовать сокращение, убедитесь в том, что вы используете его правильно. Например, частой ошибкой является путаница в использовании сокращений "e.g." и "i.e.".

Сокращения и аббревиатуры

Размер букв и использование точки

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

  • Правильно: XUL
  • Неправильно: X.U.L.; Xul

Расшифровка аббревиатуры

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

  • Правильно: "XUL (XML User Interface Language) - язык разметки на основе XML, созданный Mozilla..."
  • Неправильно: "XUL - язык разметки на основе XML, созданный Mozilla..."

Склонение, множественное число акронимов и аббревиатур

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

  • Правильно: CD-ROMs
  • Неправильно: CD-ROM's

Размер букв

Используйте стандартные языковые правила для написания текста материалов. Английские слова "World Wide Web" и "Web" составляют исключение.

Сокращенные формы

Используйте сокращенные формы (напр. "don't", "can't", "shouldn't"), если желаете.

Образование множественного числа английских слов

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

  • Правильно: syllabuses, octopuses
  • Неправильно: syllabi, octopi

Разделение дефисом английских слов

Разделяйте составляющие английских слов дефисом когда последняя буква или префикс является гласной и когда первая буква корня является гласной.

  • Правильно: email, re-elect, co-op
  • Неправильно: e-mail, reelect, coop

Изложение материала в обезличенной форме

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

Приведем несколько примеров:

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

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

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

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

Обратите внимание: MDN разрешает использование этого общего синтаксиса, чтобы компенсировать отсутствие neutral gender в английском языке. Использование местоимений третьего лица множественного числа как гендерно-независимых (то есть, использование местоимений "они", "их", "свои" ) является общепринятой практикой.

Вы можете использовать местоимения обеих родов:

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

использовать множественное число:

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

Но лучшей практикой, конечно, является переписать и полностью исключить использование местоимений:

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

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

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

Числа и цифры

Даты

Для дат (кроме даты в примерах кода) используйте формат "January 1, 1990".

  • Правильно: February 24, 2006
  • Неправильно: February 24th, 2006; 24 February, 2006; 24/02/2006

В качестве альтернативы, вы можете использовать формат YYYY/MM/DD.

  • Правильно: 2006/02/24
  • Неправильно: 02/24/2006; 24/02/2006; 02/24/06

Десятилетия

Для десятилетий, используйте формат "1990е". Не используйте апостроф.

  • Правильно: 1990е
  • Неправильно: 1990'е

Множественное число чисел

Для образования множественного числа чисел добавляется "е" в конце. Не используйте апостроф.

  • Правильно: 486е
  • Неправильно: 486'е

Разделители

В тексте, используйте разделители разделители только в пятизначных и более числах.

  • Правильно: 4000; 54,000
  • Неправильно: 4,000; 54000

Пунктуация

Serial comma (правило актуально для материалов на английском языке)

Используйте serial comma. Серийная (также называемая оксфордской) запятая - запятая, используемая перед союзом в серии из трех и более элементов.

  • Правильно: I will travel on trains, planes, and automobiles.
  • Неправильно: I will travel on trains, planes and automobiles.

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

Правописание английских слов

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

  • Правильно: localize, honor
  • Неправильно: localise, honour

Терминология

Устаревший vs. нерекомендуемый

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

Устаревший:
В MDN термин устаревший используется применительно к API или технологии, которые не только не рекомендуются к применению, но также больше не реализуются в браузере. По отношению к технологиям, касающимся Mozilla, под устаревшими будут пониматься API больше не реализуемые в коде Mozilla. По отношению к технологиям, касающимся какого-либо веб-стандарта, под устаревшими будут пониматься API или возможность больше не поддерживаемая текущими версиями наиболее используемых браузеров.
Нерекомендуемый:
В MDN, термин нерекомендуемый используется применительно к API или технологии, которые больше не рекомендуются к применению, но по-прежнему реализованы и могут все еще работать. В скором времени эти технологии станут устаревшими и будут удалены, поэтому вы должны прекратить их использовать. По отношению к технологиям, касающимся Mozilla, под нерекомендуемыми будут пониматься API, которые всё еще поддерживаются в коде Mozilla. По отношению к технологиям, касающимся какого-либо веб-стандарта, под нерекомендуемыми будут пониматься API или возможность, которая будет удалена или заменена в новой версии соответствующего стандарта.

HTML элементы

Используйте слово "элементы" при упоминании HTML и XML элементов, а не слово "теги". Кроме того, элементы почти всегда заключаются в "<>", и должны быть оформлены в стиле <code>. Также, по крайней мере при первом упоминании элемента в секции необходимо использовать макрос HTMLElement, чтобы создать ссылку на документацию с описанием элемента (за исключением случаев, когда вы пишите материалы для страницы справочной документации элемента).

  • Правильно<span> элемент
  • Неправильно:  span тег

Действия, выполняемые при помощи пользовательского интерфейса

При описании последовательности действий, описывайте действия, совершаемые при помощи пользовательского интерфейса, с использованем повелительного наклонения. Определяйте названия элементов пользовательского интерфейса по надписям на них и их типам.

  • Правильно: Щелкните кнопку "Редактировать".
  • Неправильно: Щелкните "Редактировать".

Залоги (актуально для материалов на английском языке)

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

Wiki разметка и ее использование

Ссылки на внешние ресурсы

Чтобы автоматически создать ссылку на запись в багтрекинге Bugzilla, используйте следующий шаблон:

{{Bug(322603)}}

Результатом данной операции будет:

баг 322603

Для создания ссылок на запись о баге, хранящуюся на WebKit Bugzilla, используйте следующий шаблон:

{{Webkitbug("322603")}}

Результатом данной операции будет:

Баг WebKit 322603

Ключевые слова страницы

Ключевые слова (теги) обеспечивают мета-информацию о странице и/или указывают, что страница нуждается в определенных улучшениях, которые необходимо внести в ее содержимое. Каждая страница в вики должна иметь теги. Вы можете найти более подробную информацию о том, какие присваивать странице теги в нашем руководстве How to properly tag pages.

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

Screenshot of the UX for adding and removing tags on MDN

Чтобы добавить тег, щелкните по полю ввода в конце списка тегов и введите имя тега, который желаете добавить. По мере ввода тега будет работать автозаполнение, подсказывающее возможные варианты тегов. Нажмите клавишу ввода для подтверждения ввода нового тега. Каждая статья должна иметь столько тегов, сколько необходимо. Например, статья об использовании JavaScript в AJAX программировании может иметь оба тега "JavaScript" и "AJAX".

Чтобы удалить тег, просто щелкните на значке "X" сбоку тега.

Страницы помеченные тегами, которые нуждаются в доработке

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

Пометка тегами устаревших страниц

Используйте следующие теги для страниц, которые не содержат актуальной информации:

  • Junk: Используется для спама, страниц созданных по ошибке, или для страниц, содержимое которых настолько плохо, что они должны быть удалены. Страницы помеченные этим тегом удаляются время от времени.
  • Obsolete: Используется для материалов, которые технически вытеснены, но остаются по-прежнему действующими в определенном контексте. Например, HTML элемент, который является устаревшим в HTML5, по-прежнему корректен в HTML 4.01. Вы также можете использовать макрос obsolete_header для размещения в материале баннера, который оповестит об этом.
  • Archive: Используется для материалов, которые технически вытеснены и больше не являются полезными. По возможности, необходимо добавить оповещение предоставляющее читателю обратиться к материалам с более актуальной информацией. Например, страница, описывающая как использовать репозиторий Mozilla CVS, должна предоставлять читателям ссылку на актуальный материал об использовании репозитория Mercurial (Если нет соответсвующего материала, используйте тег NeedsUpdate, и добавьте пояснение на страницу обсуждения.) Страницы с тегом Archive со временем будут перемещены из основного содержимого MDN в секцию Archive.

SEO summary

SEO summary - очень короткая сводная информация о содержимом страницы. Она будет использоваться как краткая описание статьи роботами, анализирующими информацию со страниц сайта, и будут затем отображаться в результатах поиска для описания этой страницы. Эта информация будет также использоваться макросами, которые занимаются составлением целевых страниц в автоматическом режиме внутри MDN.

По умолчанию, первый абзац страницы используется в качестве SEO summary. Однако, вы можете переопределить это, пометив другой раздел статьи стилем "SEO summary" в WYSIWYG редакторе.

Целевые страницы

Целевые страницы (landing pages) - страницы, расположенные в корне раздела, посвященного какой-либо тематике. Примерами таких страниц служат главные страницы разделов, посвященных CSS и HTML. Они имеют стандартное оформление, состоящее из трех областей:

  1. Краткий обзор (обычно один параграф), описывающий что это за технология и область ее применения.
  2. Список ссылок из двух столбцов с соответствующими заголовками. Смотрите раздел Создание страницы со списком ссылок для получения более подробной информации.
  3. Дополнительно: секция "Совместимость с браузерами" внизу страницы.

Создание страницы со списком ссылок

Раздел содержащий список ссылок, расположенный на целевой странице MDN состоит из двух столбцов. Он создается с использованием следующего HTML кода:

<div class="row topicpage-table">
  <div class="section">
    ... содержимое левого столбца ...
  </div>
  <div class="section">
    ... содержимое правого столбца ...
  </div>
</div>

Левый столбец должен быть списком статей, с заголовком <h2> вверху левого столбца, объясняющим по какой теме это статьи (например "Документация и учебные материалы по WebGL"); этот заголовок должен использовать CSS класс "Documentation". Ниже заголовка должен располагаться <dl> список статей, с блоком <dt> для каждой ссылки на статью и кратким описанием о статье, состоящим из одного-двух предложений, расположенных в соответствующем <dd> блоке.

Правый столбец должен содержать один и более разделов, расположенных в следующем порядке:

Получение помощи от сообщества
Этот раздел должен содержать информацию о IRC каналах и списках рассылки, доступных по данной тематике. Заголовок должен использовать класс "Community".
Инструментальные средства
Список инструментальных средств, к которым пользователь может обратиться за помощью в использовании  технологии, описанной в данном разделе MDN. Заголовок должен использовать класс "Tools".
Связанные темы
Список ссылок на целевые страницы других технологих, связанных с данной. Заголовок должен использовать класс "Related_Topics".

<<<Раздел, касающийся целевых страниц будет дополняться>>>

Добавление графических материалов

Иногда полезно дополнить статью, которую вы создаете или редактируете, графическими материалами, особенно если статья описывает технические вопросы. Чтобы добавить графические материалы:

  1. Прикрепите файл с требуемым изображением к статье (внизу каждой статьи в режиме редактирования).
  2. Создайте изображение в WYSIWYG редакторе.
  3. В WYSIWYG редакторе в выпадающем списке перечислены вложенные материалы, выберите только что созданный вложенный материал, который добавили вы.
  4. Нажмите кнопку OK.

Прочие справочные материалы

Предпочитаемые руководства по стилям

Если у вас имеются вопросы относительно словоупотребления и стилевым манерам изложения материалов, о которых не сказано в этом документе, мы рекомендуем обратиться к Economist style guide или к Chicago Manual of Style.

Предпочитаемый словарь

По вопросам правильного написания русскоязычных слов, пожалуйста обращайтесь на портал Грамота.ру или dic.academic.ru.

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

Оформление принятое для материалов MDN

Язык, грамматика, правописание

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

Метки документа и участники

 Внесли вклад в эту страницу: Flygrounder, sputnik1986, Zuc, teoli, fscholz, mihan007, Cobalt747
 Обновлялась последний раз: Flygrounder,