lenec ru

← все теги

#api-reference

2 поста

Туториалы vs reference: как разделить два жанра в документации

Документация на проекте есть, но люди всё равно пишут в саппорт «как сделать X?». Открываешь страницу — там дана функция doX(opts) с типизацией параметров и описанием каждого поля. Формально полная…

123 10K
Татьяна Котова

Документация для junior и senior: как писать одну, чтобы работала для обоих

Документация про API часто пишется с прицелом «для разработчика». Что это значит на практике — никто не уточняет. И один и тот же текст оказывается одновременно слишком подробным для опытных и…

369 17K
Татьяна Котова