---

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

= Правило именования категорий =

== Категория модуля ==

Формат:
 <Название системы> - <Название модуля>

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

Синтаксис на странице:
 [[Категория:<Название системы> - <Название модуля>]]

== Категория типа ошибки ==

Формат:
 <Название системы> - <Тип ошибки>

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

Допустимые значения «Тип ошибки» (закрытый список, расширяется только через согласование):

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

Синтаксис на странице:
 [[Категория:<Название системы> - <Тип ошибки>]]

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

= Правило именования страниц =

== Статьи-ошибки ==

Формат заголовка страницы:
 [<Название модуля>] <Краткое описание симптома>

== Карточки модулей ==

Формат заголовка страницы:
 <Название модуля> (обзор)

== Хаб-страницы модулей ==

Формат заголовка страницы:
 Хаб: <Название модуля>

= Правило именования тегов =

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

* module:<код_модуля> — короткий машинный код модуля, латиницей, без пробелов
* type:<код_типа_ошибки> — короткий машинный код типа ошибки из списка выше
* severity:<critical|high|medium|low>
* status:<active|resolved|wontfix|investigating>

Список допустимых значений module: и type: ведётся в разделе «Реестр кодов» настоящей страницы и не может расширяться без согласования с ответственным за структуру базы.

= Формат кода ошибки =

 <ПРЕФИКС_МОДУЛЯ>-<ПРЕФИКС_ТИПА>-<НОМЕР>

где:

* ПРЕФИКС_МОДУЛЯ — сокращение названия модуля, 3–6 символов, латиницей, фиксируется в Реестре кодов
* ПРЕФИКС_ТИПА — сокращение типа ошибки согласно Реестру кодов
* НОМЕР — четырёхзначный порядковый номер в рамках комбинации «модуль + тип»

= Реестр кодов =

Таблица соответствия названий модулей, типов ошибок и их машинных кодов (module:, type:, префиксы для кода ошибки) ведётся на отдельной служебной странице и обновляется при добавлении нового модуля или изменении списка типов ошибок.

[[Категория:Служебные страницы]]