Правила заполнения тикетов для docs

Конечный результат:

• Конечный результат - что нужно сделать? Здесь задается основная тема новой статьи для дополнения документации, а также вкратце указываются условия которые нужно учесть или варианты выполнения задачи при необходимости.

• Пример Создать краткую статью в вики по Docker с дополнительными ссылками на информацию по разделам

План решения:

• Описаниe создания, дополнения или редактирования статьи документации с упоминанием всех предметов, необходимых для упоминания в документации и относящейся к заданной теме. Также здесь можно указать необходимую дополнительную информацию

• Пример Добавить краткое описание Docker, проблемы, которые он решает и варианты применения.
• Пример Описать подробное руководство по установке Docker для Linux
• Пример Добавить ссылки с руководством по установке Docker для других операционных систем
• Пример Добавить ссылки с наиболее часто встречающимися ошибками при установке

Мотивация:

• Мотивация - для чего необходима статья в документации по данной теме? Здесь описываются причины, по которым нам необходимо иметь описание данной темы, целевая аудитория и задачи, которые могут быть решены помимо основной - информирования.

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

Критерии приемки:

• Критерии приёмки - как проверить, что задача выполнена. Здесь указываются пункты, которые читатель должен увидеть в статье, а также ответ на поставленную задачу, которая была обозначена. Если статья добавляется в виде вложенной библиотеки, также можно описать ожидаемую структуру навигации по пунктам статьи.

• Пример: В меню документации в разделе библиотека, при переходе по теме Docker, открывается страница с кратким описанием Docker, его архитектуры и руководством по установке. В конце статьи есть ссылки на документацию Docker.

Планируемое время выполнения:

• Описать примерное планируемое время выполнения данного тикета.

• Пример 2 часа

Пример для title:

Создать краткую статью в вики по Docker

Пример для body:

## Конечный результат:
* Создать краткую статью в вики по Docker с дополнительными ссылками на информацию по разделам

## План решения:
* Добавить краткое описание Docker, проблемы, которые он решает и варианты применения.
* Описать подробное руководство по установке Docker для Linux
* Добавить ссылки с руководством по установке Docker для других операционных систем
* Добавить ссылки с наиболее часто встречающимися ошибками при установке

## Мотивация:
* Данная статья доказывает принципиальное преимущество применения Docker для нашего проекта разработчикам, приступающих к поддержке или расширению проекта.

## Критерии приемки:
* В меню документации в разделе библиотека, при переходе по теме Docker, открывается страница с кратким описанием Docker, его архитектуры и руководством по установке. В конце статьи есть ссылки на документацию Docker.

## Планируемое время выполнения:
* 1 час