Commit 872015d7 authored by Talgat Mustafinov's avatar Talgat Mustafinov

Created Employee: user manual

parent 1ad9d63f
# -*- 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
Информация о документе
=======================
1.1. Представление модуля
--------------------------
Модуль «Информация о документе» состоит из верхней панели и основной области.
В основной области располагается одна из двух страниц:
1. Просмотр документа — по адресу
``http(s)://host:port/documentInfo/?documentID={documentID}&type=1``
2. Информация — по адресу
``http(s)://host:port/documentInfo/?documentID={documentID}&type=2``
На верхней панели находятся: логотип, кнопки переключения страниц Просмотра
документа и Информации, кнопка печати и меню переключения локали.
На странице «Просмотр документа» отображается документ в режиме просмотра.
При просмотре с мобильного устройства отображается представление с кодом
mobile, если такое существует.
.. figure:: images/document_info_view_page.png
Рис. Страница Просмотр документа
На странице «Информация» отображаются данные о документе: номер и дата
регистрации, а также данные о подписях и подписантах.
.. figure:: images/document_info_info_page.png
Рис. Страница Информации
Документы
=========
1.1. Представление модуля
--------------------------
Модуль «Документы» — приложение, предназначенное для регистрации входящих,
исходящих и внутренних документов, группировки зарегистрированных документов
в дела и хранения их согласно номенклатуре дел, а также для того, чтобы
видеть любой документ системы, с которым сталкивался пользователь.
Модуль состоит из двух основных частей:
- навигатора в виде дерева элементов;
- основной рабочей области, отображающей подробную информацию о выделенном
элементе навигатора.
В навигаторе есть три корневых элемента — это Журналы, Дела и Все.
В разделе Журналы находятся журналы, доступные пользователю с ролью
«Сотрудник канцелярии».
В разделе Дела находятся дела номенклатуры, куда списываются документы из
журналов.
В разделе Все находятся документы пользователя, сгруппированные по трём
подразделам:
- Мои
- Полученные
- Отправленные
В основной рабочей области отображаются документы согласно выбранному в
навигаторе элементу. В верхней части основной области находится переключатель
вида отображения документов — строчный вид / табличный вид.
.. figure:: images/documents_list_view.png
Рис. Документы — строчный вид
.. figure:: images/documents_table_view.png
Рис. Документы — табличный вид
1.2. Просмотр деталей документа
---------------------------------
Для просмотра деталей документа (карточка с РКК, Ходом выполнения, Листами
подписей/согласования, Изменениями, Дочерними документами, Приложениями)
необходимо выделить документ и нажать на кнопку Детали.
Открывается документ по двойному клику.
.. figure:: images/document_details.jpg
Рис. Документы — детали
This diff is collapsed.
Synergy Employee: руководство пользователя
===========================================
.. toctree::
:maxdepth: 3
intro
workflow
registries
documents
document_info
employees
knowledge
learner
services
\ No newline at end of file
Введение
========
Набор процессов Synergy Employee — это программное обеспечение для организации
целостного системного подхода к управлению внутренними процессами организации,
а именно:
* Контроль поручений и протоколов;
* Организационно-распорядительный документооборот;
* Кадровый учёт и делопроизводство;
* Отчет об исполнительской дисциплине;
* Организация обучения сотрудников;
* Управление внутренними сервисами и заявками, контроль SLA.
Руководство пользователя описывает основные функциональные возможности
Synergy Employee согласно ролям пользователей в системе.
Подсистемы
----------
**Потоки работ**
* 1. Потоки работ
* 1.1. Представление модуля
* 1.2. Создание новой работы
* 1.3. Контекстное меню работы
* 1.4. Просмотр полученной работы
* 1.5. Завершение работы
* 1.6. Форма завершения Документ (создание дочернего документа)
* 1.7. Перепоручение работы
* 1.8. Карточка по документу
* 1.9. Комментарии к работе
* 1.10. Просмотр версий документа
* 1.11. Формирование отчетов
* 1.12. Наложение резолюции
**Реестры**
* 1. Реестры
* 1.1. Представление модуля
* 1.2. Создание новой записи реестра
* 1.3. Просмотр существующей записи реестра
* 1.4. Подписание документа
**Документы**
* 1. Документы
* 1.1. Представление модуля
* 1.2. Просмотр деталей документа
**Информация о документе**
* 1. Информация о документе
* 1.1. Представление модуля
* 1.2. Настройки печатной версии для QR-code
**Сотрудники**
* Личное дело
**Knowledge**
* Рабочее место Менеджера обучения
* Портал для обучающихся
This diff is collapsed.
Обучающийся
===========
Портал для обучающихся располагается по адресу: ``http://(host):(port)/Knowledge``
1.1. Авторизация
-----------------
Страница авторизации на портале Knowledge выглядит следующим образом:
.. figure:: images/learner_login_page.png
Рис. Страница авторизации на портале Knowledge
Создание пользователей происходит в модуле Сотрудники (при наличии прав
Сотрудника отдела кадров), или же в IDE (подробнее описано в руководстве по
IDE).
Необходимо заполнить требуемые поля:
.. figure:: images/learner_login_form.png
Рис. Форма авторизации
Затем нажать кнопку «Войти в систему».
Если в системе еще нет профиля, система предложит создать его:
.. figure:: images/learner_create_profile.png
Рис. Предложение создать профиль
1.2. Интерфейс портала
-----------------------
На портале представлены следующие модули:
1. Профиль
2. Мои курсы
3. Все курсы
4. Библиотека
Модуль «Профиль» содержит информацию об обучающемся:
.. figure:: images/learner_profile.png
Рис. Модуль «Профиль»
Модуль «Все курсы» содержит все созданные в системе курсы, безотносительно
должности конкретного пользователя:
.. figure:: images/learner_all_courses.png
Рис. Модуль «Все курсы»
Модуль «Мои курсы» содержит те курсы, которые необходимо изучить в рамках
конкретной должности.
.. figure:: images/learner_courses.png
Рис. Модуль «Мои курсы»
Модуль «Библиотека» содержит дополнительную литературу, необходимую
пользователю при обучении по данному Профилю обучения.
.. figure:: images/learner_library.png
Рис. Модуль «Библиотека»
1.3. Добавление дополнительного курса
--------------------------------------
Кроме того, есть возможность самостоятельного добавления курсов из модуля
«Все курсы» в «Мои курсы». Для этого нужно выбрать из модуля «Все курсы»
нужный курс, открыть его и нажать на кнопку «Добавить в Мои курсы»:
.. figure:: images/learner_add_to_my_courses.png
Рис. Кнопка «Добавить в Мои курсы»
После нажатия на эту кнопку она меняет вид на «Начать курс».
.. figure:: images/learner_start_course_button.png
Рис. Кнопка «Начать курс»
После этого курс будет отображаться в модуле «Мои курсы» в разделе
«Дополнительные»:
.. figure:: images/learner_my_courses.png
Рис. Курс в разделе «Дополнительные»
Обучение
=========
1.1. Изучение материала
------------------------
Для начала обучения обучающийся выбирает курс, который желает пройти (одним
щелчком левой кнопки мыши):
.. figure:: images/learner_start_course_button.png
Рис. Выбор курса
Далее необходимо нажать кнопку «Начать курс». После нажатия на данную кнопку
система предлагает определить даты завершения изучения курса.
Обучающийся должен выбрать дату, по истечению которой должен завершить
обучение (данная дата ни к чему не обязывает обучающегося, это просто
системный пререквизит):
.. figure:: images/learner_date_picker.png
Рис. Выбор даты завершения
После этого курс открыт для изучения. Нужно выбрать первый урок (один щелчок
левой кнопки мыши). Открывается содержимое урока, которое может включать
видео, фото, текстовые файлы и презентации.
.. figure:: images/learner_lesson_content.png
Рис. Содержимое урока
1.2. Тестирование
------------------
После изучения всех уроков курса обучающийся может перейти к итоговому
заданию:
.. figure:: images/learner_final_task.png
Рис. Итоговое задание
Необходимо нажать кнопку «Начать», после чего открывается тестовое задание с
прогрессом по ходу тестирования:
.. figure:: images/learner_test_progress.png
Рис. Тестовое задание с прогрессом
Система подсчитывает результат и выводит сообщение. В данном конкретном случае
тест не сдан, так как не был набран пороговый уровень:
.. figure:: images/learner_test_failed.png
Рис. Сообщение о непройденном тесте
Обучающийся может пройти тестирование заново. В случае успешного завершения
теста система выводит сообщение:
.. figure:: images/learner_test_passed.png
Рис. Сообщение об успешном прохождении теста
1.3. Практическое задание
--------------------------
Для выполнения практического задания пользователю нужно изучить приложенную
инструкцию, выполнить задание и выслать результат менеджеру обучения:
.. figure:: images/learner_practical_task.png
Рис. Практическое задание
После первого прохождения итогового задания пользователю предлагается
заполнить Анкету:
.. figure:: images/learner_feedback_form.png
Рис. Анкета эффективности обучения
Реестры
=======
1.1. Представление модуля
--------------------------
Модуль «Реестры» состоит из верхней панели, левой панели и основной рабочей
области.
.. figure:: images/registries_module.png
Рис. Модуль «Реестры»
На верхней панели модуля представлены:
* Логотип компании
* Название модуля
* Иконки установленных в SynergyApp модулей
* Кнопка выхода авторизованного пользователя
Доступные действия:
* Переключение между модулями
* Выход из учетной записи авторизованного пользователя
На левой панели модуля представлены:
* Кнопка «Создать» - доступна при выбранном реестре
* Список реестров, доступных авторизованному пользователю
Основная рабочая область содержит:
* Список записей выбранного реестра / список реестров выбранной группы реестров
* Навигатор переключения страниц записей реестра
Доступные действия:
* Сворачивание всех открытых документов по клику на иконке «Дом»
* Переключение между открытыми документами по клику на соответствующей вкладке
Нижняя панель представлена:
* Иконка «Дом»
* Вкладки всех открытых документов
1.2. Создание новой записи реестра
------------------------------------
Для создания новой записи реестра необходимо:
1. На левой панели выбрать нужный реестр двойным кликом левой кнопки мыши.
2. Нажать кнопку «Создать».
3. Откроется форма создания записи. Заполнить необходимые поля формы.
4. Сохранить заполненную форму или отправить по утвержденному маршруту.
1.3. Просмотр существующей записи реестра
------------------------------------------
Для просмотра существующей записи реестра необходимо:
1. На левой панели выбрать нужный реестр двойным кликом левой кнопки мыши.
2. В основной рабочей области открыть нужную запись двойным кликом левой
кнопки мыши либо одинарным кликом правой кнопки — «открыть»:
.. figure:: images/registries_open_context_menu.jpg
Рис. Открытие записи реестра через контекстное меню (клик правой кнопки мыши)
3. В появившемся окне представлено:
* На левой панели:
* Информация о документе
* Комментарии к документу
* Кнопки доступных действий: «Завершить», «Отправить», «Утвердить», и т.д
* Приложенные к работе файлы
* Кнопка «Подписать» (подписание документа ЭЦП через NCALayer)
.. figure:: images/registries_document_view.jpg
Рис. Окно просмотра документа
* На верхней панели:
* Кнопка сворачивания документа
* Кнопка закрытия документа
* Кнопка печати
* Кнопка редактирования документа
* В основной рабочей области доступен просмотр содержимого документа.
Также на левой панели может быть доступна кнопка создания документа по
реестру ответа (название кнопки задается в IDE):
.. figure:: images/workflow_child_document.jpg
Рис. Создание документа по реестру ответа
1.4. Подписание документа
--------------------------
Кнопка «Подписать» расположена в нижней части левой панели. Подписать можно
любой доступный документ (если пользователь до этого ещё не подписывал этот
документ), кроме находящихся на согласовании, утверждении или ознакомлении.
Если при попытке подписания NCALayer не запущен — будет выдано
соответствующее предупреждение:
.. figure:: images/registries_sign_warning.jpg
Рис. Предупреждение при подписании
Services
========
Для корректной работы группы процессов Services необходимо:
- добавить сервисы, обращения по которым планируется принимать от сотрудников;
- добавить данные по SLA по каждому сервису, указать менеджера, ответственного
за данный сервис;
- добавить данные о внешних поставщиках.
1.1. Добавление сервисов
-------------------------
Порядок действий:
1. После авторизации на платформе требуется перейти в модуль Реестры и найти в
списке папку «Сервисы (внутренние обращения сотрудников)»:
.. figure:: images/services_folder.png
Рис. Папка «Сервисы» в модуле Реестры
2. Выбрать реестр Сервисы, создать в нем новую запись.
3. Заполнить форму:
.. figure:: images/services_service_form.png
Рис. Форма создания сервиса
4. Поле выбора статуса сервиса. Имеется 3 статуса:
* В разработке
* Функционирует
* Не функционирует
5. Название сервиса — на 3 языках.
6. Менеджер сервиса — сотрудник, контролирующий выполнение обращений по
данному сервису.
7. Изображение — файл, который в дальнейшем будет использоваться для плашки
сервиса на внешнем портале (на данный момент находится в разработке).
8. Группа, ответственная за оказание услуги (сервиса) — сотрудники, которым
будут попадать все обращения по данному сервису.
9. Подразделение — подразделение, ответственное за выполнение обращений по
данному сервису.
10. Описание сервиса — на 3 языках.
11. Данные по SLA:
* Статус по SLA: принято/не принято.
* Соглашение — прикладывается файл соглашения по SLA.
* Группы доступа — указываются группы, имеющие доступ к просмотру SLA.
* Время на реакцию (в часах) — время, за которое обращение должно быть
исполнено.
* Условия для дистанционной поддержки — указывается время на разрешение
обращения с делением по приоритетам.
* Условия для выездной поддержки — аналогично предыдущему пункту.
12. Нажать кнопку «Сохранить».
1.2. Добавление списка внешних поставщиков
-------------------------------------------
Порядок действий:
1. Выбрать реестр Внешние поставщики в папке «Сервисы (внутренние обращения
сотрудников)».
2. Создать новую запись.
3. Заполнить открывшуюся форму:
* **Внешний поставщик** — наименование поставщика.
* **Описание взаимодействия** — описание услуги/сервиса, который
предоставляет поставщик.
* **Ответственный менеджер** — менеджер, отвечающий за взаимодействие с
данным поставщиком.
* **Длительность договора** — дата начала и дата окончания договора с
поставщиком.
* **Файл договора** — прикладывается файл договора с поставщиком.
* **Контактная информация** — указывается почтовый адрес, телефон и другие
контакты поставщика.
* **Условия предоставления сервисов** — указывается сервис и данные по SLA,
утвержденные с данным поставщиком — аналогично полям в реестре Сервисы.
.. figure:: images/services_supplier.png
Рис. Форма добавления внешнего поставщика
4. Нажать кнопку «Сохранить».
1.3. Создание нового обращения
--------------------------------
Для создания нового обращения необходимо перейти в Реестр обращений и создать
новую запись:
.. figure:: images/services_request_form.png
Рис. Форма создания обращения
Часть полей заполняется автоматически:
* Статус обращения
* Номер обращения
* Дата регистрации
* Автор обращения и его подразделение
Далее пользователю необходимо указать следующие данные:
* **Тип обращения**:
* **Сервисный запрос** — для обращений, связанных с выдачей нового
оборудования/техники/ПО сотруднику или их настройки.
* **Инцидент** — для обращений, связанных с поломкой или нетипичным
поведением оборудования/техники/ПО сотрудника.
* **Запрос на изменение** — для обращений, связанных с обновлением уже
имеющегося у сотрудника оборудования/техники/ПО.
* **Услуга/сервис** — выбирается сервис (из реестра Сервисы).
* **Описание** — текстовое описание проблемы/запроса.
* **Вложения** — прикрепляется файл (при необходимости).
* **Контактные данные** — телефон, адрес электронной почты автора обращения.
* **Приоритет** — доступен только ответственным за исполнение обращения.
* **Исполнитель** — заблокировано от изменений. Заполняется пользователем,
взявшим обращение в работу.
* **Решение** — заполняется Исполнителем после завершения работы с обращением.
* **Удовлетворенность** — оценка автора обращения, отражающая его мнение о
качестве решения по данной проблеме/запросу.
* **Комментарий** — текстовый комментарий автора обращения. Заполняется по
желанию пользователя.
This diff is collapsed.
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment