Различия

Показаны различия между двумя версиями страницы.

--- documentation:rules [2021/09/03 11:44] – [Формулировки] ilya
+++ documentation:rules [2026/05/08 14:32] (текущий) – petrk
@@ Строка 1: / Строка 1: @@
+[[: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 пт.\\
+===== Типы документации =====
+Полный пакет документации, описывающей систему, подсистему или модуль составляют **пять** документов:\\
+  * Техническое задание
+  * Руководство пользователя
+  * Программа и методика испытаний
+  * Протокол испытаний
+  * Ведомость эксплуатационных документов
 ===== Техническое задание =====
@@ Строка 55: / Строка 103: @@
 В Руководстве пользователя обязательно наличие скриншотов из модуля.
+__Не допускается__ наличие в скриншотах персональных данных.
 ==== Связь с другими модулями ====
@@ Строка 63: / Строка 113: @@
 ==== Первый сценарий ====
--й сценарий должен проверять базовые доступы и возможности модуля. Т.е. необходимо перечислить попытки входа в модуль от имени пользователей как минимум следующих групп:
+-й сценарий для всех систем (кроме системы "Инкотека") должен проверять базовые доступы и возможности модуля. Т.е. необходимо перечислить попытки входа в модуль от имени пользователей как минимум следующих групп:
    * Сотрудник ИНКОЦентра
    * Сотрудник ДКгМ
@@ Строка 71: / Строка 121: @@
 Помните, что вы пишете не Положение об испытании, а Программу испытаний. Формулировки не должны быть абстрактными.
+Если описывается сценарий содержащий такие действия как: "добавить новый тип документа", "создать систему", "осуществить поиск по строке", следует использовать конкретные и осмысленные названия типам документа, системам, осмысленный поисковый запрос, чтобы получить корректную формулировку.
 __Не допускается__ формулировка вида "Результаты работы выводятся на экран". Примерные варианты более точных формулировок:
@@ Строка 77: / Строка 129: @@
   * Отображается окно с информацией о помещении (адрес, площадь, вид права).
-__Не допускается__ формулировка вида "выбрать необходимую дату", "выбрать необходимый вид учреждения". Для даты необходимо указать конкретную дату в окрестности даты создания модуля (если по смыслу не требуется другая дата), т.е. правильная формулировка - "выбрать дату 01.06.2021". Для видов учреждения укажите "выбрать вид учреждения Театры". Если вы выбираете одно учреждение - укажите любое действующее на момент создания модуля учреждение, кроме ИНКОЦентра и управленческих учреждений. Если вы выбираете несколько учреждений поштучно, допускается написать "выбрать несколько учреждений", а в графе "Результат" - "информация по соответствующим учреждениям".
+__Не допускается__ формулировка вида "выбрать необходимую дату", "выбрать необходимый вид учреждения". Для даты необходимо указать конкретную дату в окрестности даты создания модуля (если по смыслу не требуется другая дата), т.е. правильная формулировка - "выбрать дату 01.06.2021".
+Для видов учреждения укажите "выбрать вид учреждения Театры". Если вы выбираете одно учреждение - укажите любое действующее на момент создания модуля учреждение, __кроме ИНКОЦентра и управленческих учреждений__. Если вы выбираете несколько учреждений поштучно, допускается написать "выбрать несколько учреждений", а в графе "Результат" - "информация по соответствующим учреждениям".
+При описании сценария загрузки файлов, мы добавляем слово "тестовый". Тестовый файл в формате word, Тестовый файл в формате pdf. Поскольку при тестировании реальных пока все равно нет.
 Стандартные используемые формулировки:
@@ Строка 102: / Строка 158: @@
 Протокол испытаний практически повторяет программу испытаний.
-Если ошибок по результатам испытаний не обнаружено, то в разделе "Заключения комиссии" необходимо убрать слова "с замечаниями" из фразы "Функциональные требования выполнены в полном объеме с замечаниями".
+Если комментариев по результатам испытаний комиссией не вносилось, то в разделе 7 "Комментарии по результатам испытаний" формулировку следует заменить следующим образом: "По результатам испытаний комиссией комментариев не вносилось". Если комментарии есть, то следует описать данные комментарии.
+Если комментариев и ошибок по результатам испытаний не обнаружено, то в разделе 9 "Заключения комиссии" необходимо убрать слова "с замечаниями" из фразы "Функциональные требования выполнены в полном объеме с замечаниями".
 Состав комиссии, принимающей протокол испытаний, менять не надо!