Документация на ПО
Подробная документация на ПО НИАП (Научный Инструмент Анализа и Персонализации Питания)
Содержание:
1. Начало работы и управление аккаунтом
— Регистрация
— Восстановление пароля аккаунта
— Вход в личный кабинет и первоначальные настройки
— Разделы настроек
2. Работа с клиентами: от регистрации до сбора данных
— Картотека клиентов
— Онлайн-анкетирование
— Раздел «Данные»
— Раздел «Анамнез»
— Раздел «Пищевой дневник»
3. Информационные разделы: Продукты, Рецепты, БАДы
— Раздел «Продукты»
— Раздел «Рецепты»
— Раздел «БАДы»
4. Создание рациона
5. Итоговый клиентский отчет
6. Описание технологического стека
Эта документация представляет собой подробное описание по работе с профессиональной платформой для диетологов и нутрициологов НИАП. Здесь вы найдете описание всех функций, начиная от регистрации и заканчивая созданием итогового отчета для клиента.
- Начало работы и управление аккаунтом
1.1. Регистрация
Для начала работы на платформе необходимо пройти процедуру регистрации:
- На сайте https://niap.ion.ru/ перейдите на вкладку «Регистрация».
2. Заполните необходимые поля: ваше имя, актуальный адрес электронной почты и придумайте пароль.
3. Укажите вашу профессию и номер телефона.
Внимание! Перед завершением регистрации убедитесь в правильности написания e-mail, так как на него будет отправлено письмо для подтверждения.
4. После получения письма перейдите по ссылке в нем для подтверждения регистрации.
1.2. Восстановление пароля
- На сайте https://niap.ion.ru/ нажмите на кликабельный текст кнопку «Забыли ваш пароль?».

- Заполните необходимое поле: актуальный адрес электронной почты на который ранее вы регистрировали аккаунт.

Внимание! Перед нажатием на кнопку «отправить ссылку восстановления» убедитесь в правильности написания e-mail, так как на него будет отправлено письмо со ссылкой восстановления пароля.
1.3. Вход в личный кабинет и первоначальные настройки
- Для входа в систему на сайте https://niap.ion.ru/ перейдите на вкладку «Войти» и используйте e-mail и пароль, указанные при регистрации.

- Сразу после входа вы попадете в личный кабинет.

Внимание! Рекомендуется настроить свой профиль перед началом работы.
3. Кликните на свое имя в правом верхнем углу и перейдите в «Настройки».
1.4. Разделы настроек
- Подписка: Здесь отображается информация о вашем текущем тарифе, сроке его действия, истории платежей. Вы можете продлить подписку, сменить тариф и управлять автоплатежом.

- Личные данные: Внесите и при необходимости отредактируйте вашу фамилию, имя, отчество, дату рождения, пол. Здесь же можно загрузить личную фотографию.

- Логотип: Укажите вашу профессию, титул, место работы и должность. Вы можете загрузить логотип вашего учреждения или личный логотип. Эта информация будет отображаться в отчетах для клиентов.

- Безопасность: В этом разделе вы можете сменить пароль для входа в личный кабинет.

- Техническая поддержка: В нижнем левом углу любого раздела личного кабинета находится кнопка для связи со службой технической поддержки.

- Работа с клиентами: от регистрации до сбора данных
2.1. Картотека клиентов
Это основной раздел для управления вашими клиентами. Здесь хранится список всех клиентов, с которыми вы работаете.

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

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

- Редактирование и удаление: Для редактирования данных клиента нажмите на значок карандаша напротив его имени. Для удаления — на значок корзины.

2.2. Онлайн-анкетирование
Эта функция позволяет автоматизировать сбор данных о клиенте.
- Перейдите в раздел «Данные» и выберите вкладку «Анкетирование».

- Скопируйте персональную ссылку на анкету для выбранного клиента и отправьте ему любым удобным способом (мессенджер, e-mail).
- Сообщите клиенту его «секретное слово» для безопасного доступа к анкете.
- Все данные, внесенные клиентом в онлайн-анкету, автоматически обрабатываются и появляются в соответствующих разделах вашего личного кабинета.
2.3. Раздел «Данные»
Здесь хранится вся основная информация о клиенте.
- Регистрация: Общие данные клиента (ФИО, пол, дата рождения), контактная информация и место жительства.

- Антропометрия: Информация о весе, росте и объемах тела. На основании этих данных рассчитываются различные индексы (например, «Рекомендуемый вес»), которые можно детализировать и просматривать в динамике.

- Биоимпедансометрия и калиперометрия: Вы можете вносить данные этих исследований вручную или синхронизировать с аппаратами InBody для автоматического заполнения полей.

- Метаболизм: В этом разделе рассчитывается базовый метаболизм и суточные нормы потребления нутриентов. Эти расчеты производятся автоматически на основе данных клиента, но могут быть скорректированы вручную.


2.4. Раздел «Анамнез»
Содержит информацию о здоровье клиента.

- Хронические заболевания: Указываются заболевания согласно МКБ-10. Выбор определенных заболеваний автоматически корректирует нормы потребления нутриентов и отмечает запрещенные продукты.
- Аллергии и непереносимости: Информация об аллергиях на продукты, БАДы и лекарства, а также о пищевых непереносимостях. Эти данные также учитываются при автоматической генерации рациона.
- Диетанамнез: Отображается тип питания клиента (вегетарианство, безглютеновая диета и т.д.), количество приемов пищи и потребляемой воды.

- Препараты: Список лекарств и нутрицевтиков, которые принимает клиент.

2.5. Раздел «Пищевой дневник»

- Клиент может заполнять пищевой дневник самостоятельно по отправленной вами ссылке.
- Интерфейс адаптирован для мобильных устройств.
- Вы можете в режиме реального времени отслеживать, что ест клиент, и анализировать фактическое питание.
- Вы можете заполнять пищевой дневник самостоятельно со слов клиента.

- На основе данных дневника можно сгенерировать подробный отчет об оценке фактического питания, нажав соответствующую кнопку

- Информационные разделы: Продукты, Рецепты, БАДы
3.1. Раздел «Продукты»
Обширная база данных с полным химическим составом тысяч продуктов.

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

- Сравнение продуктов: Функция сравнения позволяет наглядно увидеть различия в нутриентном составе нескольких продуктов.

- Подробная информация: По каждому продукту доступна карточка с детальным химическим составом, включая витамины, минералы и аминокислоты.

3.2. Раздел «Рецепты»
База данных, содержащая десятки тысяч рецептов. Нутриентный состав рецептов рассчитывается с учетом холодной и термической обработки продуктов.
- Поиск и фильтры: Ищите рецепты по названию, ингредиентам, типу питания, способу приготовления и возрастным категориям.

- Создание собственных рецептов: Вы можете добавлять свои рецепты, и их нутриентный состав будет рассчитан автоматически.

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

- Избранное: Сохраняйте понравившиеся и собственные рецепты в «Избранное» для быстрого доступа.
3.3. Раздел «БАДы»
Каталог биологически активных добавок от различных производителей.

- Поиск и фильтры: Ищите БАДы по названию, производителю или активному веществу.

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

- Создание рациона
Этот режим предоставляет полный контроль над процессом создания индивидуального рациона.
- Выберите клиента и перейдите в раздел «Рационы».
- Нажмите «Ручное создание».

- Добавляйте приемы пищи, указывая их название и время.
- В каждый прием пищи добавляйте продукты и рецепты из базы данных.
- В режиме реального времени отслеживайте, как меняется нутриентный состав дня.
- Используйте инструменты копирования приемов пищи и целых дней для ускорения работы.
- При необходимости добавляйте БАДы для коррекции дефицитов.

- Итоговый клиентский отчет
После создания рациона вы можете сгенерировать подробный и наглядный отчет для клиента.
- В разделе «Рационы» во вкладке «Созданные» выберите нужный рацион и нажмите на три точки.

- Краткий отчет: Включает рекомендуемое меню, нутриентный состав, список продуктов для покупки и рецепты.
- Полный отчет: Содержит всю информацию из краткого отчета, а также отчет по оценке фактического питания.
- Отчет генерируется в формате веб-страницы, которую можно отправить клиенту ссылкой или сохранить в PDF.

Внимание! Для корректного отображения ваших данных на титульном листе отчета убедитесь, что вы заполнили личную информацию в настройках профиля.
6. Описание технологического стека
6.1. Архитектура и способ распространения
Программное обеспечение НИАП реализовано как облачный веб-сервис (SaaS) с использованием микросервисной архитектуры. Данный подход обеспечивает высокую масштабируемость, отказоустойчивость и удобство доступа для конечных пользователей без необходимости установки ПО на локальные устройства.
6.2. Программная платформа и компоненты разработки
Технологический стек подобран для обеспечения высокой производительности и безопасности обработки данных:
Backend: Laravel/PHP
Веб-сервер: Nginx в связке с PHP-FPM
Frontend: Angular с использованием языка TypeScript
СУБД: MariaDB