«Не бывает задач, над которыми вредно думать»

С утра пораньше пересматриваю доклад Фила Дельгядо про дизайн-ревью. Суть практики в том, чтобы перенести ревью пораньше к началу задачи:
— Раньше обдумывали решение в процессе работы, а ревью делали на готовом коде. А потом переделывали, потому что решение неверное.
— Теперь обдумываем дизайн решения, сразу ревьюим его, а потом пишем код. Меньше переделываем, больше радуемся.

Хорошая практика, рекомендую хотя бы познакомиться и обдумать. Тестировщики узнают в этом shift left. Для документации это точно так же применимо: можно обдумать место и структуру для будущей доки. В Тарантуле мы часть этой работы делаем в процессе триажа задачи.

https://youtu.be/4Y0XJXRZv6k

Максим Лапшин рассказывал про API-first подход на недавнем TechLead Conf. Это, пожалуй, самое полезное, что можно послушать про OpenAPI, потому что Максим объясняет смысл и суть документирования API. А уж как это делать технически, можно прочитать в документации и куче статей, и это не так важно.

Этот доклад здорово перекликается с рассказом про Design Review от Фила Дельгядо — я писал о нём в прошлом посте. Рекомендую смотреть оба в любом порядке.

https://www.youtube.com/watch?v=FonPUYCikoQ

(Всего месяц прошел с конфы, ссылка публикуется впервые с разрешения Максима, эксклюзив и контрабанда!)

Писать в документации «мы» — довольно фиговая практика. Непонятно, кто это. Мы, которые писали код? Мы, которые писали доки? Мы с читателем (щас на пару тут пройдем туториал)?

Хуже этого только «мы» в логах и API. Вот прямо сейчас я смотрю на We are completely uploaded and fine, а после этого ответ 502. Нет, мы не fine, совсем не fine.

Из менторской сессии. Бывают вот такие диалоги:
— Чувак у нас сарай горит!
— «Чувак» это обращение, после него нужна запятая!

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

— Мы как будто сегодня докапываемся до того, как держим вилку и нож, а вчера мы ели людей и это никого не беспокоило.

А что у вас в сообщениях коммитов и описаниях пулл-реквестов? Пишете как попало? Соблюдаете сотню правил и пишете многостраничные тексты? Что-то среднее? Расскажите :)

Подкаст про DocOps для аналитиков

Николай Поташников позвал меня поговорить про документацию и DocOps для аналитиков в подкаст Flow Live. Спикеры очень клёвые и разные, я даже не со всеми знаком, самому очень интересно.

А пока что накидайте вопросов и тем, пожалуйста. Особенно если вы системный/бизнес/другой аналитик. Что вам интересно, про что хотите услышать, что у вас болит в документации?

Сказать в подкасте, что мы все умрём и это нормально — сделано ✅

В целом, мне нравится, что у нас получилось. Посмотрите: https://youtu.be/ok9KMRCbrq8

Обсуждаем «красные флажки» в описании одной компании на HH:

* Вы и Клиент с заглавной.
* Куча ошибок в тексте.
* Три восклицательных знака, Карл!!!
* Sudden английский в тексте в совершенно unexpected местах.
* «Философия оплаты» и дальше про то что соцпакет не нужен.

Тут есть шутка, которая мне кажется смешной, но больше никто её пока что не понял. Выручайте. :)

А вообще, можно собрать пару товарищей и поговорить о признаках хороших и плохих работодателей. И для техписателей, и вообще.

Привет! Новый опрос про деврел готов.

В 2022 году нас знатно раскидало по миру, поэтому мы будем говорить про русскоязычный деврел в целом. И еще наконец-то появился блок вопросов про зарплату.

Даже если вы занимаетесь деврел не 100% рабочего времени, а совмещаете с другим направлениями — этот опрос тоже для вас.

Опрос открыт до 14 ноября.
Время прохождения: 15-30 минут.
Результаты исследования за 2021 год смотрите тут.

Мы все заинтересованы в максимальном охвате, поэтому заполняйте опрос сами и отправляйте его коллегам и конкурентам.

Ссылка на опрос.

Женя Голева каждый год проводит опрос специалистов, чья работа относится к Developer Relations. Обязательно поучаствуйте, даже если это не ваша основная работа, а вы просто пишете статьи или собираете митапы в свободное время. И на канал подпишитесь. :)

Я настолько зол, что напишу пост не по теме. Onetwotrip не вернули мне деньги за возврат билета. Сначала полтора месяца типа рассматривали заявку, а потом прислали письмо, на которое нужно было срочно ответить, чтобы заявку не отменили. Мудилы, не иначе. Поддержки в приложении нет, можно только звонить и висеть в очереди в колл-центре. Сервис — говно.

Короче, не покупайте у них билеты, не приходите к ним работать, пусть они обанкротятся к чертям. :)

Вернем канал в техническое русло. Сегодня в пятидесятый раз делился любимым алиасом для гита. Поделюсь и с вами.

$ git config --global alias.lg \
    "log --color --graph --abbrev-commit --all \
    --pretty=format:'%Cred%h%Creset -%C(yellow bold)%d%Creset %s \
    %Cgreen(%cr) %C(blue)<%an>%Creset'"

$ git lg

Показывает граф с историей коммитов прямо в консоли, удобно смотреть что там коллеги намержили или проверять как ребейз получился. Кидайте в комменты скриншоты, я начну :)

А что, есть ли у меня читатели из Бишкека? Я буду там в воскресенье. Пойдем пить чаек и разговаривать о работе? Напишите в комментариях или в личку @nick_volynkin.

В эту среду будем обсуждать DocOps в работе системных аналитиков на конференции Flow. Собираемся прекрасной компанией, я всех этих людей очень ценю и уважаю, но вместе мы все ещё, кажется, не собирались: Лана Новикова, Семён Факторович, Константин Валеев, Николай Поташников, ну и автор этого канала Ник Волынкин. Если вы будете на конференции — приходите слушать нас в среду в 16:45 Мск.

Если у вас нет билета, но вы вдруг решите его купить прямо сегодня, держите прокомод на -20%: DocOps2022JRGpc.

Сегодня сообщество пользователей Foliant празднует два года своего существования. Поздравляю авторов и сообщество, спасибо вам за классный инструмент (который я сам не использую, но регулярно рекомендую).

В честь дня рождения сегодня вечером планируются кухонные онлайн-посиделки. Заходите в https://news.1rj.ru/str/foliantdocs, там будет ссылка на звонок.

Уточню: это сообществу два года, а сам Foliant старше еще года на два.

The GOVNO framework is a novel approach to project management that aims to improve upon the shortcomings of the popular scrum methodology. Each letter of the acronym represents a key aspect of the framework:

— Governance
— Objectives
— Visibility
— Networks
— Outcomes, not outputs

https://govno.works/

Шедевр же )

Нейросети отбирают работу у специалистов по Developer Relations :)

Нашёл образец фиговой документации.

Вообще, у меня тут куча новостей и контента для вас. Ещё немного разделаюсь со срочными делами и буду писать чаще.

Сижу на встрече с докладчиками дружественной конференции FrontendConf. Среди тем есть управление знаниями и всё что вокруг него. Классно, что ребята тоже это ценят и понимают важность. Если вам есть что рассказать про онбординг, профессиональный рост, документацию и сообщества во фронтенде — скорей подавайте заявку. https://cfp.frontendconf.ru