Docs: инструменты для совместного создания заметок и управления документами с открытым исходным кодом

Общее введение

Docs - это платформа для совместного ведения заметок и управления документами с открытым исходным кодом, разработанная командой suitenumerique. Она использует Django и React Цель создания технологии - предоставить простой в использовании инструмент, который поможет пользователям делать заметки, управлять документами и обмениваться знаниями. Эта платформа поддерживает совместную работу нескольких человек в режиме реального времени и подходит для командного использования. Ее дизайн вдохновлен Понятие Docs - это новая версия программного обеспечения, которая является полностью бесплатной и с открытым исходным кодом и может быть развернута самими пользователями. Она предоставляет базовые возможности редактирования документов, а также такие полезные функции, как синхронизация в автономном режиме и экспорт файлов. Docs, которая по своей сути призвана сделать управление знаниями более эффективным, продолжает постоянно обновляться, а ее официальный релиз ожидается в феврале 2025 года.

Список функций

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

Использование помощи

Docs - это инструмент, который должен быть развернут локально или на сервере, и у него нет легкодоступной онлайн-версии. Здесь представлено подробное руководство по установке и использованию, которое поможет вам быстро начать работу.

Процесс установки

Для работы Docs требуются Docker и Docker Compose, поэтому сначала убедитесь, что они установлены на вашем компьютере. Официальные рекомендуемые версии - Docker 20.10.2 и Docker Compose 2.32.4. Проверить версии можно с помощью следующих команд:

docker -v
docker compose version

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

sudo usermod -aG docker $USER

Затем перезагрузите компьютер, чтобы он вступил в силу.

Затем загрузите код Docs. Откройте терминал и введите:

git clone https://github.com/suitenumerique/docs.git
cd docs

Когда код будет загружен, перейдите в раздел docs чтобы начать сборку проекта. Выполните следующую команду:

docker compose up --build

Эта команда автоматически загрузит зависимости, создаст базу данных и запустит службу. Возможно, вам придется подождать несколько минут для первого запуска. Если вы увидите в терминале сообщение об успешном запуске службы, установка завершена.

Документы по умолчанию запускаются по локальному адресу http://localhost:3000. Откройте браузер и введите этот адрес для доступа. Если вы хотите войти в систему с тестовой учетной записью, официальный адрес электронной почты предоставляется test.docs@yopmail.com и пароли I'd<3ToTestDocs.

Основные функции

Создание и редактирование документов

После входа в систему нажмите кнопку "Новый документ" на странице, Docs откроет чистую страницу, и вы сможете напрямую вводить текст. Интерфейс редактирования очень прост и поддерживает базовое форматирование, такое как жирный шрифт, курсив, заголовок и т. д. При редактировании с несколькими пользователями вы будете видеть курсоры и изменения других людей в режиме реального времени. При редактировании несколькими пользователями вы будете видеть курсор и изменения, сделанные другими пользователями, в режиме реального времени.

автономная синхронизация

Если сеть не работает, Docs автоматически сохранит изменения локально. Как только сеть восстановится, нажмите кнопку "Синхронизировать" в правом верхнем углу, и изменения будут загружены на сервер. Нет необходимости устанавливать какие-либо дополнительные настройки, система сделает это автоматически.

Экспорт документов

Когда вы закончите писать документ, нажмите на опцию "Экспорт" в правом верхнем углу. .pdf, и.doc возможно .odt Формат. После выбора формата нажмите "Загрузить", и файл будет сохранен на вашем компьютере.

Вспомогательные средства искусственного интеллекта

В Docs есть некоторые встроенные функции искусственного интеллекта, например генерация текста или его перевод. Выделите фрагмент текста, щелкните значок ИИ на панели инструментов и выберите "Сгенерировать" или "Перевести". Например, если вы напечатаете "Написать введение", ИИ автоматически сгенерирует текст. Если вы хотите перевести, выберите целевой язык, и ИИ переведет текст. Эти функции требуют подключения к Интернету.

Настройка разрешений

Хотите контролировать, кто может видеть или изменять документ? На странице документа нажмите кнопку "Поделиться". docs позволяет установить три вида разрешений: только для чтения, редактирования и невидимости. Введите адрес электронной почты сотрудника, выберите разрешения и нажмите "Подтвердить". После установки разрешений доступ к документу смогут получить только приглашенные люди.

Создание вики

Docs позволяет организовывать документы в вики, нажав на пункт "Вики" в левом меню и выбрав "Новая вики". Перетащите существующие документы или напишите новый контент прямо в вики. Когда вы закончите работу, члены команды смогут просматривать базу знаний через вики.

предостережение

• По умолчанию Docs использует Minio в качестве службы хранения. Если вы хотите использовать другое хранилище S3 (например, AWS), вам нужно изменить конфигурационный файл. Смотрите официальный installation.md Документация.
• Локальные запуски предназначены только для тестирования и не могут использоваться непосредственно в производственных средах. Для развертывания на производстве требуется дополнительная настройка, например, настройка HTTPS.

Выполнив эти действия, вы сможете легко установить и использовать Docs, который пока еще работает, но уже удовлетворяет основные потребности в управлении заметками и документами.

сценарий применения

1. Управление проектами в команде
   Члены команды используют Docs для записи хода проекта и обновления статуса задач в режиме реального времени. Все могут видеть последние данные и избегать рассинхронизации информации.
2. Организация личных знаний
   Студенты и исследователи используют Docs для ведения заметок и организации информации. Поддержка экспорта позволяет легко превратить ваши заметки в документ или отчет.
3. Работа на дому
   Распределенные команды используют Docs для создания документов и установки разрешений, чтобы только нужные люди могли видеть конфиденциальное содержимое, безопасно и эффективно.

QA

1. Являются ли документы бесплатными?
   Да, Docs - это полностью открытый исходный код, который выпускается под лицензией MIT. Любой может скачать и использовать его бесплатно.
2. Нужны ли мне знания программирования, чтобы использовать его?
   Не требуется. Обычные пользователи могут использовать базовые возможности Docs, выполнив шаги по установке. Те, кто умеет программировать, могут самостоятельно изменять код для добавления функций.
3. Поддерживает ли он мобильные телефоны?
   В настоящее время Docs доступен в Интернете и в мобильных браузерах, однако специального мобильного приложения нет, но оно может быть разработано в будущем.