Пример ваулта Obsidian для работы над требованиями и пользовательскими историями. Предзназначен для использования системными аналитиками.
- .obsidian: служебная папка Obsidian с настройками и используемыми плагинами
- Истории: для пользовательских историй
- Требования: для требований
- Фичи: для эпиков и фич
- Шаблоны заметок: шаблоны заметок для плагина Templater, привязанные к папкам
Истории,ТребованияиФичи
- Главная: стартовый канвас со сводкой основных таблиц
- Истории: таблица историй
- Последние изменения: список последних изменённых заметок
- Требования - все: все требования
- Требования - реализация по версиям: требования в состояниях реализация/готово и основными подробностями
- Фичи: таблица фич
| Поле | Тип | Значение |
|---|---|---|
| created | дата-время | отметка времени создания заметки для вывода в запросах dataview |
| updated | дата-время (динамическое) | отметка времени изменения заметки из свойств файла заметки |
| accociations | связанные заметки | для удобства пользователя. Не имеет функционального значения |
Начинается с req. и является уникальным кодом требования, состоящим из кодов контекста, разделённых точками - от наиболее общего контекста до наиболее конкретного (часть после последней точки).
Такая система кодирования:
- Обеспечивает четкую структуризацию требований
- Позволяет легко группировать связанные требования
- Упрощает навигацию по документации
- Делает понятным контекст каждого требования
- Облегчает добавление новых требований в существующую структуру
Неструктурированная заметка, которая совмещает в себе бизнес запрос и функциональное требование.
До этапа анализа это бизнес-запрос (поле requirement), после этапа анализа и заполнения остальных полей становится требованием.
| Поле | Тип | Значение |
|---|---|---|
| requirement | строка | исходный бизнес-запрос |
| source | строка | источник(и) запроса |
| applications | число | сколько бизнесов или продуктов из категории клиентов заинтересованы в реализации этого требования |
| type | строка | (необязательно) тип запроса: br - бизнес, ur - пользовательский |
| due | дата | (необязательно) срок реализации |
| blocks | строка | (необязательно) кого из клиентов или пользователей блокирует |
| votes | число | сколько пользователей заинтересованы в реализации этого требования |
| fr | строка | функциональное требование, сформулированное на основе бизнес-запроса |
| implementation | [[ссылка]] | ссылка на историю, в рамках которой реализуется это требование. Используется для вывода в истории списка включённые в неё требований, а также в таблице реализованных требований |
| implemented | дата | (необязательно) дата реализации |
| status | цифра-строка | статус запроса. Важны цифра в начале, текст нужен только для удобочитаемости Одно из значений: 1-новый, 2-анализ, 3-оценка, 4-отклонён, 5-бэклог, 6-реализация, 7-готово |
| version | строка | версия продукта, в которой реализовано это требование, в формате семантического версионирования major.minor.patch |
| tests | строка | (необязательно) по одному такому полю на каждый тест данного требования |
| ac | строка | критерий приёмки - по одному такому полю на каждый критерий приёмки данного требования. Будет выведен в истории, где реализуется данное требование |
Начинается с us. и является уникальным кодом истории. Логика формирования аналогична логике формирования названия заметки требования.
Структурированная заметка, представляющая собой описание пользовательской истории. Состоит из двух частей (в заметке два соответствующих заголовка первого уровня):
- Содержит поля dataview для метаданных истории, а также разделы для заполнения произвольным текстом/таблицами/диаграммами и т.п.
- Полностью генерируется на основе первой части в виде, пригодном для копирования/вставки во внешнюю систему. Копировать нужно из режима чтения (не из режима редактирования).
Используется сокращённый набор тех же полей, что в истории, а также нескольких дополнительных полей, назначение которых должно быть понятно из контекста.
Структурированная заметка, представляющая собой описание фичи. Структура похожа на первую часть истории, но попроще.