Ответ
Да, регулярно. В моей практике это важная часть работы в команде. Например, на одном из проектов я рецензировал OpenAPI-спецификацию для нового REST API. Я заметил, что в документации не хватало примеров ответов для различных кодов состояния HTTP и описания бизнес-логики для некоторых полей.
Я предложил добавить конкретные примеры и уточнить контракты. Это помогло фронтенд-разработчикам и мобильной команде быстрее и без ошибок начать интеграцию. Также я часто оставляю комментарии к документации в Confluence или README, если нахожу устаревшие инструкции по настройке окружения или запуску тестов.
Ответ 18+ 🔞
А, регулярно, да? Ну, это ж, блядь, святое. Без этого нихуя не работает. Вот, например, был у меня один проект, ёпта, с этим самым REST API. Открываю я их OpenAPI-спецификацию, а там, ядрёна вошь, как будто на дворе 2002-й год. Примеров ответов — ноль, про бизнес-логику полей — тишина, волнение ебать.
Ну я, естественно, не стесняюсь. Пишу: «Мужики, а какого хуя? Фронтендеры и мобильщики сейчас с ума посходят, когда начнут это интегрировать. Давайте-ка, ебушки-воробушки, конкретные примеры для всех этих ваших 400-х и 500-х ошибок напишем, и что каждое поле в ответе значит — объясним». Представляешь, помогло же, сука! Команды потом спасибо говорили, что без косяков всё пошло.
А ещё, чувак, я как найду в Confluence или в README.md инструкцию по настройке, которая уже лет пять как накрылась медным тазом, — сразу впендюриваю комментарий. Потому что иначе какой-нибудь новичок потратит полдня, а потом окажется, что скрипт запускается совсем по-другому. Чистая экономия нервов, да и доверия к документации — больше, чем ноль ебать.