Initial commit

.claude/settings.local.json

+{
+  "permissions": {
+    "allow": [
+      "Read(//c/everything/synergy_documentation/synergy-docs//**)",
+      "Read(//c/everything/synergy_employee/synergy-employee//**)"
+    ]
+  }
+}

conf.py

+# -*- coding: utf-8 -*-
+#
+# Read the Docs Template documentation build configuration file, created by
+# sphinx-quickstart on Tue Aug 26 14:19:49 2014.
+#
+# This file is execfile()d with the current directory set to its
+# containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+import sys
+import os
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#sys.path.insert(0, os.path.abspath('.'))
+
+# -- General configuration ------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as Strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = []
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The encoding of source files.
+#source_encoding = 'utf-8-sig'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'Employee: руководство по внедрению'
+copyright = u'2026, ARTA Software'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = '1.0'
+# The full version, including alpha/beta/rc tags.
+release = '1.0'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#language = None
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+#today = ''
+# Else, today_fmt is used as the format for a strftime call.
+#today_fmt = '%B %d, %Y'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+exclude_patterns = ['_build']
+
+# The reST default role (used for this markup: `text`) to use for all
+# documents.
+#default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+#add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+#add_module_names = True
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+#show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# A list of ignored prefixes for module index sorting.
+#modindex_common_prefix = []
+
+# If true, keep warnings as "system message" paragraphs in the built documents.
+#keep_warnings = False
+
+
+# -- Options for HTML output ----------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+html_theme = 'sphinx_rtd_theme'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#html_theme_options = {}
+
+# Add any paths that contain custom themes here, relative to this directory.
+#html_theme_path = []
+
+# The name for this set of Sphinx documents.  If None, it defaults to
+# "<project> v<release> documentation".
+#html_title = None
+
+# A shorter title for the navigation bar.  Default is the same as html_title.
+#html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+#html_logo = None
+
+# The name of an image file (within the static path) to use as favicon of the
+# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+#html_favicon = None
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# Add any extra paths that contain custom files (such as robots.txt or
+# .htaccess) here, relative to this directory. These files are copied
+# directly to the root of the documentation.
+#html_extra_path = []
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+#html_last_updated_fmt = '%b %d, %Y'
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+#html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+#html_sidebars = {}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+#html_additional_pages = {}
+
+# If false, no module index is generated.
+#html_domain_indices = True
+
+# If false, no index is generated.
+#html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+#html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+#html_show_sourcelink = True
+
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+#html_show_sphinx = True
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+#html_show_copyright = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it.  The value of this option must be the
+# base URL from which the finished HTML is served.
+#html_use_opensearch = ''
+
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = None
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'ReadtheDocsTemplatedoc'
+
+
+# -- Options for LaTeX output ---------------------------------------------
+
+latex_elements = {
+    # The paper size ('letterpaper' or 'a4paper').
+    #'papersize': 'letterpaper',
+
+    # The font size ('10pt', '11pt' or '12pt').
+    #'pointsize': '10pt',
+
+    # Additional stuff for the LaTeX preamble.
+    #'preamble': '',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+latex_documents = [
+    ('index', 'ReadtheDocsTemplate.tex', u'Read the Docs Template Documentation',
+     u'Read the Docs', 'manual'),
+]
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+#latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+#latex_use_parts = False
+
+# If true, show page references after internal links.
+#latex_show_pagerefs = False
+
+# If true, show URL addresses after external links.
+#latex_show_urls = False
+
+# Documents to append as an appendix to all manuals.
+#latex_appendices = []
+
+# If false, no module index is generated.
+#latex_domain_indices = True
+
+
+# -- Options for manual page output ---------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    ('index', 'readthedocstemplate', u'Read the Docs Template Documentation',
+     [u'Read the Docs'], 1)
+]
+
+# If true, show URL addresses after external links.
+#man_show_urls = False
+
+
+# -- Options for Texinfo output -------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+    ('index', 'ReadtheDocsTemplate', u'Read the Docs Template Documentation',
+     u'Read the Docs', 'ReadtheDocsTemplate', 'One line description of project.',
+     'Miscellaneous'),
+]
+
+# Documents to append as an appendix to all manuals.
+#texinfo_appendices = []
+
+# If false, no module index is generated.
+#texinfo_domain_indices = True
+
+# How to display URL addresses: 'footnote', 'no', or 'inline'.
+#texinfo_show_urls = 'footnote'
+
+# If true, do not generate a @detailmenu in the "Top" node's menu.
+#texinfo_no_detailmenu = False

configuration.rst

+Инструкция по первичной настройке
+===================================
+
+Для каждой группы процессов первичная настройка начинается с двух общих шагов:
+
+1. Внести организационную структуру (если не была внесена ранее). В ней обязательно
+   должны присутствовать сотрудники с ролями, указанными в таблице ниже; пользователи
+   должны быть добавлены в группы, соответствующие их ролям.
+2. Раздать права на реестры и журналы согласно указанным ролям.
+
+.. list-table::
+   :header-rows: 1
+   :widths: 30 70
+
+   * - Группа процессов
+     - Обязательные роли
+   * - Workflow
+     - Сотрудник канцелярии; сотрудник отдела кадров/HR (для внедрения процессов
+       кадрового делопроизводства)
+   * - Knowledge
+     - Менеджер обучения; обучающиеся
+   * - Services
+     - Отдельные роли не выделены — права раздаются согласно ролям, предусмотренным
+       настройкой реестров
+
+Дальнейшие шаги зависят от группы процессов и описаны в подразделах ниже.
+
+Workflow
+--------
+
+1. Настроить формы согласно внутренним потребностям компании.
+
+   .. note::
+
+      В текущей конфигурации на формах приказов и трудовых договоров присутствуют
+      компоненты Должности и ФИО руководителя организации (от имени которого
+      запускаются приказы). Их необходимо заполнить соответствующими значениями.
+
+2. Настроить маршруты реестров согласно внутренним потребностям компании.
+
+   Настройка форм и маршрутов осуществляется в IDE платформы. Подробные инструкции
+   приведены в обучающих курсах по платформе.
+
+3. Настроить печатную версию для QR-code.
+
+   На страницы «Просмотр документа» и «Информация» ведут ссылки в QR-кодах из
+   печатной версии документа: ``qr_code_for_signlist`` и ``qr_code_for_document``.
+
+   Для того, чтобы QR-коды были корректно добавлены в печатное представление,
+   необходимо в печатном представлении добавить две картинки и дать им названия
+   ``qr_code_for_document`` и ``qr_code_for_signlist``.
+
+Knowledge
+---------
+
+1. Добавить обучающие курсы, профили обучения и т. д. Подробная инструкция приведена
+   в Руководстве пользователя.
+
+Services
+--------
+
+1. Внести данные в реестры «Внешние поставщики», «Сервисы» и т. д. Подробная
+   инструкция приведена в Руководстве пользователя.

index.rst

+Synergy Employee: руководство по внедрению
+=================================================
+
+.. toctree::
+   :maxdepth: 3
+
+   intro
+   methodology
+   installation
+   structure
+   configuration

installation.rst

+Инструкция по установке Arta Synergy Employee
+===============================================
+
+Предварительные требования
+---------------------------
+
+.. important::
+
+   Для работы системы требуется:
+
+   * установить Arta Synergy 5.1 simon (инструкция по установке);
+   * в подсистеме администрирования обновить БД и процессы.
+
+Подключение репозиториев
+-------------------------
+
+*(Раздел заполняется в соответствии с актуальной инструкцией по подключению репозиториев.)*
+
+Установка приложений
+---------------------
+
+Вместе с конфигурацией Employee устанавливается приложение SynergyApp — надстройка,
+позволяющая использовать на одном стенде несколько приложений (модулей), — а также
+модули и приложения, необходимые для корректной работы набора процессов.
+
+.. note::
+
+   После установки приложения необходимо зайти в Конструктор и для всех связанных
+   приложений (*workflow* — Потоки работ, *registry* — Реестры, *contracts* — Договоры,
+   *documents* — Документы, *documentInfo* — Информация о документе, *basement* — Synergy App,
+   *knowledge* — KNOWLEDGE, *employees* — Сотрудники) в свойствах указать логин и пароль
+   служебного пользователя с правами администратора.
+
+Если есть необходимость добавить в SynergyApp другие приложения (модули) — смотрите
+Инструкцию по настройке SynergyApp.
+
+После установки обязательно выполнить пункты Инструкции по первичной настройке.

intro.rst

+Назначение документа
+=====================
+
+Целью данного документа является предоставление информации о конфигурации набора
+процессов, в частности — детализированное описание:
+
+* созданных объектов;
+* произведенных настроек;
+* предполагаемого процесса работы в системе согласно назначению набора процессов.
+
+Данный документ также может содержать дополнительные инструкции по возможным
+сценариям кастомизации существующей функциональности, советы и рекомендации.

methodology.rst

+Методология внедрения
+======================
+
+Получение ресурсов (боевого и тестового стенда)
+-------------------------------------------------
+
+**Программное обеспечение:**
+
+* ОС Debian GNU/Linux (jessie, wheezy);
+* хранилище Jackrabbit;
+* поисковые индексы Lucene.
+
+**Аппаратные требования:**
+
+* CPU: 8 ядер;
+* ОЗУ: 16 ГБ;
+* HDD/SSD: не менее 10 ГБ свободного дискового пространства.
+
+.. warning::
+
+   Настоятельно рекомендуем развернуть тестовый стенд, полностью дублирующий
+   конфигурацию системы боевого сервера, — для диагностики и воспроизведения
+   потенциальных проблем, тестирования обновлений и изменений конфигурации.
+
+Установка и настройка системы
+------------------------------
+
+Для установки системы на боевом и тестовом стендах воспользуйтесь Инструкцией по
+установке (см. также раздел «Инструкция по установке Arta Synergy Employee» данного
+документа).
+
+Кастомизация процессов по факту выявленных пожеланий
+------------------------------------------------------
+
+1. Для выявления пожеланий по изменению стандартной конфигурации процессов,
+   устанавливаемой по умолчанию, рекомендуется провести демонстрацию всем
+   заинтересованным лицам проекта, в том числе конечным пользователям.
+2. Все пожелания и замечания к процессам должны быть задокументированы и
+   проанализированы на предмет сложности и сроков адаптации под данные требования.
+3. В качестве вспомогательного инструмента к определению необходимых настроек в
+   системе для реализации тех или иных пожеланий рекомендуется ознакомиться со
+   Структурой набора процессов, а также Руководством разработчика.
+
+.. warning::
+
+   Настоятельно рекомендуем провести полное тестирование всех процессов после
+   произведения настроек конфигурации.
+
+Обучение сотрудников работе в системе
+--------------------------------------
+
+1. Все сотрудники организации, которым в рамках проекта предполагается обучение,
+   могут быть объединены в группы согласно осуществляемым ими ролям (канцелярия,
+   отдел кадров, исполнители, руководители и т. д.).
+2. Рекомендуем адаптировать руководство пользователя, представленное по умолчанию,
+   согласно произведенным изменениям конфигурации, оргструктуре компании и прочей
+   специфике проекта.
+3. В первую очередь должны быть обучены сотрудники, исполняющие основные роли в
+   процессах, попадающих под опытную эксплуатацию.
+
+Опытная эксплуатация
+---------------------
+
+1. Процесс опытной эксплуатации представляет собой имитацию полноценной работы
+   системы в боевом режиме, но в меньших масштабах. Это может быть прогон основных
+   боевых процессов на выделенном подразделении или на определенной категории
+   документов.
+2. Продолжительность процесса опытной эксплуатации зависит от масштабов проекта и
+   количества внедряемых одновременно процессов.
+3. Результатом опытной эксплуатации должен являться подтвержденный всеми
+   заинтересованными сторонами факт готовности системы к использованию в
+   промышленном режиме.
+4. В случае выявления замечаний в ходе опытной эксплуатации должны быть произведены
+   соответствующие настройки в системе, и измененные процессы должны быть
+   протестированы повторно.
+
+.. note::
+
+   Рекомендуем адаптировать руководство пользователя, представленное по умолчанию,
+   согласно произведенным изменениям конфигурации, оргструктуре компании и прочей
+   специфике проекта.
+
+Запуск в промышленную эксплуатацию
+------------------------------------
+
+1. Переход к промышленной эксплуатации осуществляется после успешного завершения
+   опытной эксплуатации и подтверждения готовности процессов всеми
+   заинтересованными сторонами.
+2. В промышленном режиме процессы используются в полном объеме всеми
+   предусмотренными подразделениями и пользователями организации.
+3. К моменту ввода в промышленную эксплуатацию рекомендуется убедиться, что
+   пользовательская документация соответствует фактической конфигурации системы и
+   учитывает особенности организационной структуры и бизнес-процессов компании.
+4. При необходимости внесения изменений в процессы, находящиеся в промышленной
+   эксплуатации, рекомендуется выполнять их разработку и предварительное
+   тестирование на тестовом стенде, конфигурация которого соответствует промышленной
+   среде.
+5. Перенос изменений в промышленную эксплуатацию следует осуществлять только после
+   успешного завершения тестирования.

structure.rst

+Структура набора
+=================
+
+Как все устроено
+-----------------
+
+Employee состоит из 3 групп процессов:
+
+* **Workflow** — документооборот и кадровые процессы;
+* **Knowledge** — обучение сотрудников и база знаний (инструкций);
+* **Services** — внутренние сервисы, заявки и SLA.
+
+В IDE объекты, относящиеся к каждой группе, размещены в одноименных папках.
+
+Workflow
+--------
+
+В системе **Synergy Workflow** реализованы следующие глобальные процессы и их
+подпроцессы:
+
+* **Контроль поручений**
+
+  * Управление поручениями (работами)
+  * Управление протоколами совещаний
+
+* **Документооборот**
+
+  * Входящая корреспонденция (1 журнал регистрации)
+  * Исходящая корреспонденция (1 журнал регистрации)
+  * Резолюции и контроль исполнения документов
+  * Внутренняя переписка (1 журнал регистрации, 1 форма и реестр служебных записок)
+
+* **Кадровое делопроизводство**
+
+Объекты конфигурации кадрового делопроизводства:
+
+.. list-table::
+   :header-rows: 1
+   :widths: 35 65
+
+   * - Процесс
+     - Объекты конфигурации
+   * - Прием
+     - 2 формы и 2 реестра служебных записок; 1 форма и реестр приказов на прием;
+       1 форма и реестр трудовых договоров
+   * - Перевод
+     - 1 форма и реестр служебных записок на перевод; 1 форма и реестр приказов на
+       перевод
+   * - Увольнение
+     - 1 форма и реестр заявлений на увольнение; 1 форма и реестр приказов на
+       увольнение
+   * - Отпуска
+     - 5 форм и реестров заявлений на отпуск; 5 форм и реестров приказов на отпуск
+   * - Командирование
+     - 1 форма и реестр служебных записок на командирование; 1 форма и реестр
+       приказов на командирование
+   * - Отчеты
+     - Штатное расписание; расстановка
+   * - Табель учета рабочего времени
+     - Формирование и консолидация — для структурного подразделения, одного
+       сотрудника или произвольной группы сотрудников
+   * - Личные дела
+     - Ведение личных дел / личных карточек сотрудников
+
+Список блокирующих процессов Workflow
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. list-table::
+   :header-rows: 1
+   :widths: 55 45
+
+   * - Идентификатор процесса
+     - Назначение
+   * - ``event.blocking.interpreter.timesheet.init``
+     - Инициация табеля. Учитываются: период (месяц/полмесяца), тип табеля (на одного
+       сотрудника или на подразделение), а также необходимость добавления руководителя
+       (отдельная должность)
+   * - ``event.blocking.interpreter.timesheet.fill_table``
+     - Заполнение табеля. Учитываются ставки должности и приказы по сотруднику за
+       выбранный период
+   * - ``event.blocking.interpreter.copy.trip.to.usercard``
+     - Копирование данных командировки в карточку пользователя
+   * - ``event.blocking.interpreter.create_user``
+     - Создание пользователя и заполнение карточки пользователя при приеме на работу
+   * - ``event.blocking.interpreter.copy_back_vacation_to_usercard``
+     - Копирование данных по отзыву из отпуска в карточку отпусков пользователя
+   * - ``event.blocking.interpreter.copy_child_vacation_to_usercard``
+     - Копирование данных отпуска по уходу за ребенком в карточку отпусков пользователя
+   * - ``event.blocking.interpreter.copy_pregnancy_vacation_to_usercard``
+     - Копирование данных отпуска по беременности и родам в карточку отпусков пользователя
+   * - ``event.blocking.interpreter.copy_study_vacation_to_usercard``
+     - Копирование данных учебного отпуска в карточку отпусков пользователя
+   * - ``event.blocking.interpreter.copy_unpaid_vacation_to_usercard``
+     - Копирование данных об отпуске без сохранения заработной платы в карточку отпусков
+       пользователя
+   * - ``event.blocking.interpreter.copy_vacation_to_usercard``
+     - Копирование данных об оплачиваемом трудовом отпуске в карточку отпусков пользователя
+
+Knowledge
+---------
+
+В системе **Synergy Knowledge** реализованы следующие процессы и подпроцессы:
+
+* Каталог инструкций/обучающих курсов — 3 формы, 3 реестра
+* Каталог профилей обучения — 1 форма, 1 реестр
+* Каталог обучающихся (сотрудников) — 1 форма, 1 реестр
+* История прохождения курсов — 1 форма, 1 реестр
+* Итоговое задание
+
+  * Тестирование — 1 форма, 1 реестр
+  * Практическое задание — 1 форма завершения
+
+* Сбор обратной связи — Анкета эффективности обучения — 1 форма, 1 реестр
+
+Список блокирующих процессов Knowledge
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. list-table::
+   :header-rows: 1
+   :widths: 50 50
+
+   * - Идентификатор процесса
+     - Назначение
+   * - ``event.blocking.interpreter.changeSkills``
+     - Перенос списка обязательных к прохождению курсов из Профиля обучения в Карточку
+       сотрудника
+   * - ``event.blocking.interpreter.courseCompleted``
+     - Выставление курсу статуса «Завершен» после успешного выполнения Итогового задания
+   * - ``event.blocking.interpreter.matching.result_approve``
+     - Копирование результатов проверки практического задания Менеджером обучения
+       (статус + комментарий) из формы завершения в Историю прохождения курса
+
+Services
+--------
+
+В системе **Synergy Services** реализованы следующие процессы и подпроцессы:
+
+* Регистрация обращения
+
+  * Классификация обращения
+  * Назначение исполнителя
+
+* Исполнение обращения
+* Контроль SLA
+* Возврат на доработку
+* Переназначение обращения
+* Закрытие обращения
+* Оценка качества
+* Каталог услуг/сервисов
+* Каталог поставщиков
+* Отчеты
+
+  * SLA-отчет по обращениям
+  * Отчет по загрузке сервиса
+  * Отчет по качеству исполнения
+  * Отчет по структуре обращений