Артефакты¶
Артефакт — самостоятельная единица описания будущего Продукта: смысл, замысел, требование, схема процесса, диаграмма решения. Артефакты создают участники Авторского коллектива (Автор, Соавторы, Мастер) и Исполнители — в них сообщество удерживает общее понимание того, что и зачем создаётся, до того как начинается воплощение. Вместе с описанием Проекта, формулировками задач и текстом Коммитов артефакты формируют Результат интеллектуальной деятельности (РИД), который Компонент сдаёт в кооператив как имущественный паевой взнос.
Допуск — обязательное условие¶
Создавать, редактировать и удалять артефакты вправе только участник, имеющий допуск (clearance) к Компоненту или Проекту. Допуск — это формальное приложение к договору УХД, фиксирующее участие пайщика в этом конкретном Проекте; оно подписывается пайщиком, одобряется советом и хранится в кооперативе.
- На странице, где у пайщика нет допуска, на месте плавающей кнопки в правом нижнем углу видна не «+», а «Принять участие». Это вход в подачу заявки на допуск.
- После одобрения совета на той же странице плавающая кнопка раскрывается обычным набором действий — в нём есть пункт «Артефакт (R)» (хоткей R), открывающий диалог создания.
- Просматривать артефакты можно и без допуска — но только читать.
Где это и когда вы это видите¶
В Благоросте артефакты живут на двух уровнях:
- Проект → вкладка «Артефакты». Общие концептуальные документы, видимые всем компонентам проекта: концепция, словарь, архитектурный обзор, целевая аудитория. На странице проекта таблица показывает и собственные артефакты проекта, и артефакты всех его компонентов с бейджем имени компонента справа от заголовка.
- Компонент → вкладка «Артефакты». Артефакты конкретного компонента: подробные требования, диаграммы процессов, схемы. Видны в рамках своего компонента и подтягиваются на список проекта.
Артефакты можно создавать на любой стадии работы — но особенно важны они до Коммитов: Исполнитель воплощает результат по тем артефактам, которые приготовил Авторский коллектив.
Какие форматы поддерживаются¶
При создании артефакта (хоткей R на вкладке) вы выбираете один из четырёх форматов. Сменить формат после сохранения нельзя — выбирайте сразу под ту форму, в которой удобно описать содержание.
Markdown — текст¶
Базовый формат: заголовки, списки, выделения, ссылки. Внутри Markdown можно вставлять блоки с диаграммами Mermaid — они отрендерятся прямо в тексте.
Mermaid — диаграмма кодом¶
Отдельный артефакт-диаграмма (без обёртки Markdown). Слева вы пишете текст диаграммы на языке Mermaid, справа сразу видите живой предпросмотр. Формат хорош, когда диаграмма — самостоятельный документ, на который ссылаются другие артефакты.
BPMN — бизнес-процесс¶
Нотация BPMN 2.0 в визуальном редакторе bpmn-js. Слева — палитра элементов: события (старт/конец), задачи, шлюзы, пулы и дорожки; справа — канвас, на котором вы соединяете элементы стрелками потока. Подходит для описания цепочек ответственности и условных ветвлений между ролями.
Draw.io — произвольная схема¶
Встроенный редактор diagrams.net: блок-схемы, mind maps, сетевые диаграммы, архитектурные схемы — всё, что не вписывается в строгую BPMN. Имеет полную палитру фигур и панель инструментов сверху.
Как создать артефакт¶
- Зайдите на вкладку «Артефакты» проекта или компонента — у вас должен быть допуск.
- Нажмите хоткей R (или раскройте плавающую кнопку «+» и выберите «Артефакт (R)»).
- В диалоге введите заголовок и выберите формат: Markdown, Mermaid, BPMN или Draw.io.
- Заполните тело — для Markdown прямо в диалоге, для Mermaid/BPMN/Draw.io после сохранения откроется отдельный редактор формата.
- Ctrl+Enter или ⌘+Enter — сохранить.
Артефакт попадает в список вкладки и сразу становится частью проектного контекста: на него можно ссылаться из других артефактов, его текст подтягивается в РИД при сдаче результата.
Артефакты на задачах — отдельный путь
На некоторых задачах вы можете встретить артефакты, привязанные именно к задаче. Это переходный механизм — со временем такие артефакты переедут в общие списки на компоненте/проекте, чтобы у каждого артефакта было одно место и одна ссылка.
Как выбрать формат¶
| Что описываете | Формат |
|---|---|
| Текстовое описание, требования, чек-листы | Markdown |
| Диаграмма последовательности, ER, классы | Markdown с Mermaid внутри (или отдельный Mermaid) |
| Бизнес-процесс с ролями и ветвлениями | BPMN |
| Архитектура / mind map / произвольная схема | Draw.io |
В сомнительных случаях — Markdown: он самый гибкий, и в нём всегда можно встроить ту же Mermaid-диаграмму как блок кода.
Список артефактов проекта¶
На уровне проекта таблица собирает всё: и собственные артефакты проекта (без бейджа), и артефакты каждого его компонента (с бейджем имени компонента под заголовком). Это удобный обзорный экран, с которого можно перейти к артефакту любого уровня в один клик.
Артефакты и Результат интеллектуальной деятельности¶
Когда Мастер Компонента нажимает «Внести результат», в один документ собирается всё, что относится к Компоненту: его артефакты, артефакты родительского Проекта, описание Проекта, задачи и тексты Коммитов. Этот документ закрепляется в блокчейне как неизменяемое доказательство существования. Сам текст остаётся во внутренней базе кооператива.
Именно этот собранный документ — и есть РИД, который Компонент вносит в кооператив как имущественный паевой взнос. Подробнее — в Результат интеллектуальной деятельности.