Стандартные метки статей в MDN

Этот перевод не завершён. Пожалуйста, помогите перевести эту статью с английского

Метки статей (теги для статей) — важный способ помочь пользователям находить нужный им контент.  Для упорядочения содержимого желательно, чтобы у каждой страницы было несколько меток. Эта статья расскажет, как лучше использовать метки, чтобы читатели могли найти информацию, и чтобы она была организованной.

Инструкцию по работе с интерфейсом для редактирования меток читайте в разделе Tags руководства для авторов статей.

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

Для чего в MDN используются метки

Метки используются в MDN для целого ряда целей:

Категоризация
Какого типа этот документ? Справка? Учебник? Целевая страница? С помощью меток этого типа наши посетители смогут фильтровать результаты поиска, поэтому такие метки очень важны.
Идентификация темы статьи
Какой теме посвящена данная статья? Она — об API? О DOM? О графике? Эти метки тоже очень важны, так как и они используются для фильтрации результатов.
Статус технологии
Какой статус у данной технологии? Является ли она нестандартной? Устаревшей? Экспериментальной?
Уровень подготовки читателя
На какой уровень технической подготовки читателя рассчитан данный учебник или руководство?
Метаданные
Сообщество авторов документации использует метки, чтобы знать, какие статьи в какой работе нуждаются.

Руководство по типам меток

Здесь приводится сокращённое руководство по типам меток с примерами.

Тип меток "Категория"

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

Следующие метки являются стандартными метками типа "Категория" в MDN:

(Введение)
Статья содержит вводный материал по теме.  В идеале, в рамках одной технической области (technology area) должно быть только одна статья с меткой «Intro».
(Справка)
Данная статья содержит справочный материал по какому-либо API, элементу, атрибуту, свойству и т. п.
(Главная)
Данная страница является главной по данной теме.
(Руководство)
Данная статья является руководством либо инструкцией.
(Пример)
Это страница примеров кода или содержащая примеры кода (фрагменты полезного кода, а не однострочные «примеры синтаксиса»).

Тип меток "Tема"

Указывая тему статьи, вы помогаете улучшить качество результатов поиска и навигации в целом. 

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

Как правило, хорошая метка-идентификатор темы — это либо название интерфейса, которому посвящено несколько страниц (например, Node, которому посвящено много страниц документации с описанием его всевозможных свойств и методов), либо название ряда технологий. Страница о технологии WebGL может иметь метки Graphics и WebGL, например, а страница, посвященная элементу <canvas> — метки HTML, Element, Canvas и Graphics.

Cпециальные метки для материалов о Mozilla

Эти метки используются только в материалах, посвященных Mozilla:

Тип меток "API identification"

Within the API reference, each article should identify which part of the API it covers:

The main article for an interface should have this tag. For example, RTCPeerConnection.
Each interface may have up to one page tagged "Constructor"; this is the interface's constructor. The page should have the same name as the interface, like RTCPeerConnection().
Every article describing a particular property within an interface needs this tag. See RTCPeerConnection.connectionState, for example.
Each article documenting an interface method needs this tag. See RTCPeerConnection.createOffer() for example.

In addition, the reference pages need to include interface, property, and method names among their tags. Some examples:

The interface RTCPeerConnection
Include the tag  along with the other relevant tags (, and so forth).
The method RTCPeerConnection.createOffer()
Include the tags  and  (note no parentheses in tag names!) along with the other relevant tags, including , and so forth. Consider including things like  and , which are also relevant here.
The property RTCPeerConnection.iceConnectionState
Include the tags  and  along with the other relevant tags, including  and . Also consider including .

Тип меток "Статус технологии"

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

Примеры меток этого типа:

Apply this tag to reference pages which describe a property or attribute which is read-only.
(Нестандартная)
Указывает, что технология или API, описываемая на данной странице, не является частью стандарта, но считается стабильной в броузере или броузерах, поддерживающих её реализацию. Если Вы не используете эту метку, читатель ошибочно решит, что речь идёт о чём-то стандартизированном. Таблица совместимости на странице должна пояснять, какие конкретно броузеры поддерживают данную технологию или API.
(Устаревшая)
Технология или API, описываемая на данной странице, в спецификации помечена как устаревшая и, возможно, скоро будет удалена, хотя пока ещё доступна в текущих версиях броузеров.
(Рудиментарная)
Технология или API считается рудиментарной и удалена (либо находится в процессе удаления) из большинства современных броузеров.
(Экспериментальная)
Технология в настоящее время не стандартизована и является экспериментальной; в будущем она может стать или не стать частью стандарта.  Её существующая форма реализации в браузере (как правило, в каком-то одном) тоже может в дальнейшем измениться. Если технология не включена ни в одну спецификацию (хотя бы в черновой вариант), то к материалу о ней необходимо добавить также метку  .
(Привилегированный доступ)
API требует привилегированного доступа к устройству, на котором выполняется код.
(Сертифицированный код)
API работает исключительно с сертифицированным кодом.

Все эти метки — не повод не включать в статью таблицу совместимости! Она должна присутствовать всегда. 

Тип меток "Уровень подготовки читателя"

Метки этого типа используются только для учебников и руководств (т.е. для страниц с меткой Guide). Они предназначены помочь читателю выбрать руководство, подходящее им по уровню знаний о данной технологии. Всего таких меток три:

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

Тип меток "Метаданные страницы"

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

Статья ещё не дописана  и всё ещё находится в разработке - хотя бы чисто теоретически (впрочем, может оказаться, что она была заброшена). Прежде чем вносить правки в такую статью, попробуйте связаться с теми, кто вносил изменения до вас — чтобы случайно не "вклиниться" в работу, которая ещё в процессе, и не внести таким образом путаницу. 
В статью необходимо добавить таблицу совместимости описываемой технологии с разными браузерами.
Это либо статья-"заглушка", либо в ней не хватает части информации. Надо, чтобы кто-нибудь просмотрел статью и дополнил/завершил её.
Для статьи нужно сделать один или несколько примеров, иллюстрирующих то, что в ней написано. Для примеров лучше использовать систему действующих образцов.
В статье есть примеры, которые надо переоформить под систему действующих образцов.
The article needs improvement to the page markup (usually because the page content consists mostly or entirely of <p> tags).
The article needs a table to indicate on which specification document(s) the feature was defined.
Содержимое устарело и нуждается в обновлении.
Содержимое не сто́ит перевода и не будет появляться в статистике локализации.
Содержимое важно и имеет наивысший приоритет для переводчиков MDN. В статистике локализации выделяется в отдельную таблицу самого важного.

Собираем всё воедино

Итак, каждой странице можно присвоить метки сразу нескольких типов. Например:

Учебник по WebGL для начинающих
WebGL, Graphics, Guide, Beginner
Справочная страница по элементу <canvas>
Canvas, HTML, Element, Graphics, Reference
Главная страница по средствам разработки Firefox OS
Tools, Firefox OS, Landing

Метки и поисковые фильтры

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

(Поисковые фильтры работают только для wiki-сайта; на read-only поиск настроен иначе, там фильтры не используются).

Примечание: Если в колонке «Метки» указано несколько меток, это значит, что фильтр найдёт статью с любой из этих меток.

Группа фильтров Название поискового фильтра Метки
Темы API и DOM  ||  
CSS
Canvas
Firefox
Firefox OS
HTML
HTTP
JavaScript
Marketplace
MathML
SVG
Web Standards
WebExtensions
WebGL
XPCOM 
XUL
Веб-разработка
Дополнения и расширения || || ||  ||
Игры
Мобильная версия
Написание документации
Создавайте веб-приложения
Уровень Я — эксперт
Средний
Я новичок
Тип документа Docs Ограничивает поиск до документации, оставляя вне поиска хаки и другое содержимое МДН.
Demos Этот тип документации больше не используется на MDN Web Docs.
Инструменты
Примеры кода
Руководство
Профили разработчиков Включает в результат поиска профили разработчиков сайта МДН.
Внешние ресурсы Команда разработчиков всё ещё разбираемся с этим...

Проблемы с метками, которые вы можете починить

Существует несколько видов проблем с тегами, и Вы можете помочь их решить:

Нет меток
Как правило, статьи должны иметь по крайней мере один тег типа "Категория" и один тег типа "тема". Обычно другие теги тоже уместны, но если Вы можете помочь нам свести число тегов к минимуму, Вы будете герой документации!
Метки не соответствуют нашим стандартам меток
Просим исправлять любые документы, чьи метки не соответствуют описанным здесь стандартам.
Примечание: из-за бага в Kuma, на некоторых английских страницах появлялись переведённые метки (такие как Référence). Они обычно появляются снова даже после удаления, поэтому не возитесь с их исправлением, пока не исправят баг в Kuma.
Неправильные метки
Если вы смотрите на статью о HTML и она  помечена как  "JavaScript", это, вероятно, неправильно! Точно так же, если статья обсуждает Mozilla, но имеет тег «Web», это, вероятно, неправильно тоже. Удалить эти теги и добавить нужные теги, если они уже не существуют. Просьба также исправить метки с ошибками (например, "Javascript" будет по-прежнему соответствовать, поскольку метки не чувствительны к регистру, но давайте не будем неаккуратными!).
Отсутствующие метки
Если статья содержит не все теги, что должны быть, не стесняйтесь добавлять больше.
Например, если страница с JavaScript ссылками (правильно) помечена как "JavaScript" и больше ничего, вы можете добавить этой странице тег "ссылки".
Спам в метках
Эта коварщина — самая отвратительная проблема: иная веб-нечисть таким путём внедряет свой помёт в теги страницы (например, «Бесплатный варез!» или «Hi, я ходил по вашему сайту и хотел спросить вас, не поможете ли вы мне решить мою проблему: у меня флэш постоянно падает»). Такие «метки» надо удалять сразу же! Они неприятны, с ними трудно справиться, если позволить им накопиться, и они ужасно вредны с точки зрения SEO.

Если увидите одно (или более) из этих проблем, пожалуйста, войдите в MDN и нажмите кнопку Редактировать в правом верхнем углу окна. После того, как редактор загрузится, прокрутите до нижней части страницы, где увидите поле "метки". Для получения более подробной информации по интерфейсу меток см. раздел "теги" в руководстве для авторов статей MDN editor guide.