Дизайн-документ
Что такое дизайн-документ
Дизайн-документ — это спецификация вашего проекта в виде связного текста. Если граф проекта отвечает на вопрос «из чего состоит задача и кто за что отвечает», то документ отвечает на «что именно делать»: у каждого блока графа появляется своё содержимое, а внутри — артефакты: разделы, примеры, требования, которые команда заберёт в работу.
Чем это лучше „ТЗ в вакууме“. Обычное техзадание пишется одним куском и живёт отдельно от плана работ: структура — как получилось у автора, ответственные — где-то в другой таблице, обновление — переписыванием. Здесь структура документа наследуется от графа: каждый раздел привязан к конкретному блоку и специальности, порядок следует зависимостям, а если задача изменилась — перегенерируется отдельный блок, не весь текст. Документ и план не могут разъехаться, потому что это одна и та же структура.
Текст пишется потоком у вас на глазах: можно собрать весь документ сразу (блоки идут в порядке зависимостей — от источников к зависимым), а можно генерировать по одному блоку или артефакту. Дальше — обычная редактура: правки руками, точечная правка выделенного фрагмента по короткой инструкции, выгрузка готовым файлом. Каждое изменение блока сохраняется в истории — к любой версии можно откатиться, так что экспериментировать безопасно.
Попробовать за три шага.
- Откройте проект с построенным графом (ещё нет проекта — создайте, это пара минут) и перейдите на экран документа.
- Запустите генерацию всего документа — и смотрите, как разделы наполняются в порядке зависимостей.
- Выберите блок, который знаете лучше всего, и доведите его: правка руками или короткая инструкция «перепиши строже/проще/подробнее».
Состав блоков и артефактов задаётся проектом и его коллекцией; за качество генерации отвечает в том числе Pro-режим — несколько черновиков с выбором лучшего.
Домен: Дизайн-документ
Дизайн-документ — это пояснительный текст проекта, разложенный по блокам графа. У каждого блока (ноды) есть своё содержимое, а внутри блока — артефакты: более мелкие части (разделы, примеры, спецификации). Документ можно собрать целиком или по одному блоку, править вручную и выгружать готовым файлом.
Генерация идёт потоком: текст появляется по мере написания — для одного блока, для одного артефакта или для всего документа сразу (топологически, от блоков-источников к зависимым). Точечная правка переписывает выделенный фрагмент по короткой инструкции. Каждое изменение блока версионируется — историю можно посмотреть и откатиться к любой прошлой версии.
Весь домен привязан к проекту: всё, что здесь происходит, требует доступа к конкретному проекту (своему, унаследованному в спейсе или гостевому). Источник истины по правам — матрица RP, границы доступа агента — Конвенции. Ниже — методы API и экран домена.
Методы API
| Метод | Эндпоинт | Статус |
|---|---|---|
| PATCH /api/projects/:id/artifacts/:itemId/implementation-kind | PATCH /api/projects/:id/artifacts/:itemId/implementation-kind | done |
| Содержимое дизайн-дока | 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 | 24 |