Дизайн-документ
Домен: Дизайн-документ
Дизайн-документ — это пояснительный текст проекта, разложенный по блокам графа. У каждого блока (ноды) есть своё содержимое, а внутри блока — артефакты: более мелкие части (разделы, примеры, спецификации). Документ можно собрать целиком или по одному блоку, править вручную и выгружать готовым файлом.
Генерация идёт потоком: текст появляется по мере написания — для одного блока, для одного артефакта или для всего документа сразу (топологически, от блоков-источников к зависимым). Точечная правка переписывает выделенный фрагмент по короткой инструкции. Каждое изменение блока версионируется — историю можно посмотреть и откатиться к любой прошлой версии.
Весь домен привязан к проекту: всё, что здесь происходит, требует доступа к конкретному проекту (своему, унаследованному в спейсе или гостевому). Источник истины по правам — матрица RP, границы доступа агента — Конвенции. Ниже — методы API и экран домена.
Методы API
| Метод | Эндпоинт | Статус |
|---|---|---|
| Содержимое дизайн-дока | GET /api/projects/:id/doc-content | done |
| Содержимое блока | GET /api/projects/:id/doc-content/:nodeId | done |
| Изменить содержимое блока | PATCH /api/projects/:id/doc-content/:nodeId | partial |
| Артефакты блока | GET /api/projects/:id/doc-content/:nodeId/artifacts | done |
| Изменить артефакт | PATCH /api/projects/:id/doc-content/:nodeId/artifacts/:contentItemId | done |
| Сгенерировать артефакт (SSE) | POST /api/projects/:id/doc-content/:nodeId/artifacts/:contentItemId/generate | done |
| Сгенерировать блок (SSE) | POST /api/projects/:id/doc-content/:nodeId/generate | partial |
| История версий блока | GET /api/projects/:id/doc-content/:nodeId/history | done |
| Версия блока из истории | GET /api/projects/:id/doc-content/:nodeId/history/:version | done |
| Точечная правка блока (SSE) | POST /api/projects/:id/doc-content/:nodeId/inline-edit | done |
| Восстановить версию блока | POST /api/projects/:id/doc-content/:nodeId/restore/:version | done |
| Сгенерировать весь документ (SSE) | POST /api/projects/:id/doc-content/generate-all | done |
| Экспорт дизайн-дока | GET /api/projects/:id/export/design-doc | done |
Экраны
| Экран | Элементов |
|---|---|
| Design Doc | 23 |