DevFest
Omsk 2024

Знания разработчика важны для создания и поддержания качественной API-документации. Чтобы эти знания перетекали от разработчика в доку и к пользователям, нужен выстроенный процесс. Поэтому мы обсудим подходы документирования API и ошибки, которые часто встречаются, конкретные действия разработчиков, что можно автоматизировать.

Доклад будет полезен командам, которые хотят улучшить свою API-документацию и уметь её поддерживать.

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

‍Доклад будет полезен всем тем, кто работает в продуктовых командах. Одна из целей доклада: показать, как качественная техническая документация может сократить время на взаимодействие с партнерами и упростить работу разработчиков.

Было ли у вас такое, что после релиза очередной фичи, информация оказывается разбросанной по разным местам? В описаниях тикетов, статьях базы знаний, сообщениях мессенджеров и письмах почты. Даже у лучшей постановки на разных этапах разработки появляются новые требования и информация, которые почти сразу теряются. О решении именно этой проблемы мы поговорим. Обсудим, как сделать тикет (задачу в трекере) местом сбора всех нужных данных. Посмотрим, какие этапы жизненного цикла проходит тикет. Поймем, какой информацией и как его можно наполнить, чтобы ничего не потерять. Я расскажу, как мы в компании МойСклад сделали шаблон тикета в Jira, который помог нам упростить работу описания фичей и сохранить все важное.
‍
Доклад будет полезен системным и бизнес-аналитикам, разработчикам, тестировщикам.

В докладе мы разберем несколько общепринятых практик создания и поддержки архитектурной документации, а также сделаем обзор индустриальных стандартов и фреймворков для написания такой документации.

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