TGViewer
Shut up and write Shut up and write @shut_up_and_write · 640 subscribers
Post #205 1.06K
​​The F-word

Есть распространенный способ собирать фидбек у читателей — добавить в документацию вопрос “Помогла ли вам эта статья” или “Была ли полезна статья”. Задавая такой вопрос, сложно получить фидбек, который можно использовать, потому что информации не хватает.

В исследовании What Documentation Quality Means to Readers, кроме метрик “хорошести” документации, есть формула идеального фидбека. Фидбек должен быть содержательным и действенным (то есть его можно однозначно понять и применить).

Чтобы получить такой фидбек нужно задавать другие вопросы. Если следовать методологии Wang and Strong, то вопросы могут быть такие:
- Смогли ли вы найти информацию, которую искали?
- Была ли информация точной?
- Была ли информация легкой для понимания?
- Была ли информация релевантной?
Эти вопросы помогают измерить характеристики, которые читатели выбрали самыми важными в документации. Пример опроса из исследования.

Кроме самого исследования можно посмотреть видео или полистать презентацию выступления Yoel Strimling.
  • 👍 1
More from @shut_up_and_write
  1. Feb 4, 2022Как Twilio создают документацию Пересказ доклада Twilio про пределывание их документации.…
  2. Jan 21, 2022Docs for Developers Обзор на книгу Docs for Developers: An Engineer’s Field Guide to Techn…
  3. Jan 14, 2022Про редизайн документации GitLab - 2 GitLab проводит ежегодные опросы пользователей, чтобы…
  4. Jan 7, 20222021 → 2022 Краткое содержание 2021 и тренды на 2022. Что произошло за 2021 год - Gitlab,…
  5. Dec 24, 2021​​Какой длины делать обучающие видео? Компания TechSmith, которая делает Snagit и Camtasia…
  6. Dec 17, 2021The Best Developer Portals of 2021 Объявили победителей премии The Best Developer Portals.…
Threads Profile ViewerView any public Threads profile without an account.Open ThreadLook →Writing with AI? Make it sound human.Metric37 rewrites AI drafts so they read naturally. Free AI detector, 1,500 words free.Try Metric37 →