Комплит - умный помощник для написания технической документации

"Комплит" - это ваш интеллектуальный помощник, который поможет создавать техническую документацию быстрее и качественнее. Работая прямо в браузере, он анализирует контекст ваших документов, предлагает умные подсказки и может даже преобразовывать голосовые команды в структурированный текст.

Что умеет Комплит?

Умное автодополнение текста

Представьте, что вы пишете требования к новому модулю системы. Комплит, работающий на основе современной языковой модели Google Gemma 3 4B, анализирует уже написанный текст и предлагает продолжение, учитывая контекст всего документа. Просто нажмите Enter, чтобы принять предложение, или Escape, если хотите написать по-своему.

Работа с документами

Загружайте документы в любом удобном формате - PDF, DOCX, TXT или Markdown. Комплит автоматически проанализирует их содержимое и построит базу знаний, которая поможет создавать более точные и контекстно-зависимые подсказки для новых документов.

Голосовой ввод

Устали печатать? Просто наговорите текст! Комплит преобразует вашу речь в текст, автоматически его отформатирует и структурирует. Хотите что-то изменить? Выделите текст и снова используйте голосовой ввод для редактирования.

Умный анализ требований

При написании требований Комплит автоматически определяет:

• Кто будет выполнять действие (пользователь, система, администратор)
• Какое именно действие должно быть выполнено
• С чем будет выполняться действие
• Какой результат ожидается

Это помогает создавать более четкие и структурированные требования.

Как начать работу с Комплит?

1. Установка необходимого ПО

Docker

1. Скачайте и установите Docker Desktop:

   • Для Windows/Mac: с официального сайта Docker
   • Для Linux: установите docker и docker-compose через пакетный менеджер

2. После установки проверьте, что Docker работает:

docker --version
docker-compose --version

2. Настройка проекта

1. Клонируйте репозиторий:

git clone [URL репозитория]
cd MilashkaAI

2. Скачайте языковую модель:

• Перейдите на Hugging Face
• Скачайте файл gemma-3-4b-it-q4_0.gguf
• Поместите его в папку models/

3. Создайте файл с настройками:

cp .env.example .env

Отредактируйте .env, указав:

HOST=0.0.0.0
PORT=8000
MODEL_PATH=./models/gemma-3-4b-it-q4_0.gguf

3. Запуск сервера

1. Соберите и запустите контейнеры:

docker-compose build server
docker-compose up -d

2. Проверьте, что всё работает:

curl http://localhost:8000/

4. Установка расширения для браузера

1. Откройте Chrome/Firefox
2. Перейдите в меню управления расширениями
3. Включите "Режим разработчика"
4. Нажмите "Загрузить распакованное расширение"
5. Выберите папку extension из проекта
6. В настройках расширения укажите адрес сервера: http://localhost:8000

Проверка работоспособности

1. Откройте любой текстовый документ в браузере
2. Нажмите на иконку Комплит в панели расширений
3. Попробуйте:
   • Написать несколько слов и дождаться подсказки
   • Нажать на иконку микрофона и продиктовать текст
   • Загрузить существующий документ для анализа

!!! Сейчас Работа с текстом возможна только в простых текст-эдит-блоках – обычных полях ввода.

Участие в разработке

1. Форкните репозиторий
2. Создайте ветку для вашей фичи
3. Внесите изменения
4. Отправьте пул-реквест

Лицензия

Проект распространяется под лицензией MIT. Подробности смотрите в файле LICENSE.