← Все гайды

Проекты и совместная работа над документацией

· 2 мин чтения

Как организовать документацию команды: проекты с папками, приглашение участников, ссылки между файлами, совместное редактирование в реальном времени и чат соавторов.

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

Как создать проект

  1. Войдите и откройте меню профиля → Мои проекты, нажмите «Создать проект».
  2. Добавьте артефакты: кнопкой Создать (выберите инструмент) или перенесите свои личные — «Перенести в проект».
  3. Переключитесь на вид По папкам, создайте папки кнопкой Папка и перетащите в них артефакты мышью.
Проект с папками и артефактами разных инструментов
Дерево проекта: папки и артефакты разных инструментов

Участники

  • На вкладке Участники пригласите коллег по email. Если у человека ещё нет аккаунта, он получит письмо с предложением зарегистрироваться.
  • Артефакты проекта видят и меняют все участники. Удалить артефакт может его автор или владелец проекта.
  • Лимит артефактов тарифа считается по автору.

Ссылки между файлами

Путь в дереве папок — адрес для ссылок: $ref в OpenAPI, AsyncAPI и JSON Schema, schemaLocation в XSD и WSDL, include:: в AsciiDoc, ссылки в Markdown. Ctrl+клик по ссылке открывает файл. Подробнее — «OpenAPI из нескольких файлов» и «XSD из нескольких файлов».

Совместная работа в реальном времени

  • Если документ уже открыт коллегой, появится предложение Приступить к совместной работе: вы увидите курсоры и правки друг друга, сохранить может любой участник.
  • В совместной работе есть чат соавторов — можно вставить скриншот из буфера (Ctrl+V).
  • Совместная работа в реальном времени доступна, если у владельца проекта тариф «Команда».
  • Без неё каждый работает со своей копией; если кто-то сохранил раньше, при сохранении появится выбор: посмотреть изменения, затереть их или сохранить свою версию новым артефактом.

Выгрузка

Артефакт, папку или весь проект можно скачать: несколько файлов — zip-архивом со структурой папок.

Пример структуры проекта

Интеграция с банком/
├── adr/            решения по архитектуре (Markdown)
├── api/            orders.yaml, payments.yaml (OpenAPI)
├── events/         orders.yaml (AsyncAPI)
├── schemas/        common.json (JSON Schema), bank.xsd
├── db/             model.dbml
└── processes/      payment.bpmn, sequence.puml

Вопросы и ответы

Сколько проектов можно создать бесплатно? На тарифе «Старт» — до 5 проектов и до 5 артефактов каждого инструмента. Подробности — на странице «Тарифы».

Видят ли участники мои личные артефакты? Нет, только то, что лежит в проекте. Личный артефакт можно перенести в проект и убрать обратно.

Как работать с проектом из IDE? Через MCP-сервер ИИ-агенты читают и правят артефакты проекта — гайд.

Гайд помог?