Различия

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

--- documentation:rules [2021/10/07 10:54] – ilya
+++ documentation:rules [2026/05/08 14:32] (текущий) – petrk
@@ Строка 1: / Строка 1: @@
+[[:start#модули_пользовательская_документация|🏠 Стартовая страница]]\\
 ====== Правила написания документации ======
@@ Строка 4: / Строка 6: @@
 Все документы требуется составлять по единому стандарту в соответствии с утвержденными шаблонами.\\
-Шаблоны для работы и подготовки документации для каждого типа документа можно найти и скачать в КИС, в разделе "[[https://kis.inko-center.ru/org/mvc/users/sys_docs/main/view|Документация систем]]", в заголовке таблицы "Подсистемы и модули".
+Шаблоны для работы и подготовки документации для каждого типа документа можно найти и скачать в КИС, в разделе "[[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 пт.\\
 ===== Типы документации =====
 Полный пакет документации, описывающей систему, подсистему или модуль составляют **пять** документов:\\
-  * [[documentation:rules|Техническое задание]]
+  * Техническое задание
-  * [[documentation:rules|Руководство пользователя]]
+  * Руководство пользователя
-  * [[documentation:rules|Программа испытаний]]
+  * Программа и методика испытаний
-  * [[documentation:rules|Протокол испытаний]]
+  * Протокол испытаний
   * Ведомость эксплуатационных документов