1. Общие положения


1.1. Документация выпускается ко всем продуктам компании, передавваемым третьим лицам.

1.2. Документация содержит необходимые сведения по обращению с программными продуктами ЮСИЭС, а также со связанным сторонним ПО и оборудованием (в пределах их участия в работе ПО ЮСИЭС).

1.3. Документация может быть нескольких видов:

1.3.1. Техническая (для инженеров)

1.3.2. Пользовательская

1.3.2.1. Этот вид документов предназначается для конечных пользователей, и описывает работу с тем функционалом продукта, ради которого программы были приобретены.

1.3.3. Административная

1.4. Процесс создания и распространения технической документации в компании ЮСИЭС подлежит реформированию.

1.5. Основные принципы документирования:

1.5.1. Оригинал документа хранится только в одном местоположении, и не копируется на другие сайты.


2. Участники и их функции


2.1. В процессе создания, изменения и применения документации участвуют различные сотрудники компании, в пределах их компетенции.

2.2. Роли и должности:

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

2.3. Особая роль отводится техническим писателям.

2.3.1. Технические писатели занимаются сбором информации от инициаторов документирования, авторов; публикацией и оформлением документов.

2.4. Инициаторы документирования - это любые сотрудники компании, которым стало известно о необходимости создания или изменения документации.

2.4.1. Инициатор является пользователем системы tracker.ucs.ru, где и осуществляет операции для инициации работы над документами.

2.4.2. Инициатор находит задачу, где содержится информация для документирования, и меняет в ней свойста, описанные в п. 3.2.2. ниже.

2.4.2.1. В отдельных проектах, где предусмотрены "кнопки", следует использовать их ("Обновить ТД" и "Обновить ПД") для проставления свойств.

2.4.3. Инициатор может добавлять в той же самой задаче разъяснительные (скрытые) комментарии, в случае необходимости.

2.4.4. Отдельные задания "для документирования" не создавать.


3. Информационные системы


3.1. Основной системой для публикации и распространения документации является support.ucs.ru

3.2. Основной системой для передачи информации (содержания) для создания и изменения документации, а также для организации работы сотрудников над документацией является tracker.ucs.ru

3.2.1. Технический писатель (при необходимости и администратор сайта) использует специальные фильтрованные отчёты в системе tracker.ucs.ru для построения плана работ по обновлению документации.

3.2.2. В системе tracker.ucs.ru заведены специальные свойства в задачах, которые используются для документирования:

3.2.2.1. Резюме - обязательное к заполнению поле во всех задачах, находящихся в финальном статусе.

3.2.2.2. Обновить ТД - свойство задачи, которое должны включить инициаторы, чтобы отдел технического документирования начал доработку документации, в соответствии с Резюме этой задачи (и прочим её содержанием).

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

3.2.3. В рассмотрение попадают только задачи, статус которых финишный: решено, реализовано, закрыто.

3.3. Дополниельные источники данных для инструкций:

3.3.1. Источники информации о новых и изменённых продуктах: tracker.ucs.ru int.ucs.ru ftp.ucs.ru apidocs.ucs.ru

3.4. Документация из всех прочих систем подлежит переносу в support.ucs.ru

3.4.1. При переносе документов с других сайтов на support.ucs.ru, исходный документ помещается в архив, файл или страница удаляется из старого местоположения.

3.5. Система support.ucs.ru предоставляет контроль доступа к содержимому (документам).

3.5.1. Пользователи импортируются (авторизуются) через единую систему компании ЮСИЭС.

3.5.2. Пользовали разграничены в доступе по следующим уровням (ролям):

# уровень права
1 Публичный Чтение некоторых страниц (L1), чтение форума
2 Пользователь Чтение некоторыхстраниц (L2), писать на форуме
3 Дилер Чтение некоторыхстраниц (L3), писать на форуме
4 Сотрудник UCS Чтение всех страниц (L4), писать на форуме
5 Инженер UCS Чтение всех страниц (L4), создавать страницы и редактировать их, писать на форуме
6 Модератор UCS Чтение всех страниц, создавать страницы и редактировать их, публиковать документы (созданные другими), изменять документы, писать и исправлять на форуме
7 Администратор UCS Может делать всё

4. Процессы переработки данных


4.1. Создание новых статей

4.2. Обновление содержания существующих (ранее опубликованных) документов

4.3. Оформление существующих (ранее опубликованных) документов

4.4. Отслеживание изменений в информационных системах

4.4.1. Технические писатели отслеживают с помощью специальных отчётов основные проекты разработки ПО в системе tracker.ucs.ru по полю "Резюме", с целью выявления изменений, требующих документирования.

4.4.1.1. Описание изменений встречается в тексте комментариев в задаче на доработку, кроме резюме.

4.4.1.2. Отличают изменения (правки), не требующие документирования (не изменяющие функцинал и интерфейс ПО).

4.4.1.3. Исследуется Readme и ChangeLog (если есть). Смотрятся комментарии разработчика в INI и XML файлах внутри дистрибутива.

4.4.1.4. Запрашиваются разъяснения от разработчиков ПО и менеджеров продукта.

4.4.1.5. Проверяется соответствие ТД (инженерное описание) и ПД (руководство пользователя) друг другу.

4.4.1.6. Проверяются источники в дополнительных системах (int.ucs.ru apidocs.ucs.ru)

4.4.1.7. Опрашиваются тестировщики ПО (устно и письменно)

4.4.2. Методы перемещения информации ручные:
услышать-записать,
сфотографировать-сохранить,
скопировать-вставить
эмпирически
самостоятельное тестирование