Техническое задание на разработку и внедрение

K-TEAM.

Модуль База Знаний

Функциональные возможности ролей описаны в ролевой матрице.
Роль пользователя должна определяться по соответствующей ей группе пользователей Системы. Соответствующие группы пользователей создаются в Системе дополнительно к стандартным группам пользователей.
Создание уровней доступа и пользовательских групп для работы с Базой знаний доступно для пользователей с ролью: «Администратор».

Назначение ролей: «Автор», «Тематический редактор», «Выпускающий редактор», производится пользователем с ролью «Администратор» должно осуществляться в разделе меню Базы знаний — «Управление доступом».
Для этого в разделе «Управление доступом» необходимо предусмотреть блок «Распределение прав».
Блок должен содержать поля: 

• Поле ввода выпускающего редактора;
• Поле ввода тематического редактора;
• Поле ввода авторов.

Ввод должен осуществляться с помощью ввода первых букв фамилии пользователя с дальнейшим выбором из списка предложенных сотрудников.
Сохранение пользователей должно быть реализовано через кнопку «Сохранить».
Управление уровнем доступа для всех пользователей должно осуществляться в разделе «Управление доступом» в блоке «Управление доступами». По умолчанию должно быть установлен уровень доступа «Чтение».

На Портале необходимо реализовать точку входа для просмотра и поиска информации, размещенной в Базе знаний.
Для этого в разделе «База знаний» необходимо реализовать функциональность «Главная страница».
К Главной странице Базы знаний предъявляются следующие требования в части просмотра:
Просмотр страницы доступен всем пользователям Портала.

Навигационное меню Базы знаний
Для перехода в разделы Базы знаний на Главной странице должно быть реализовано сквозное навигационное меню. Меню должно включать пункты:
«База знаний»;
«Глоссарий»;
«Мои подписки»;
«Создать статью» (отображение и доступ согласно ролевой модели);
«Создать раздел» (отображение и доступ согласно ролевой модели);
«Мои статьи» (отображение и доступ согласно ролевой модели);
«Мои разделы» (отображение и доступ согласно ролевой модели);
«Управление доступом» (отображение и доступ согласно ролевой модели);
«Рассылки» (отображение и доступ согласно ролевой модели);
«Группы согласующих» (отображение и доступ согласно ролевой модели).
По клику на пункт меню необходимо осуществлять переход в соответствующий раздел.
Интерфейс навигационного меню представлен на Рисунок 2 под номером 1. 

Меню разделов Базы знаний
Для навигации по тематическим разделам статей Базы знаний, на Главной странице необходимо разработать блок «Меню разделов».
По клику на пункт меню необходимо осуществлять переход на страницу раздела со списком анонсов статей раздела. В случае, если в разделе имеются вложенные подразделы, то в разделе верхнего уровня должны отображаться все статьи вложенных подразделов.

Для поиска информации по статьям и файлам Базы знаний, на Главной странице необходимо разработать блок «Поиск по Базе знаний».
По умолчанию Поиск содержит элементы:

• Поисковая строка — служит для ввода ключевых поисковых фраз. Поиск осуществляется по точному вхождению, не учитывает морфологию. Поиск осуществляется по типам данных:

• Заголовок статьи;
• Анонс статьи;
• Текст статьи;
• Название документа;
• Текст документа (формат word или текстовый pdf);
• Тег;
• Термин из глоссария.
• Фильтр по типу данных;
• Кнопку «Найти»;
• Функцию «Расширенный поиск»;
• Функцию «Сбросить».

• Фильтр по разделу базы знаний;
• Фильтр по периоду публикации;
• Чекбокс «Поиск в архиве» — служит для поиска статей, отправленных в архив;
• Чекбокс «Поиск по подразделам» — служит для поиска статей в подразделах.

• Изображение статьи / иконка файла;
• Заголовок статьи с вхождением по запросу;
• Анонс статьи с вхождением по запросу;
• Текст документа с вхождением по запросу.

Для отображения популярных статей на Главной странице необходимо разработать блок «Популярное».
Блок должен быть реализован в виде слайдера с возможностью отображения до шести анонсов статей по три (для разрешения 1920рх) или по две статьи (для разрешения 1366рх) в блоке.
В блок должны выводиться статьи с максимальным количеством просмотров (учитываются неуникальные просмотры), начиная от двадцати.
Каждый анонс статьи в блоке «Популярное» должен содержать элементы: 

• Превью статьи;
• Теги статьи;
• Заголовок статьи;
• Анонс статьи;
• Дат публикации статьи;
• Количество лайков статьи;
• Количество комментариев статьи;
• Количество просмотров статьи.

Для отображения новых опубликованных статей на Главной странице необходимо разработать блок «Новые статьи».
В блоке должно отображаться до шести анонсов статей в порядке последней публикации.
Каждый анонс статьи должен содержать элементы: 

• Превью статьи;
• Теги статьи;
• Заголовок статьи;
• Анонс статьи;
• Дат публикации статьи;
• Количество лайков статьи;
• Количество комментариев статьи;

Для отображения статистики по статьям, размещенным в Базе знаний, необходимо реализовать на Главной странице блок «Статистика».
В блоке необходимо отображать информацию: 

• Общее количество статей в Базе знаний без учета статей в архиве;
• Новые статьи – статьи, опубликованные менее недели назад и не редактированные;
• Актуализированные — статьи, измененные менее недели назад;
• Опубликованы ранее — статьи, которые публиковались и изменялись неделю назад.

Для отображения автора, который опубликовал максимальное количество статей, на Главной странице Портала необходимо реализовать блок «Вклад в развитие Базы знаний». В блоке необходимо отображать информацию: 

• Фото автора;
• ФИО автора;
• Должно автора;
• Количество опубликованных статей — по клику необходимо открывать список статей автора;

На Портале необходимо создать возможность просмотра разделов статей Базы знаний.
Для этого на Портале необходимо предусмотреть иерархическое меню разделов.
К просмотру разделов Базы знаний предъявляются требования: 

• Просмотр разделов доступен всем пользователям Портала.

• Кнопку «Подписаться»;
• Поиск по разделу;
• Сортировку по названию;
• Сортировку по дате;
• Список анонсов статей в разделе. Каждый анонс должен содержать элементы:
• Превью статьи;
• Теги статьи;
• Заголовок статьи;
• Анонс статьи;
• Дат публикации статьи;
• Количество лайков статьи;
• Количество комментариев статьи;
• Количество просмотров статьи.
• Информация о редакторе раздела (если редактор привязан к разделу. Подробнее о добавлении редакторов пункт пункт)
• ФИО редактора;
• Фото редактора;
• Должность редактора.

На Портале необходимо создать возможность просмотра детальных страниц статей Базы знаний.
К просмотру страницы статьи предъявляются требования: 

• Просмотр страницы статьи в статусе «Опубликовано» доступен всем пользователям Портала;
• Просмотр страницы статьи в статусе «Черновик» доступен только авторам Портала;
• Просмотр страницы статьи в статусе «Согласование статьи» доступен автору статьи и согласующему редактору;
• Просмотр страницы статьи в статусе «Требуется согласование» доступен всем пользователям Портала (версия статьи без новых изменений) и автору статьи (с новыми изменениями);
• Просмотр страницы статьи в статусе «Согласование изменений» доступен автору статьи и согласующему редактору.

• Кнопка «Подписаться»;
• Кнопка «История изменений»;
• Теги;
• Анонс;
• Подробный текст;
• Термины и синонимы (если присутствуют в тексте статьи);
• Файлы для скачивания;
• Файлы галереи;
• Наименование раздела;
• ФИО автора статьи;
• ФИО соавторов (если добавлены);
• Дата публикации статьи;
• Возможность поставить лайк;
• Комментарии.

Для просмотра истории изменений, на странице статьи необходимо предусмотреть функциональность хранения и сравнения версий документа.
Функция сравнения версий документа должна быть реализована с помощью библиотеки HtmlDiff — добавление библиотеки должно осуществляться разработчиком индивидуально на площадке.
По клику на «История изменений» необходимо открывать историю со списком ранее сохраненных и опубликованных версий.

Страница сравнения версий должна содержать элементы: 

• Название версии статьи;
• Время изменения;
• Статус статьи;
• Раздел статьи;
• ФИО автора, внесшего изменения.

На Портале необходимо создать возможность просмотра списка терминов глоссария.
Для этого на Портале в разделе «База знаний» необходимо разработать страницу «Глоссарий». Страница должна быть доступна из пункта навигационного меню «Глоссарий».
К просмотру страницы «Глоссарий» предъявляются требования:

• Просмотр страницы доступен всем пользователям Портала.

• Поиск по термину;
• Алфавитный указатель в русскоязычном и англоязычном варианте;
• Кнопку «Добавить термин» (доступно для пользователей с ролью «Администратор» и «Выпускающий редактор»);
• Вкладки с терминами, отсортированные в алфавитном порядке.

• Название термина; 
• Описание термина;
• Кнопка «Редактировать» (Доступно для пользователей с ролью «Администратор» и «Выпускающий редактор»);
• Кнопка «Скрыть отображение» (Доступно для пользователей с ролью «Администратор» и «Выпускающий редактор»);
• Кнопка «Удалить термин» (Доступно для пользователей с ролью «Администратор» и «Выпускающий редактор»).

Термины, созданные в глоссарии, необходимо подсвечивать в статье активным цветом с возможностью просмотра описания термина во всплывающем модальном окне (Подробнее пункт 2.2.1.5). 

На Портале необходимо создать возможность просмотра своих созданных статей, а также просмотра статуса по ним.
Для этого на Портале в разделе «База знаний» необходимо разработать страницу «Мои статьи». Страница должна быть доступна из пункта навигационного меню «Мои статьи».
К просмотру страницы «Мои статьи» предъявляются требования:

• Просмотр страницы доступен авторам статей.

• Фильтр по статусам статей:
• Черновик;
• Согласование статьи;
• Согласование изменений;
• Требуется согласование;
• Опубликованные.
• Поиск по разделу;
• Сортировка:
• По названию;
• По дате.
• Список статей. Каждый элемент содержит:
• Раздел статьи;
• Заголовок статьи;
• Статус статьи.

На Портале необходимо создать возможность просмотра своих подписок на статьи и разделы, а также возможности отписаться от них.
Для этого на Портале в разделе «База знаний» необходимо разработать страницу «Мои подписки». Страница должна быть доступна из пункта навигационного меню «Мои подписки».
К просмотру страницы «Мои подписки» предъявляются требования:

• Просмотр страницы доступен всем пользователям Портала.

• Переключатель представлений «Мои статьи» и «Мои разделы»;
• Список статей / разделов. Содержит:
• Заголовок статьи;
• Название раздела.
• Кнопку «Отписаться»;
• Опцию «Получать подписки»:
• Сообщение в Outlook — отправка сообщений на почту;
• В колокольчик на портале — отправка сообщений в Центр уведомлений на Портале.

Верхнеуровневые разделы
На Портале необходимо реализовать возможность создания, редактирования и удаления верхнеуровневых разделов Базы знаний.
Для этого необходимо в разделе «Управление доступом» предусмотреть функциональность «Управление разделами».
Поля формы добавления верхнеуровневого раздела Базы знаний :

• Название раздела
• Описание
• Родительский раздел
• Тематический редактор
• Заместитель Тематического редактора
• Сортировка

Для редактирования верхнеуровневого раздела Базы знаний в блоке «Управление доступом» необходимо предусмотреть опцию «Редактировать раздел». 

После выбора необходимого раздела из списка разделов и клика на кнопку «Редактировать раздел», необходимо открыть форму редактирования раздела, содержащую поля, как и при создании.
Для удаления верхнеуровневого раздела Базы знаний, в разделе навигационного меню «Мои разделы» необходимо предусмотреть опцию «Удалить раздел».
По клику, необходимо отображать системное уведомление о том, что Вы собираетесь удалить раздел Базы знаний. По клику на «Ок» необходимо осуществлять удаление раздела из Системы.
Опция удаления раздела доступна только для разделов, в которых не содержится ни одной статьи. В случае, если в разделе есть добавленные статьи, то опция «Удалить раздел» не должна отображаться в разделе «Мои разделы». 

Для редактирования подраздела Базы знаний в пункте меню «Мои разделы» необходимо предусмотреть опцию «Редактировать раздел». По клику, необходимо открывать страницу с возможностью редактирования названия подраздела.
Для удаления подраздела Базы знаний, в пункте меню «Мои разделы» необходимо предусмотреть опцию «Удалить раздел».
По клику, необходимо отображать системное уведомление о том, что Вы собираетесь удалить раздел Базы знаний. По клику на «Ок» необходимо осуществлять удаление раздела из Системы.
Опция удаления раздела доступна только для разделов, в которых не содержится ни одной статьи. В случае, если в разделе есть добавленные статьи, то опция «Удалить раздел» не должна отображаться в разделе «Мои разделы». 

На Портале необходимо реализовать возможность создания, редактирования и удаления статей Базы знаний.
Для этого необходимо разработать функциональность создания статьи. Функциональность должна быть доступна из пункта навигационного меню «Создать статью». 

По клику на пункт меню «Создать статью» необходимо отображать страницу создания статьи с селектом выбора типа статьи:

• Базовая статья — шаблон для создания информационной статьи; 
• Нормативные документы — шаблон для создания нормативного документа.
  
  Поля формы создания Базовой статьи:

• Заголовок статьи (Название статьи).
• Раздел (Выбор раздела, в котором будет размещена статья).
• Теги (Название тега (добавляется через запятую).
• Анонс (Краткое описание содержания статьи).
• Подробный текст (Текст статьи)
• Галерея (Загрузка файлов, которые будут помещены в текст статьи).
• Материалы (Загрузка файлов, которые будут доступны для скачивания).

ШАГ 1:

На Портале необходимо реализовать возможность создания, редактирования и удаления терминов глоссария.
Для этого необходимо разработать функциональность работы с терминами. Функциональность должна быть доступна из пункта навигационного меню «Глоссарий».

Для добавления нового термина на странице «Глоссарий» необходимо предусмотреть кнопку «Добавить термин». По клику на кнопку необходимо отображать поп-ап с полями добавления термина:

• Название термина — обязательное поле;
• Описание термина — обязательное поле;
• Вводи синонимов — осуществляется через запятую;
• Отображение термина — возможность отображать или не отображать термин на странице «Глоссария». Скрытый термин будет доступен для просмотра только пользователям с ролью «Администратор» и «Выпускающий редактор». 

ШАГ 2:

После ввода данных и клика по кнопке «Сохранить», новый термин будет добавлен в глоссарий и отобразится в соответствующей вкладке.
Для редактирования термина, в карточке каждого термина должна быть предусмотрена иконка «карандаш».  

По клику необходимо открывать поп-ап работы с термином (соответствует поп-апу создания нового термина). После внесения новых данных и сохранения, информация о термине должна быть обновлена. 

Для удаления термина в карточке термина должна быть предусмотрена иконка «корзина». По клику необходимо отображать уведомление о том, что вы собираетесь удалить термин. По клику на «Удалить» необходимо удалять термин из Системы.

На Портале необходимо реализовать возможность создания, редактирования и удаления групп согласующих.
Для этого необходимо разработать страницу «Группы согласующих». Страница должна быть доступна из пункта навигационного меню Базы знаний «Группы согласующих».
Для создания группы согласующих на странице «Группы согласующих» необходимо разработать кнопку «Добавить группу».
По клику, необходимо открывать страницу создания группы.
На странице необходимо отображать элементы:

• Название группы;
• Согласующие — выбор из списка доступных пользователей (формируется на основании добавленных тематических и выпускающих редакторов. Подробнее пункт 2.1). 

После добавления согласующих и клика по кнопке «Сохранить» новая группа должна отобразиться на странице «Группы согласующих».
Должны быть доступны кнопки:

• «Изменить» — переход к редактированию группы согласующих.
• «Удалить» — удаление группы согласующих из Системы.

На Портале необходимо реализовать возможность создания, редактирования и удаления рассылок.
Для этого необходимо разработать страницу «Рассылки». Страница должна быть доступна из пункта навигационного меню Базы знаний «Рассылки». 

Для добавления новой рассылки на странице «Рассылки» должна быть предусмотрена кнопка «Добавить рассылку».
По клику необходимо открывать страницу создания рассылки.
На странице необходимо отображать поля:

• Название рассылки;
• Чекбокс «Рассылка дайджеста» — активирует еженедельную рассылку по статьям разделов.
• Кнопка «Добавить группу» — по клику разворачиваются поля:
• Подразделение — выбор подразделения из структуры;
• Должность — выбор должности для пользователей выбранного подразделения;
• Раздел wiki — выбор из структуры разделов базы знаний раздела, который будет участвовать в рассылке;
• Кнопка «Сохранить»;
• Кнопка «Отменить». 

После заполнения полей и клика по кнопке «Сохранить» необходимо сохранять новую рассылку и осуществлять переход на страницу «Рассылки».
На странице должна быть доступна новая созданная группа рассылки.
Должны быть доступны кнопки: 

• «Изменить» — переход к редактированию рассылки.
• «Удалить» — удаление группы рассылки.

В Базе знаний должно быть реализовано управление дайджестом рассылок. Управление дайджедстом должно быть доступно в пункте меню «Управление доступами» в блоке «Управление агентом дайджеста».

Поля для формирования агента дайджеста:

• Включен (При установленном чек-боксе агент будет активирован).
• Следующий запуск (Выбор даты запуска дайджеста).
• Дельта дней в дайджесте (Периодичность формирования дайджеста).

Для отправки тестовой рассылки, необходимо в разделе «Управление доступами» реализовать блок «Тестовый запуск агента» (Рисунок 22). В блоке необходимо отображать: 

• Поле «Почта для отправки дайджеста»;
• Кнопку «Запустить».

После отправки Автором статьи на согласование Тематическому редактору (а если Тематический редактор не указан, то Выпускающему редактору) должно быть сформировано задание на согласование статьи. Уведомление о сформированном задании должно поступать в Центр уведомлений на Портале.
Переход к просмотру задания должен осуществляться по ссылке в уведомлении.
Просмотр задания включает в себя возможности: 

• Просмотра статьи;
• Добавления дополнительных согласующих;
• Добавления групп согласующих (если таковые созданы в Системе);
• Согласование статьи (кнопка «Согласовать»);
• Отклонение статьи (кнопка «Отклонить»);
• Добавления комментария (обязательное поле при выборе действия «Отклонить»).