CRM user manual +marketing

.gitattributes

@@ -44,5 +44,12 @@ crm/user-manual/Makefile -text
 crm/user-manual/conf/html/settings.xsl -text
 crm/user-manual/conf/pandoc/book.docbook -text
 crm/user-manual/conf/vcs/insert-revision-and-build-date.xsl -text
+crm/user-manual/src/appendix.md -text
+crm/user-manual/src/dictionaries.md -text
 crm/user-manual/src/index.md -text
+crm/user-manual/src/marketing.md -text
+crm/user-manual/src/marketing_cost_comission.md -text
+crm/user-manual/src/marketing_funnel.md -text
+crm/user-manual/src/marketing_pipeline.md -text
+crm/user-manual/src/marketing_sidePannel.md -text
 crm/user-manual/src/storage.md -text

crm/user-manual/src/appendix.md

+Приложения {#sec.appendix}
+==================================
+
+<#include "dictionaries.md">

crm/user-manual/src/dictionaries.md

+### Справочники {#dictionaries}
+
+Конфигурация Synergy CRM содержит преднастроенные справочники, значения 
+которых используются при создании записей [реестров](#storage):
+
+*   [Статусы лида](#dictionaryLeadStatus)
+*   [Статусы сделки](#dictionaryDealStatus)
+*   [Статусы аккаунта](#dictionaryAccountStatus)
+*   [Статусы контакта](#dictionaryContactStatus)
+*   [Типы мероприятий](#dictionaryEventType)
+*   [Телефон](#dictionaryPhone)
+*   [Адрес](#dictionaryAddress)
+*   [Почта](#dictionaryEmail)
+*   [Социальные сети](#dictionarySocialNetworks)
+*   [Действия напоминаний](#dictionaryremindActions)
+
+Данный раздел содержит названия элементов справочников, принятые в 
+конфигурации по умолчанию, и некоторые комментарии к ним.
+
+#### Статусы лида {#dictionaryLeadStatus}
+
+Данные справочника по умолчанию:
+
++--------------------------------+-----------------------------+----------------+-------------------+-------------------+--------------------------------+
+| **Название**                   | **Порядковый номер пункта** | **Качество**   | **Законченность** | **Цвет панели в** | **Название кнопки**            |
+|                                | **в выпадающем списке**     |                |                   | **воронке**       |                                |
++================================+=============================+================+===================+===================+================================+
+| Первичная регистрация          | 1                           | Качественный   | Не конечный       | `#de682d`         |                                |
++--------------------------------+-----------------------------+----------------+-------------------+-------------------+--------------------------------+
+| Квалификация                   | 2                           | Качественный   | Не конечный       | `#ee902d`         |                                |
++--------------------------------+-----------------------------+----------------+-------------------+-------------------+--------------------------------+
+| Взращивание                    | 3                           | Качественный   | Не конечный       | `#f3c02d`         |                                |
++--------------------------------+-----------------------------+----------------+-------------------+-------------------+--------------------------------+
+| Подтверждение интереса         | 4                           | Качественный   | Не конечный       | `#c9d02c`         |                                |
++--------------------------------+-----------------------------+----------------+-------------------+-------------------+--------------------------------+
+| В сделку                       | 5                           | Качественный   | Конечный          | `#9fcb2c`         | Конвертировать в сделку        |
++--------------------------------+-----------------------------+----------------+-------------------+-------------------+--------------------------------+
+| Некачественный лид             | 6                           | Некачественный |                   | `#b82b2b`         |                                |
++--------------------------------+-----------------------------+----------------+-------------------+-------------------+--------------------------------+
+
+Если некоторые параметры не были указаны, то им присваиваются значения
+по умолчанию:
+
+- "Качество": "Качественный";
+
+- "Законченность": "Не конечный";
+
+- "Цвет панели в воронке": #f3c02d
+
+Должна быть единственная запись о некачественном статусе и единственная - 
+о конечном статусе лида.
+
+#### Статусы сделки {#dictionaryDealStatus}
+
++-------+--------------------------------+
+| **№** | **Название**                   |
++=======+================================+
+| 1     | Уточнение потребности          |
++-------+--------------------------------+
+| 2     | Подготовка предложения         |
++-------+--------------------------------+
+| 3     | Защита предложения             |
++-------+--------------------------------+
+| 4     | Закрытие сделки                |
++-------+--------------------------------+
+| 5     | Отказ                          |
++-------+--------------------------------+
+
+#### Статусы аккаунта {#dictionaryAccountStatus}
+
++-------+--------------------------------+
+| **№** | **Название**                   |
++=======+================================+
+| 1     | Клиент                         |
++-------+--------------------------------+
+| 2     | Потенциальный клиент           |
++-------+--------------------------------+
+
+#### Статусы контакта {#dictionaryContactStatus}
+
++-------+--------------------------------+
+| **№** | **Название**                   |
++=======+================================+
+| 1     | Активен                        |
++-------+--------------------------------+
+| 2     | В отпуске                      |
++-------+--------------------------------+
+| 3     | Не активен                     |
++-------+--------------------------------+
+| 4     | В командировке                 |
++-------+--------------------------------+
+
+#### Типы мероприятий {#dictionaryEventType}
+
++-------+--------------------------------+
+| **№** | **Название**                   |
++=======+================================+
+| 1     | Входящий маркетинг             |
++-------+--------------------------------+
+| 2     | Исходящий маркетинг            |
++-------+--------------------------------+
+
+#### Телефон {#dictionaryPhone}
+
++-------+---------------+
+| **№** | **Название**  |
++=======+===============+
+| 1     | Рабочий       |
++-------+---------------+
+| 2     | Мобильный     |
++-------+---------------+
+| 3     | Факс          |
++-------+---------------+
+| 4     | Домашний      |
++-------+---------------+
+| 5     | Другой        |
++-------+---------------+
+
+#### Адрес {#dictionaryAddress}
+
++-------+---------------+
+| **№** | **Название**  |
++=======+===============+
+| 1     | Основной      |
++-------+---------------+
+| 2     | Рабочий       |
++-------+---------------+
+| 3     | Домашний      |
++-------+---------------+
+| 4     | Другой        |
++-------+---------------+
+
+#### Почта {#dictionaryEmail}
+
++-------+---------------+
+| **№** | **Название**  |
++=======+===============+
+| 1     | Официальный   |
++-------+---------------+
+| 2     | Рабочий       |
++-------+---------------+
+| 3     | Личный        |
++-------+---------------+
+| 4     | Другой        |
++-------+---------------+
+
+#### Социальные сети {#dictionarySocialNetworks}
+
++-------+--------------------------------+
+| **№** | **Название**                   |
++=======+================================+
+| 1     | Facebook                       |
++-------+--------------------------------+
+| 2     | LinkedIn                       |
++-------+--------------------------------+
+| 3     | Twitter                        |
++-------+--------------------------------+
+| 4     | Instagram                      |
++-------+--------------------------------+
+| 5     | VK                             |
++-------+--------------------------------+
+| 6     | Behance                        |
++-------+--------------------------------+
+| 7     | Другой                         |
++-------+--------------------------------+
+
+#### Действия напоминаний {#dictionaryremindActions}
+
++-------+--------------------------------+
+| **№** | **Название**                   |
++=======+================================+
+| 1     | Напомнить                      |
++-------+--------------------------------+
+| 2     | Позвонить                      |
++-------+--------------------------------+
+| 3     | Поздравить                     |
++-------+--------------------------------+
+| 4     | Отправить письмо               |
++-------+--------------------------------+
+| 5     | Отправить документ             |
++-------+--------------------------------+
+| 6     | Пригласить на мероприятие      |
++-------+--------------------------------+
+| 7     | Назначена встреча              |
++-------+--------------------------------+
+
+

crm/user-manual/src/index.md

@@ -6,6 +6,7 @@ title: Руководство пользователя кейса CRM
 ...
 
 <#include "storage.md">
-
+<#include "marketing.md">
+<#include "appendix.md">
 
 

crm/user-manual/src/marketing.md

+Внешний модуль "Маркетинг" {#sec.marketing}
+===============================================
+
+## Общее {#marketing.main}
+
+Внешний модуль содержит компоненты:
+
+*   Групповые кнопки, переключающие вид отображения воронки:
+
+	*   [Воронка](#marketing.funnel)
+
+	*   [Канбан](#marketing.pipeline)
+
+*   [Панели стоимости и комиссии](#marketing.cost_comission)
+
+*   [Боковая панель](#marketing.sidePannel)
+
+	*   [Мероприятие](#marketing.event)
+
+	*   [Пользователи](#marketing.users)
+
+	*   [Фильтры](#marketing.filters)
+
+<#include "marketing_funnel.md">
+<#include "marketing_pipeline.md">
+<#include "marketing_cost_comission.md">
+<#include "marketing_sidePannel.md">
+

crm/user-manual/src/marketing_cost_comission.md

+### Панели стоимости и комиссии {#marketing.cost_comission}
+
+1.  Стоимость лидогенерации в панели - сумма значений компонента
+    [Потенциальный бюджет](#lead) всех лидов текущей воронки.
+
+1.  Комиссия лидогенерации в панели рассчитывается как:
+
+    `стоимость лидогенерации * % комиссии`
+
+    где `% комиссии` - значение поля "% комиссии" первой созданной записи
+    реестра [% комиссии](#commission).
+
+1.  Значение поля "% комиссии" для каждого отдельного лида идет в расчет
+    согласно значению поля "Законченность" записи справочника
+    [Статусы лида](#dictionaryLeadStatus):
+
+	*   "Конечный" - % комиссии на момент сохранения этого статуса;
+
+	*   остальные - % комиссии на конец [рассматриваемого периода](#marketing.filters).
+
+1.  Если в записи реестра [% комиссии](#commission) указано
+    несколько записей с одинаковыми датами начала, то в расчет идет
+    последний % комиссии, удовлетворяющий требованиям.
+
+

crm/user-manual/src/marketing_funnel.md

+### Воронка лидогенерации {#marketing.funnel}
+
+По нажатию на кнопку "Воронка" вид основной области изменяется на воронку 
+лидогенерации. Воронка представлена в виде кнопок статусов лида, определяемых 
+в Конфигураторе (илл. "Воронка лидогенерации").
+
+![Воронка лидогенерации](resources/img/funnel_1.png)
+
+Кнопки статусов имеют форму трапеции и содержат два типа значений:
+
+*   количество лидов данного статуса;
+
+*   коэффициент конвертации.
+
+Ширина кнопок статична, высота - динамична и определяется количеством лидов 
+соответствующих статусов.
+
+Значения в воронке отображаются в формате:
+
+    *%название_статуса%*
+
+    *%количество_лидов_статуса% (%коэффициент_конвертации%)*
+
+> **Примечание 1:** коэффициент конвертации отсутствует для кнопки первого статуса.
+
+> **Примечание 2:** коэффициент конвертации рассчитывается как процентное отношение 
+*количества лидов последующего статуса* к *количеству лидов предыдущего статуса*.
+
+> **Примечание 3:** изменение высоты кнопок, количества лидов и коэффициентов 
+конвертации происходит в режиме реального времени.
+
+По нажатию на кнопку статуса лида откроется реестр [Лид](#lead), 
+отфильтрованный согласно выбранным [мероприятиям](#marketing.event), 
+[пользователям](#marketing.users) и статусу.
+
+Если воронка содержит один статус, то его кнопка также отображается в виде 
+трапеции на максимальную высоту всей воронки.
+
+Если не выбран ни один [пользователь](#marketing.users) и ни одно [мероприятие](#marketing.event) 
+(при выключенном флаге "Показывать лиды, не привязанные к мероприятиям"), 
+воронка отображается пустой (илл. "Пустая воронка лидогенерации"): 
+
+*   значения количества лидов и коэффициента конвертации - 0;
+
+*   кнопки имеют минимальную высоту.
+
+![Пустая воронка лидогенерации](resources/img/funnel_2.png)
+
+

crm/user-manual/src/marketing_pipeline.md

+### Канбан {#marketing.pipeline}
+
+По нажатию на кнопку "Канбан" вид основной области изменяется на канбан 
+лидогенерации, который является развернутым представлением воронки 
+лидогенерации с детализацией сведений о лидах (илл. "Канбан лидогенерации"):
+
+![Канбан лидогенерации](resources/img/canban.png)
+
+> [Канбан (Kanban)](https://ru.wikipedia.org/wiki/%D0%9A%D0%B0%D0%BD%D0%B1%D0%B0%D0%BD) - 
+методология управления производством. Одним из ее инструментов является доска, где все 
+текущие задачи распределены по столбцам, соответствующим стадиям производства. При 
+условии своевременной актуализации расположения задач на этой доске такой подход наглядно 
+отображает общий статус производства и позволяет своевременно корректировать возможные 
+отставания от плана.
+
+Основная рабочая область содержит панели лидов, расположенные в виде таблицы, где:
+
+*   столбцы - статусы лида (значения поля "Название" справочника [Статусы лида](#dictionaryLeadStatus)) 
+согласно текущей [фильтрации](#marketing.filters);
+
+*   строки - лиды.
+
+Панели статусов окрашены в цвета, указанные в поле "Цвет панели в воронке" 
+справочника [Статусы лида](#dictionaryLeadStatus).
+
+Панели лидов отсортированы в столбце по убыванию значений компонента 
+[Потенциальный бюджет](#lead) всех лидов текущего статуса.
+
+Панель статуса содержит:
+
+*   Название статуса лида (согласно справочнику [Статусы лида](#dictionaryLeadStatus)
+
+*   Количество лидов данного статуса
+
+*   Сумма значений компонента [Потенциальный бюджет](#lead) всех лидов 
+текущего статуса.
+
+Панель лида содержит значение полей:
+
+- [Наименование аккаунта](#account)
+
+- [Тема сотрудничества](#lead)
+
+- [Потенциальный бюджет](#lead)
+
+- [Ответственный менеджер](#lead) (отображается в панели лида 
+только для руководителя)
+
+По нажатию на панель лида откроется соответствующая запись реестра [Лид](#lead).
+
+**Примечание 1:** имеется возможность перемещения панелей лидов горизонтально 
+между столбцами при помощи drag-n-drop, при этом статус лида не изменится.
+
+**Примечание 2 :** цвет фона [наименования аккаунта](#account) в панели соответствует 
+цвету воронки для выбранного статуса согласно справочнику [Статусы лида](#dictionaryLeadStatus) 
+прозрачностью 30%.
+
+

crm/user-manual/src/marketing_sidePannel.md

+### Боковая панель {#marketing.sidePannel}
+
+Боковая панель предназначена для фильтрации сведений о лидах, котодые 
+должны включаться в воронку/канбан лидогенерации.
+
+Доступна настройка следующих параметров отображения:
+
+- [мероприятие](#marketing.event)
+
+- [пользователи](#marketing.users)
+
+- [фильтры](#marketing.filters)
+
+
+#### Мероприятие {#marketing.event}
+
+Параметр "Мероприятие" позволяет выбрать записи реестра 
+["Маркетинговые мероприятия"](#marketing_event) для оценки количества лидов, 
+привлеченных определенными мероприятиями. Также существует возможность 
+отображения статистики по лидам, привлеченным вне проведенных мероприятий 
+(флаг "Показывать лиды, не привязанные к мероприятиям", по умолчанию включен).
+
+Для выбора мероприятия пользователь нажимает на кнопку <...>. Открывается 
+диалог выбора мероприятий:
+
+![Диалог выбора мероприятий](resources/img/eventChooser.png)
+
+Список записей в параметре ограничен правами авторизованного пользователя:
+
+*   руководителю отображаются мероприятия, в которых ответственным менеджером 
+является он либо его подчиненные;
+
+*   пользователю отображаются только те мероприятия, в которых ответственным 
+менеджером является данный пользователь.
+
+Компонент позволяет множественный выбор мероприятий. По умолчанию выбраны все 
+мероприятия.
+
+#### Пользователи {#marketing.users}
+
+Параметр позволяет выбрать ответственного менеджера, чьи лиды отображены в 
+основной области. По умолчанию отображены лиды авторизованного пользователя. 
+
+Параметр содержит авторизованного пользователя, а также его подчиненных, 
+которые входят в группу "Маркетологи". Доступен множественный выбор пользователей.
+
+#### Фильтры {#marketing.filters}
+
+Доступно два параметра фильтрации:
+
+*   Период
+
+*   Статус лида
+
+При фильтрации лидов за период учитывается только факт смены значения в поле "Статус" 
+записи реестра [Лиды](#lead). Если за указанный период значение этого поля 
+изменялось несколько раз, то в воронке учитывается только последнее изменение.
+
+Параметр **"Период"** представлен выпадающим списком и двумя компонентами выбора даты, 
+разделенными тире. 
+
+Выпадающий список периода содержит пункты:
+
+*   *"За все время"* - воронка содержит все лиды с момента создания записи реестра 
+до текущего времени на сервере. Этот пункт выбран по умолчанию.
+
+*   *"Прошедшая неделя"* - учитываются только те лиды, у которых изменился статус 
+за последнюю неделю от текущего дня на сервере.
+
+*   *"Прошедший месяц"* - учитываются только те лиды, у которых изменился статус 
+за последний месяц от текущего дня на сервере.
+
+*   *"Прошедший квартал"* - учитываются только те лиды, у которых изменился статус 
+за последний квартал от текущего дня на сервере.
+
+*   *"Прошедший год"* - учитываются только те лиды, у которых изменился статус за 
+последний год от текущего дня на сервере.
+
+*   *"Произвольный период"* - учитываются только те лиды, у которых изменился статус 
+за указанный пользователем период. При выборе этого пункта активны компоненты выбора 
+даты.
+
+Параметр **"Статус"** представлен выпадающим списком с пунктами:
+
+- *"Все"* (учитываются все записи справочника [Статусы лида](#dictionaryLeadStatus) 
+со значением "Качественный"), пункт выбран по умолчанию;
+
+- название статуса лида со значением "Конечный" из справочника [Статусы лида](#dictionaryLeadStatus);
+
+- названия статусов лидов со значением "Некачественный" из справочника 
+[Статусы лида](#dictionaryLeadStatus);
+
+
+
+
+