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

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

Об использовании пользовательского интерфейса для редактирования меток на страницах см. в tagging section руководства для авторов статей.

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

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

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

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

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

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

Категория

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

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

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

Tема

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

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

HTML
CSS
JavaScript (обратите внимание на большую букву «S»!)
Document
DOM
API для каждого интерфейса, метода и свойства
Method для каждого метода API
Property для каждого свойства API
Graphics
Firefox OS
Gecko
XUL
XPCOM
SVG
WebGL
Element
Node
Tools
Web

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

Статус технологии

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

Возможные значения этих меток:

Non-standard (Нестандартная): Указывает, что технология или API, описываемая на данной странице, не является частью стандарта, но считается стабильной в броузере или броузерах, поддерживающих её реализацию. Если Вы не используете эту метку, читатель ошибочно решит, что речь идёт о чём-то стандартизированном. Таблица совместимости на странице должна пояснять, какие конкретно броузеры поддерживают данную технологию или API.
Deprecated (Устаревшая): Технология или API, описываемая на данной странице, в спецификации помечена как устаревшая и, возможно, вскоре будет удалена, хотя пока ещё доступна в текущих версиях броузеров.
Obsolete (Рудиментарная): Технология или API считается рудиментарной и удалена (либо находится в процессе удаления) из большинства современных броузеров.
Experimental (Экспериментальная): Технология в настоящее время не стандартизована и является экспериментальной, в будущем может стать или не стать частью стандарта. Её существующая реализацая (обычно единственная) может измениться.
Needs Privileges (Привилегированный доступ): API требует привилегированного доступа к устройству, на котором выполняется код.
Certified Only (Сертифицированный код): API работает исключительно с сертифицированным кодом.

Эти метки — не повод не включить в статью таблицу совместимости!

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

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

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

Метаданные страницы

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

junk (мусор): Статью надо удалить.
NeedsContent: Статья — заготовка, или в ней как-то ещё недостаёт информации. Надо, чтобы кто-нибудь просмотрел статью и дополнил или дописал её.
NeedsExample: Для статьи нужно сделать один или несколько примеров, иллюстрирующих то, что в ней написано. Для примеров лучше использовать систему действующих образцов.
NeedsLiveSamples: В статье есть примеры, которые надо переоформить под систему действующих образцов.
NeedsUpdate: Содержимое устарело и нуждается в обновлении.
l10n:exclude: Содержимое не сто́ит перевода и не будет появляться в статистике локализации.
l10n:priority: Содержимое важно и имеет наивысший приоритет для переводчиков MDN. В статистике локализации выделяется в отдельную таблицу самого важного.

Карта веб грамотности

WebMaker проект, который через карту веб грамотности, определил навыки, необходимые для оптимального чтения, записи и использования в Интернете. Мы используем навыки веб-грамотности, как метки на MDN, чтобы помочь пользователям найти ресурсы, которые наилучшим образом соответствуют их потребностям:

Navigation (Навигация): В статье содержится информация о том, как ходить по веб-страницам
WebMechanics: Информация о том, как устроена Всемирная паутина и как она работает
Search (Поиск): Статья объясняет, как находить в Вебе информацию, людей и ресурсы
Credibility: Информация в статье поможет читателю понять, как критически оценивать информацию, находимую в Вебе
Security (безопасность): В статье приводится информация о том, как сохранить системы, идентичностей, и содержимое сейфа.
Composing: В документе объясняется, как создать и курировать контент для интернета.
Remixing: Статья учит, как модифицировать существующие веб-ресурсы, чтобы создавать что-то новое.
Design: Документация, разъясняющая, как повысить уровень визуальной эстетики и пользовательский опыт.
Accessibility: Документы, в которых описывается, как общаться в универсально-узнаваемом образе.
CodingScripting: Как написать код и/или для создания интерактивных проектов в Интернете.
Infrastructure: Документ объясняет, как работает техническая укладка Интернета.
Sharing: Содержание статьи охватывает способы создания ресурсов с другими.
CollaboratingВ документе содержится информация о том, как работать с другими людьми.
Community: В статье подробно описано, как вступать в сетевые сообщества и понять, как они работают.
Privacy: Материал помогает рассмотреть последствия предоставления данных онлайн..
OpenPractices: В статье говоритя о том, как помочь сохранить Web общедоступными

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

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

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

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

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

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

Группа фильтров	Название поискового фильтра	Метки
Темы	Open Web Apps	Apps
	HTML	HTML
	CSS	CSS
	JavaScript	JavaScript
	API и DOM	API
	Canvas	Canvas
	SVG	SVG
	MathML	MathML
	WebGL	WebGL
	XUL	XUL
	Marketplace	Marketplace
	Firefox	Firefox
	Firefox для Android	Firefox Mobile
	Firefox для настольных компьютеров	Firefox Desktop
	Firefox OS	Firefox OS
	Mobile	Mobile
	Веб-разработка	Web Development
	Дополнения и расширения	Add-ons \|\| Extensions \|\| Plugins \|\| Themes
	Игры	Games
Уровень	Я — эксперт	Advanced
	Средний	Intermediate
	Я новичок	Beginner
Тип документа	Docs	Это ограничивает поиск в содержимом документов, оставляя вне поиска хаки и другое содержимое МДН.
	Demos	Это включает в результат поиска контент демо-студии.
	Инструменты	Tools
	Примеры кода	Example
	Уроки	Guide
	Профили разработчиков	Это включает в результат поиска профили разработчиков сайта МДН.
	Внешние ресурсы	Команда разработчиков всё ещё разбираемся с этим...

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

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

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

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