КИС

Эта страница только для чтения. Вы можете посмотреть её исходный текст, но не можете его изменить. Сообщите администратору, если считаете, что это неправильно.
[[:start#модули_пользовательская_документация|🏠 Стартовая страница]]\\

====== Правила написания документации ======

===== Шаблоны документации =====

Все документы требуется составлять по единому стандарту в соответствии с утвержденными шаблонами.\\ 
Шаблоны для работы и подготовки документации для каждого типа документа можно найти и скачать в КИС, в разделе "[[https://inkoteka.inko-center.ru/users/sys_docs/main/view/|Документация систем]]", в заголовке таблицы "Подсистемы и модули".
Скачать шаблон можно с помощью ссылки "Скачать образец".\\
\\
Обратите внимание, что для каждой системы "КИС", "Инкометрия", "Инкотека", "ИНКО-ЗП" используются свои шаблоны.\\
\\
Всю работу над документом необходимо производить в файле шаблона, загруженного из из модуля "Документация систем".
Данные которые необходимо изменять для документов каждой подсистемы или модуля отмечены красным.\\
\\
При работе с документами в текстовом редакторе MS Word настоятельно рекомендуется включать обязательное отображение скрытых знаков форматирования (пробелов, абзацев и других скрытых знаков форматирования) (Ctrl+*). 

===== Оформление технической документации =====

Оформление технической документации производится в соответствии с установленными в ИНКОЦентре правилами оформления документов.\\

==== Шрифты ====

Основной используемый шрифт: Times New Roman\\
Размер шрифта основного текста: 14пт\\
Размер шрифта заголовков титульного листа: 18пт\\
Размер шрифта заголовков первого (верхнего) уровня: 16пт\\
Размер шрифта заголовков второго уровня: 14пт\\
Размер шрифта подписей к рисункам: 14пт (курсив)
\\
Допускается использование полужирного и курсивного выделений в тексте.\\

==== Междустрочные интервалы ====

Используемый междустрочный интервал основного текста документов: полуторный (1,5 строки).\\ 

==== Выравнивание текста ====

Выравнивание основного текста: по ширине, отступ первой строки на 1,25 пт.\\

===== Типы документации =====

Полный пакет документации, описывающей систему, подсистему или модуль составляют **пять** документов:\\
  * Техническое задание
  * Руководство пользователя
  * Программа и методика испытаний
  * Протокол испытаний
  * Ведомость эксплуатационных документов


===== Техническое задание =====

==== Даты ====

В разделе 2.4. необходимо установить дату начала разработки (она же - дата написания Технического задания) и дату окончания разработки (обычно в течение месяца после начала разработки, либо можно указать фактические сроки, если нормативными документами не предусмотрено иное).

==== Формулировки ====

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

==== Структура ====

В начале Технического задания необходимо описать цель создания модуля (зачем он будет использоваться).\\
Далее необходимо указать базовые доступы.\\
После этого необходимо описать все страницы, которые нужно создать.\\
Цель создания модуля, базовые доступы и каждую из страниц нужно делать заголовками, чтобы они автоматически подтягивались в оглавление.

==== Доступы ====

Доступы описываются в следующем формате:

<code>Доступ к страницам модуля предоставляется:
название_роли_или_группы - полный доступ (просмотр, администрирование групп учреждений, выгрузка в Excel);
Остальные сотрудники ИНКОЦентра - доступ на просмотр и выгрузку в Excel.
(и т.д.)
Доступ для сотрудников Департамента культуры города Москвы не предусмотрен.
Доступ для сотрудников учреждений не предусмотрен.</code>

Принцип - перечислить все роли с подробным указанием, что им можно, а что нельзя.\\
Если кому-то из ИНКОЦентра, ДКгМ и учреждений доступ закрыт - указать, что он закрыт.

==== Связь с другими модулями ====

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

===== Руководство пользователя =====

==== Ссылка на модуль ====

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

==== Доступы и цель создания модуля ====

Раздел "Доступы" должен быть продублирован из Технического задания и также находиться ближе к началу Руководства.

Раздел "Цель создания модуля" также необходимо указать аналогично Техническому заданию.
==== Разделение на блоки ====

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

==== Скриншоты ====

В Руководстве пользователя обязательно наличие скриншотов из модуля.

__Не допускается__ наличие в скриншотах персональных данных.

==== Связь с другими модулями ====

Если модуль использует информацию из других модулей (или, наоборот, выгружает ее туда), об этом необходимо написать в Техническом задании (достаточно указания на информацию и модули) и в Руководстве пользователя (необходима схема действий либо отсылка к Руководству пользователя соответствующего модуля, если оно существует).
===== Программа испытаний =====

==== Первый сценарий ====

1-й сценарий для всех систем (кроме системы "Инкотека") должен проверять базовые доступы и возможности модуля. Т.е. необходимо перечислить попытки входа в модуль от имени пользователей как минимум следующих групп:
   * Сотрудник ИНКОЦентра
   * Сотрудник ДКгМ
   * Сотрудник учреждения

==== Формулировки ====

Помните, что вы пишете не Положение об испытании, а Программу испытаний. Формулировки не должны быть абстрактными.

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

__Не допускается__ формулировка вида "Результаты работы выводятся на экран". Примерные варианты более точных формулировок:
  * Выводится полный перечень учреждений, выводятся столбцы (указать перечень столбцов) для 2019, 2020 и 2021 года.
  * Выводится список заявок, отфильтрованный по театрам и концертным учреждениям.
  * Отображается окно с информацией о помещении (адрес, площадь, вид права).

__Не допускается__ формулировка вида "выбрать необходимую дату", "выбрать необходимый вид учреждения". Для даты необходимо указать конкретную дату в окрестности даты создания модуля (если по смыслу не требуется другая дата), т.е. правильная формулировка - "выбрать дату 01.06.2021". 

Для видов учреждения укажите "выбрать вид учреждения Театры". Если вы выбираете одно учреждение - укажите любое действующее на момент создания модуля учреждение, __кроме ИНКОЦентра и управленческих учреждений__. Если вы выбираете несколько учреждений поштучно, допускается написать "выбрать несколько учреждений", а в графе "Результат" - "информация по соответствующим учреждениям".

При описании сценария загрузки файлов, мы добавляем слово "тестовый". Тестовый файл в формате word, Тестовый файл в формате pdf. Поскольку при тестировании реальных пока все равно нет.

Стандартные используемые формулировки:
  * Войти в систему как пользователь с ролью ...
  * Открывается/отображается страница ...
  * Пользователь перенаправляется на главную страницу КИС (нет доступа к запрашиваемой странице).

==== Результат ====

В графе "Результат" указываются:
  * изменения в базе данных, если они произошли;
  * отображаемая информация по результатам Действия;
  * способ проверки изменений в базе данных, если они не содержатся в отображаемой информации.

Недостаточно указать "Заявка перешла в статус Выполнено". Необходимо добавить "На экране отображается статус заявки Выполнено".

==== Доступ от имени учреждения ====

Если в Программе испытаний тестируется вход под учреждением, то необходимо выбирать любое учреждение, кроме ИНКОЦентра и управленческих учреждений.

При первом упоминании внутри одного сценария необходимо указать "Войти в систему как пользователь учреждения МГС Эрмитаж (далее - Учреждения)". И далее указывать действия "от имени пользователя Учреждения".
===== Протокол испытаний =====

Протокол испытаний практически повторяет программу испытаний.

Если комментариев по результатам испытаний комиссией не вносилось, то в разделе 7 "Комментарии по результатам испытаний" формулировку следует заменить следующим образом: "По результатам испытаний комиссией комментариев не вносилось". Если комментарии есть, то следует описать данные комментарии.

Если комментариев и ошибок по результатам испытаний не обнаружено, то в разделе 9 "Заключения комиссии" необходимо убрать слова "с замечаниями" из фразы "Функциональные требования выполнены в полном объеме с замечаниями".

Состав комиссии, принимающей протокол испытаний, менять не надо!