а какие новости по адвансед курсам? может они переедут в онлайн?

переедут обязательно, пока планируем, что поздней весной

@factorized крутая идея сменить аватарку на время отпуска) Надо тоже так делать)

можно еще через приложение) https://calmframe.com/

Ого, какие технологии)) Круто, спасибо)

Да-да, я у кого-то подсмотрел, тоже впечатлился

Есть довольно глупый вопрос, который я сам толком не могу сформулировать

Может кто сталкивался или плюс минус понимает
Потому что я не понимаю

По идее, в мои обязанности как техписа входит документирования api

Но его же (api) по факту пишет разраб, и потом документирует он же, я только помогаю читабельно сделать

Может, я какие то процессы документирования неправильно в команде выстраиваю?

апи документация это не только референс, но и гайды. вы можете помогать править референс и самостоятельно писать гайды

Привет. Вы можете обсудить, как вы пишете комментарии, если справочник собирается автоматом.

Плюс обычно есть какой-то текст с примерами, поясняющий работу с конкретными функциями.

Например, isItemEnabled bool -- флаг проверки состояния элемента терпимо для комментария, но не очень дня документации.

Надо разворачивать более информативно?

Да хорошо бы, чтобы пример был рабочий какой-то.

Имеет смысл рассматривать три типа статей рядом со справочником API

- Introduction: обзорный текст о том, что это вообще за API, какие бизнес-задачи оно поможет решить клиенту.

- Tutorials, пошаговые инструкции, приводящие к какому-то конечному и проверяемому результату, например «вот как с помощью нашего API сделать простенькое навигационное приложение». Ориентированы на тех, кто только начинает знакомиться с API.

- Howtos, чаще всего короткие рецепты использования API, «вот что умеет наше API». Ориентированы на тех, кто уже знаком с API и пользуется им.

ну и почитайте хрестоматийную брошюру про ключевые типы документации для разработчиков, https://documentation.divio.com/

Благодарю!

Очень полезно, спасибо! Тоже сохранила себе

я к этому добавлял ещё расширенные обзорные статьи более высокого уровня "How It Works", в которых объяснялись некоторые понятия, которые используются в API и которые, на мой взгляд, требуют дополнительного объяснения с точки зрения того, что это вообще такое, как оно работает в общем и как в рамках нашего API.

Да, объяснение домена,  предметной области

Не могу не поделиться.
Эх, если бы у нас не боялись делать такую документацию..