📃RFCs

Что такое Requests For Comments, как и зачем их писать.

Почему RFC

RFC дает возможность записать идеи и планы, которые могут быть реализованы в будущем. Через такой документ удобно вести обсуждения в распределенной команде и не терять контекст.

RFC буквально означает «Запрос на комментарии». Хотя RFC может иметь различные формы для самых разнообразных целей, в конечном итоге – это всего лишь обычный документ с несколькими атрибутами:

  • Порядковый номер

  • Статус

  • Короткое название

  • Направление

  • Автор

  • Дата создания

Процесс создания RFC и коммуникации должен быть легким и не требовать больших затрат времени и усилий.

RFC можно представить как асинхронный разговор. В отличие от чата, электронной почты или других каналов, использование RFC подразумевает, что:

  • не требуется сразу отвечать

  • у рецензентов есть время подумать и предложить изменения

  • больше людей могут взаимодействовать одновременно не мешая друг другу

  • RFC легко искать, и на них можно ссылаться

  • RFC хранятся неограниченное время

Когда использовать RFC

  • Вы хотите сформулировать проблему и предложить решение

  • Вам нужна вдумчивая обратная связь от членов вашей распределенной команды

  • Вы хотите поделиться идеей, замечаниями или отзывом

  • Вы хотите инициировать проект или предложить план реализации чего-нибудь, чтобы сформировать рабочую группу

  • Необходимо подсветить и передать информацию о важном межфункциональном решении

Когда не стоит использовать RFC

  • Вы хотите обсудить личные или деликатные темы один на один с другим членом команды

  • Вы хотите принять решение об изменении чего-либо, где вы являетесь решающим фактором – в подавляющем большинстве случаев создание RFC для объяснений будет излишним

Формат документа

Порядковый номер

Каждый RFC имеет уникальный порядковый номер, который указывается в заголовке, например: RFC 1 Ревью: Формат RFC . Это облегчает быстрое обращение к конкретным RFC и упрощает поиск документа в Confluence. Порядковые номера также подсказывают в каком порядке создавались RFC.

Статус

Каждый RFC имеет статус в названии, например: RFC 1 WIP: Рефакторинг логирования

Автор RFC отвечает за обновление статуса:

  • WIP – автор еще работает над RFC, и он еще не готов к рассмотрению

  • Ревью проблемы – есть четкая постановка проблемы или предложение, рецензенты проверяют гипотезу автора на корректность

  • Ревью решения – проблема или предложение понятны, описано возможное решение, которое готово к рассмотрению

  • Принято – если RFC предназначен для принятия решения, метка указывает на то, что решение принято

  • Реализовано – в контексте принятого решения может быть сделана реализация, которую предлагает автор RFC

  • Закрыто – RFC предназначался не для принятия решения и реализации и больше не является активным артефактом

  • Неактуально – RFC предназначен для принятия решения, но нет планов по дальнейшим действиям

Направление

Может быть как общим, так и частным:

  • Разработка

    • Бэкенд

    • Фронтенд

    • QA

    • Инфра

    • ...

  • Продукт

    • Рассрочка

    • ...

  • Процессы

    • Спринты

    • Требовавания

    • ...

По возможности данный тег необходимо унифицировать.

Last updated