Регламент взаимодействия с Отделом Документации при написании/обновлении страницы

Внесение изменений в релизную версии

Редактирование черновика

1. Сервисный Центр VoIP заводит общую задачу в Redmine для всех последующих задач на документацию релизной версии.
2. Сервисный Центр VoIP и/или лаборатория IMS заводят задачу с правками для необходимого раздела в Redmine с тэгом doc, привязывают её к общей задаче на документацию, назначают на Отдел Документации (Анна Цой). И дальше вносят правки в документацию в пространстве Черновик ECSS-Documentation-3.14.
3. После внесения правок в черновик Сервисный Центр VoIP отписывается в задаче, что раздел подготовлен для вычитки и оформления нововведений Отделом Документации.
4. Отдел Документации вычитывает и вносит свои правки, отписывается о проверке в задаче и переводит её в статус Feedback.

5. Сервисный Центр VoIP повторно проверяет нововведения:

   1. если есть правки, переводят задачу в статус Re-opened и передают их Отделу Документации;

   2. если правок нет, переводит задачу в статус Closed и меняет тэг на doc_done. 

Обновление чистовика документации

Обычно актуализация документации происходит разом:

1. Сервисный Центр VoIP непосредственно перед релизом оповещает в общей задаче Отдел Документации о необходимости переноса документации в основное пространство и переводит общую задачу в статус Re-opened. 
2. Отдел Документации:
   1. создает отдельное пространство чистовика для релизной версии документации;
   2. копирует документацию из Черновик ECSS-Documentation-3.14 в созданное чистовое пространство и меняют версию руководства в черновике на новую;
   3. сообщает о переносе документации в общую задачу и переводит её в статус Resolved. 

3. Сервисный Центр VoIP проверяет корректность переноса:

   1. если есть правки, переводит задачу в статус Re-opened и передают их Отделу Документации;

   2. если правок нет, переводит задачу в статус Closed и меняет тэг на doc_done.

Внесение правок вне релиза

При необходимости обновления определенных страниц вне релиза:

1. Сервисный Центр VoIP создает задачу в Redmine на внесение правок в основное пространство и назначает её на Отдел Документации (Анна Цой).
2. После редактирования черновика Отдел Документации переводит задачу в статус Feedback.
3. Сервисный Центр VoIP проверяет нововведения и сообщает в задаче, что правки можно переносить в пространство чистовика, переводит задачу в статус Re-opened.

4. Отдел Документации сообщает о переносе документации в задачу и переводит её в статус Resolved.

   Основное пространство редактирует только Отдел Документации.

   
   

5. Сервисный Центр VoIP (QA) проверяет, что все сделано корректно, переводит задачу в статус Closed, поменяв тэг на doc_done.

Выгрузка в HTML (Web-help)

1. Сервисный Центр VoIP заводит задачи в Redmine на обновление Web-help.
2. Отдел Документации проверяет, что все внешние ссылки (на страницы, отличные от документации выгружаемого интерфейса) ведут на текущую документацию черновиков (docs.eltex-co.ru).
3. После чего выгружает два архива с помощью макроса Scroll HTML Exporter (This Page and Children, File Naming = Page ID Only, Build Search Index = off):
   
   • Расширенный режим web-конфигуратора;
   • Стандартный режим web-конфигуратора.

4. Архивы необходимо разархивировать и добавить в каждой странице тэги (используется блокнот или notepad ++ v.7 с кодировкой UTF + без BOM) target="_blank" и rel="noreferrer" после class="external-link"
Пример:

   <a class="external-link" target="_blank" rel="noreferrer" href="https://docs.eltex-co.ru/pages/viewpage.action?pageId=50983537">Управление пользователями (User manager)</a>

   
   

5. Разархивировать необходимо командой unzip, если делать это через интерфейс в ubuntu — меняется кодировка.
6. После чего папка снова архивируется и оба архива добавляются в соответствующие задачи.

7. Сервисный Центр VoIP повторно проверяет:

   1. если есть правки, переводят задачу в статус Re-opened и передают их Отделу Документации;

   2. если правок нет, переводит задачу в статус Closed и меняет тэг на doc_done.

Название снимков экрана

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