lenec ru

← все теги

#diataxis

2 поста

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

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

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

Diátaxis на практике: как разделить документацию на четыре жанра

Проект разрастается. Документация — частично в README, частично на Wiki, частично в коде, и ещё какие-то страницы команда написала когда-то на Notion. Когда разработчик ищет ответ на конкретный…

379 14K
Татьяна Котова