Add index.rst and changed format

ee459812 · Talgat Mustafinov · 6df7b856 · 6df7b856 · ee459812 · 6df7b856
Commit ee459812 authored Mar 04, 2026 by Talgat Mustafinov
6 changed files
--- a/check-lists.md
+++ b/check-lists.md
-# Чек-листы
---
-## Чек-листы о выполнении требований
-### Платформа ARTA Synergy
-| # | Требование | Подтверждение выполнения |
-|---|---|---|
-| 1 | Платформа ARTA Synergy развернута на промышленном серверном оборудовании, соответствующем рекомендациям для используемой версии Платформы | Описание соответствия или расхождения конфигурации серверного оборудования с рекомендациями в спецификации |
-| 2 | Платформа ARTA Synergy должна быть развернута на промышленном серверном оборудовании обеспеченным источником бесперебойного питания и системой корректного выключения серверного оборудования, обеспечивающей штатное безопасное выключение оборудование в случае аварийного отключения питани | Подтверждение отсутствия аварийного выключения; системный лог с аптаймом за день до и на время возникновения неполадок |
-| 3 | Платформа ARTA Synergy развернута на сервере имеющем в штатном режиме эксплуатации запас в 20% от общего объема оперативной памяти без учета использования дискового кэша | Подтверждение соблюдения требований об использовании и лог использования оперативной памяти за день до и на время возникновения неполадок |
-| 4 | Платформа ARTA Synergy развернута на сервере имеющем не менее 10 Гб свободного дискового пространства на каждом разделе, используемом платформой для записи | Подтверждение соблюдения требований об использовании и лог использования дискового пространства за день до и на время возникновения неполадок |
-| 5 | Платформа ARTA Synergy функционирует с использованием актуальной версии базы данных, процессов и индексов | Подтверждение соблюдения требований об использовании Платформы, скриншоты содержащие информацию о текущей версии и актуальности версии бд, процессов, индекса |
---
-## Чек-лист для заявки «Инцидент (программная ошибка)»
-| # | Требование | Подтверждение выполнения |
-|---|---|---|
-| 1 | Пройти чек-лист о выполнении требований промышленной эксплуатации | Пройденный чек-лист для [промышленного серверного оборудования](https://tdd.lan.arta.kz/docs/synergy/tags/simon/checklist/html/rules_checklists.html#reqs.platform) и [платформы ARTA Synergy](https://tdd.lan.arta.kz/docs/synergy/tags/simon/checklist/html/checklists.html#checklists.platform) |
-| 2 | Локализовать функциональность, содержащую ошибку | Пошаговое описание сценария воспроизведения ошибки |
-| 3 | Найти описание поведения данной функциональности в официальной документации для используемой версии Платформы | Ссылка на раздел документации и соответствующая цитата |
-| 4 | Определить воспроизводимость ошибки | Подтверждение воспроизводимости на другом экземпляре Платформы с той же версией; либо экспортированная конфигурация объекта с ошибкой, не воспроизводимой на другом экземпляре |
-| 5 | Определить дату возникновения ошибки | - Выдержка из лога с момента запуска Платформы до завершения запуска; <br> - Выдержка из лога, включающая момент появления ошибки, а также записи за 30 минут до и после |
-| 6 | Определить обходной путь | Описание альтернативных способов выполнения необходимого действия в Платформе |
---
-## Чек-лист для заявки «Критическая ошибка»
-| # | Требование | Подтверждение выполнения |
-|---|---|---|
-| 1 | Пройти чек-лист о выполнении требований промышленной эксплуатации | Пройденный чек-лист для [промышленного серверного оборудования](https://tdd.lan.arta.kz/docs/synergy/tags/simon/checklist/html/rules_checklists.html#reqs.platform) и [платформы ARTA Synergy](https://tdd.lan.arta.kz/docs/synergy/tags/simon/checklist/html/checklists.html#checklists.platform) |
-| 2 | Определить дату возникновения ошибки | - Выдержка из лога с момента запуска Платформы до завершения запуска; <br> - Выдержка из лога, включающая момент появления ошибки, а также записи за 30 минут до и после |
-| 3 | Определить условия воспроизводимости ошибки | Описание условий воспроизводимости (внешних событий, особенностей процесса использования Платформы) |
-| 4 | При использовании ЭЦП — применять только валидные ключи, безопасность которых не скомпрометирована | Скриншот с информацией о проверке используемого ключа |
-| 5 | Подтвердить наличие одного из критических факторов: <br> - падение процесса JVM; <br> - ошибка сегментации; <br> - переполнение стека; <br> - завершение процесса подсистемой OOM-killer; <br> - нехватка памяти JVM; <br> - отсутствие ответов на HTTP-запросы (вход, API и др.) | Подтверждение наступления одного из перечисленных факторов |
-| 6 | Убедиться, что сбой не вызван ошибками конфигурации Платформы | Листинг конфигурационных файлов с названиями и датами изменений в директориях: <br> `/opt/synergy/jboss/standalone/configuration` <br> `/opt/synergy/jboss/standalone/deployments` <br> с обоснованием недавних изменений |
-| 7 | Обеспечить доступ к промышленному серверному окружению с воспроизводящейся критичной ошибкой подписями допускается использование только валидных ключей, безопасность которых не скомпрометирована | Предоставить доступ с полными правами к промышленному серверному окружению с воспроизводящейся критичной ошибкой на адрес security_ctkdrt@arta.pro |
---
-## Чек-лист для заявки «Консультация»
-| # | Требование | Подтверждение выполнения |
-|---|---|---|
-| 1 | Изучить документацию по данному вопросу на [TDD](http://tdd.lan.arta.kz/docs/) | Ссылка на раздел документации и соответствующая цитата |
-| 2 | Изучить вопрос на внешних веб-ресурсах ² | Найденная релевантная информация |
-| 3 | Изучить базу имеющихся заявок по данному вопросу (Модуль: Хранилище → Реестры → Архив обращений) | Перечень номеров заявок со схожей проблемой; описание отличий текущего вопроса от уже решённых |
-| 4 | Исследовать вопрос путём проверок и экспериментов | Описание выполненных действий при исследовании |
-| 5 | Проконсультироваться с коллегами, сертифицированными по данной теме | Описание полученной информации |
-| 6 | Определить категорию вопроса согласно каталогу услуг | Указать категорию вопроса |
-> ² Пункт является необязательным.
\ No newline at end of file
--- a/check-lists.rst
+++ b/check-lists.rst
--- a/decision-tree.md
+++ b/decision-tree.md
--- a/decision-tree.rst
+++ b/decision-tree.rst
--- a/index.rst
+++ b/index.rst
+Регламент технической поддержки Arta
+========================================
+.. toctree::
+   :maxdepth: 2
+   :numbered:
+   support_policy
+   check-lists
+   decision-tree
\ No newline at end of file
--- a/support_policy.md
+++ b/support_policy.md
-# Политика технической поддержки SYNERGY
+Политика технической поддержки SYNERGY
+=======================================
---
-## 1. Назначение технической поддержки
+1. Назначение технической поддержки
+-------------------------------------
 Техническая поддержка SYNERGY предназначена для:
@@ -16,11 +17,13 @@
 - заменой проектирования или анализа бизнес-процессов;
 - неограниченным обучением или консалтингом.
---
+----
-## 2. Типы запросов, принимаемых технической поддержкой
+2. Типы запросов, принимаемых технической поддержкой
+------------------------------------------------------
-### 2.1. Инциденты (ошибки платформы)
+2.1. Инциденты (ошибки платформы)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 Инциденты — это ошибки и сбои **штатного функционала платформы SYNERGY**.
@@ -40,26 +43,31 @@
 - материалы для диагностики (логи, скриншоты, трассировки);
 - минимальный сценарий воспроизведения.
---
+----
-## 3. Тип запроса: Консультация
+3. Тип запроса: Консультация
+------------------------------
-### 3.1. Определение
+3.1. Определение
+~~~~~~~~~~~~~~~~
 **Консультация** — это запрос, не являющийся дефектом платформы, но требующий анализа, диагностики, пояснений или рекомендаций по использованию, архитектуре, эксплуатации или обновлению SYNERGY.
 Все консультации **расходуют часы технической поддержки**.
-### 3.2. Лимиты и учёт часов
+3.2. Лимиты и учёт часов
+~~~~~~~~~~~~~~~~~~~~~~~~~
 - В одну **dev-лицензию включено 4 часа технической поддержки в месяц**.
 - Часы учитываются по фактически затраченному времени.
 - Неиспользованные часы **не переносятся** на следующий период.
 - После исчерпания лимита:
  - работа над консультационными запросами **приостанавливается**;
  - продолжение возможно **только на платной основе** по действующему прайс-листу.
-### 3.3. Приостановка работы по консультации
+3.3. Приостановка работы по консультации
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 Работа по консультационному запросу автоматически приостанавливается, если:
@@ -69,30 +77,37 @@
 Техническая поддержка не обязана завершать консультацию в рамках включённого лимита, если объём анализа превышает доступные часы.
---
+----
-## 4. Допустимые типы консультационных запросов
+4. Допустимые типы консультационных запросов
+----------------------------------------------
-### 4.1. Локализация ошибок и диагностика производительности
+4.1. Локализация ошибок и диагностика производительности
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 **Назначение:** Определение слоя и участка возникновения проблемы.
 **Содержание:**
 - локализация проблемы по слоям:
  - инфраструктура;
  - приложение;
  - IDE;
  - Core;
 - диагностика на основе:
  - Diagnostic Decision Tree;
  - Synergy Health;
  - Synergy Benchmark;
  - Synergy Profiler;
 - первичная и углублённая диагностика;
 - формулировка причины и рекомендаций по устранению.
-### 4.2. Консультации по архитектуре и разработке приложения
+4.2. Консультации по архитектуре и разработке приложения
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 **Назначение:** Поддержка корректного применения возможностей SYNERGY.
@@ -104,7 +119,8 @@
 - разбор типовых ошибок проектирования;
 - консультации на основе официальных учебных материалов и документации.
-### 4.3. Сопровождение обновлений и эксплуатации
+4.3. Сопровождение обновлений и эксплуатации
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 **Назначение:** Снижение рисков при обновлении и эксплуатации платформы.
@@ -115,7 +131,8 @@
 - диагностика проблем после обновлений;
 - консультации по эксплуатации (резервное копирование, мониторинг, профили нагрузки).
-### 4.4. Поддержка и консультационное обучение
+4.4. Поддержка и консультационное обучение
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 **Назначение:** Повышение самостоятельности пользователей платформы.
@@ -126,9 +143,10 @@
 - помощь в освоении инструментов SYNERGY;
 - ускорение выхода к продуктивной работе.
---
+----
-## 5. Запросы, которые не принимаются и отклоняются
+5. Запросы, которые не принимаются и отклоняются
+--------------------------------------------------
 Техническая поддержка **не обрабатывает** следующие типы запросов:
@@ -139,15 +157,17 @@
 - вопросы, полностью покрытые документацией и учебными материалами;
 - запросы без предоставления данных, необходимых для диагностики.
---
+----
-## 6. Главная цель технической поддержки
+6. Главная цель технической поддержки
+---------------------------------------
 Главная цель технической поддержки SYNERGY:
 - быстро помочь решить техническую проблему;
 - точно локализовать источник проблемы (инфраструктура / приложение / IDE / Core);
 - предоставить обоснованные рекомендации по устранению на основе:
  - Diagnostic Decision Tree;
  - Synergy Health;
  - Synergy Benchmark;
@@ -155,9 +175,10 @@
 Техническая поддержка предоставляет **технологическую помощь и консультации**, но не принимает на себя ответственность за архитектуру, проектные решения и результаты внедрения.
---
+----
-## 7. Принципиальная граница ответственности
+7. Принципиальная граница ответственности
+-------------------------------------------
 Если запрос: