1 Введение
1.1 Назначение
2 Требования пользователя
2.1 Программные интерфейсы
2.2 Интерфейс пользователя
2.3 Характеристики пользователей
2.3.1 Классы пользователей
2.3.2 Целевая аудитория
3 Системные требования
3.1 Функциональные требования
3.2 Нефункциональные требования
В этом документе описаны функциональные и нефункциональные требования к приложению «CVTOOL» для web. Проект представляет собой корпоративный инструмент для сбора и хранения информации о своих сотрудниках, а также для создания резюме в формате pdf/docx с индивидуальным корпоративным дизайном.
Проект включает в себя как клиентскую часть, так серверную часть. Клиент должен быть реализован с использованием современных фронтенд технологий, а именно ReactJS. Сервер должен быть реализован с использованием современных бэкенд технологий, а именно такого фреймворка как Ruby on Rails. Сервер должен осуществлять активное взаимодействие с базой данных PostgresQL для хранения всей информации приложения, включая информацию о пользователях, резюме, проектах, скиллов, департаментов и вопросов. Также сервер должен иметь хорошую документацию для упрощения работы фронтенд разработчика. Документация должна быть сделана с помощью Swagger.
Далее представлен интерфейс, разработанный совместно с дизайнером. При входе в приложение, пользователь должен попасть на экран авторизации.
При отсутствии аккаунта пользователь должен иметь возможность зарегистрироваться.
После авторизации обычный пользователь должен попасть на страницу заполнения резюме, которая состоит из 5 шагов. На первом шаге пользователь должен ввести персональнаю информацию: личные данные, образование, позицию, способности.
На втором шаге пользователь должен ввести опыт работы в предыдущих компаниях.
На третьем шаге пользователь должен ввести опыт работы в текущей компании.
На четвертом шаге должна появиться матрица скиллов, которая будет сгенерирована исходя из данных, введенных на втором и третьем шаге, и которую можно редактировать.
На пятом шаге будет располагаться превью из заполненных на предыдущих шагах данных. После заполнения резюме пользователь будет видеть две кнопки: отправить на ревью координатору и редактировать резюме.
Пользователь, зашедший под аккаунтом координатора, при логине будет видеть список пользователей с фильтрами.
Зайдя в просмотр резюме со статусом "On Review", координатор должен иметь возможность утвердить резюме или же отправить на доработку. Так же он должен мочь отредактировать данное резюме и скачать его в формате pdf/docx(При нажатии на кнопку "CV" должно появиться модальное окно).
Пользователь, зашедший под аккаунтом супер-админа, кроме всех возможностей координатрота, должен мочь назначать координаторов и редактировать всю внутреннюю информацию о компании, а именно проекты, департаменты, юниты, позиции, вопросы, скиллы.
Данные возможности должны быть сделаны в едином формате. Дизайн показан на примере секции "Questions"
В приложении существуют 3 группы полезователей:
- Обычные пользователи
- Координаторы
- Супер-админ
Обычные пользователи - пользователи, которые зарегистрировались и авторизировались в приложении. Они могут заполнять свое резюме и отправлять его на проверку координаторам. Координаторы - пользователи, которым супер-админ дал права особые права. Они могут просматривать, редактировать, одобрять или возвращать обратно резюме обычных пользователей. Супер-админ - пользователь, который наделен особыми правами через серверскую консоль. Они имеют все права координаторов, а также могут назначать их.
Данное приложение ориентированно на it-компании и их сотрудников.
Должны быть реализованы следующие возможности:
- Регистрация пользователей
- Авторизация пользователей
- Заполнение резюме
- Предпросмотр резюме
- Редактирование резюме других пользователей координаторами и супер-админом
- Список заполненных резюме
- Поиск резюме с помощью фильтрации
- Генерация резюме в формате pdf или docx
- Изменение внутренних данных компании(вопросы, проекты, скиллы, позиции, департаменты)
- Язык интерфейса - Английский.
- Тип шифрования - HTTPS.
- Версия Rails 6.1.5.
- Версия React 16.4.2.
- Версия Sidekiq 5.1.3.
- Версия PostgreSQl 9.0.
- Поддерживаемые браузеры: Google Chrome версии 96.0 и выше, Mozilla Firefox версии 98.0 и выше, Opera версии 70.0 и выше, Microsoft Edge версии 100 и выше.