Как я обмазалась шаблонами, чтобы успевать готовить документацию к релизу и сохранять целостную картину.

В этой заметке я опускаю некоторые детали, связанные с процессами в компании, в которой сейчас работаю. Если кажется, что чего-то не хватает - это, скорее всего, намеренно.

Через несколько релизов я всё-таки сдалась. Стоило признать, что шаблоны удобны. Они снимают когнитивную нагрузку при планировании задач, повышают предсказуемость результатов спринта, да и, в конце-концов, являются лучшим ответом на вопрос “а чем сейчас занимается техписатель?”. Ну или “не забыла ли я чего?”. Или ещё “я вернулась после двухнедельного отпуска и надо вспомнить как работать и на чем я остановилась”. В общем, куча пользы и как будто никаких минусов.

Чего мне точно не хватало, так это структуры. Я всегда начинаю с неё, потому что без “скелета” любая попытка улучшить процесс для меня практически сразу обречена на провал и я начну прокрастинировать. Ресёрчить что-то без четкой цели тоже бесполезно. Поэтому я люблю декомпозировать свои задачи (не до атомов конечно, но, возможно, мы ещё до этого дойдем). И тут напрашивается банальное: ежедневные рабочие заметки я веду в Obsidian. Какие-то микро-шаблончики, скрипты, шпаргалки - всё в нем, родимом. Тогда начнем эксперимент.

Вот как я это организовала:

Release 1.0.0/
│
├── 0.release_overview.md
├── 1.epics/
├── 2.stories/
├── 3.release_notes/
├── 4.screenshots/
└── 5.known_issues/

Плюс таблица в Excel, куда без него.

Сначала ввела нужные мне категории, а файл release_overview.md будет первым шаблоном, содержащим исчерпывающую информацию по релизу, которая нужна именно для моих глаз, чтобы быстро понять, что мне осталось ещё сделать. В остальных папках тоже будут свои шаблоны, которые уже будут использоваться по мере работы над эпиком, сторей или релизной новостью.

release_overview.md#

Структура у release_overview.md примерно такая:

  • Release date

  • Code freeze date

  • Список ключевых фич (markdown таблица с названиями и id эпиков из Jira). В прошлый раз делала список чек-листом, для наглядности. Приятно вычеркивать готовые эпики, но пока экспериментирую с таблицей (вычеркивать в ней тоже можно)

  • Список рисков, о которых я знаю или узнаю по мере хода событий спринтов

  • Вопросы, которые надо задать аналитикам. Тоже чек-лист с линками на задачи. Если перестать хранить все вопросы в голове, то они даже начнут получать ответы

      Из этого шаблона как раз родилась идея создать таблицу в Excel и использовать её в последствии для отслеживания прогресса по написанию/обновлению документации перед релизом. Она пока ещё work-in-progress и о результатах говорить рано (не вышел ещё релиз), но пока впечатления положительные. Сильно снизился градус неопределенности и туманности в плане объема предстоящей работы.

epics/epic.md#

Ничего сложного, но удобно иметь под рукой, чтобы лишний раз не тратить на это время:

* [ID]Epic name(link) 
* Бизнес-ценность
* Проблема, которую решает для пользователя
* Вопросы и ответы

stories/story.md#

* [ID]Story name(link)
* Непосредственно функциональность, которая появилась или изменилась для пользователя
* Изменения в логике
* Связь с другими фичами
* Changelog

Changelog я, кстати, предложила всё-таки завести отдельным полем в Jira в сторях, так что аналитики сами его заполняют при написании стори, а я в итоге сверяюсь с фактической реализацией. Если учитывать специфику продукта, это необходимо и помогает быстро “въехать” в ценность для пользователя и использовать это потом в release notes.

release-notes.md#

Драфт релизной новости всегда живет сразу в неопубликованной next версии репозитория документации. Минимально полезный шаблон был бы таким:

## Новая функциональность

### Фича первая
### Фича вторая
### Фича третья

## Улучшения
### Улучшение раз
### Улучшение два
### Улучшение три

## Исправления
- Исправление раз
- Исправление два

Исправления в релизной новости указываю маркированным списком намеренно, они основаны на changelog и без иллюстраций.

screenshots.md#

Здесь планировала отмечать, какие ещё скриншоты осталось сделать, какие-то вопросы по ним. Но думаю, что это избыточно и можно просто использовать эту информацию в таблице Excel. В итоге отказалась от раздела. Ниже покажу таблицу, она реально удобнее.

→ Назад в блог