Марія Попова "Чому Ви найгірший ВА і Вас незабаром звільнять?"
Прийоми сторітелінгу в продуктовій документації - Леся Засядна
1. ПРИЙОМИ СТОРІТЕЛІНГУ В ПРОДУКТОВІЙ ДОКУМЕНТАЦІЇ:
ЯК УТРИМАТИ УВАГУ ЧИТАЧА ВІД ПЕРШОЇ ДО ОСТАННЬОЇ СТОРІНКИ
STAND-UP
IMAGE SOURCE:
UX COLLECTIVE
2. ПРО МЕНЕ
ЛЕСЯ ЗАСАДНА
Information Developer на ELEKS з 2011
Документатор-інтриган, любитель
цікавої подачі інформації
30+ успішних документаційних проектів
Співорганізатор ELEKS Lviv IDO Camp’18
Презентер на українських ІТ-подіях
та міжнародних конференціях
5. ПОРІВНЯЙТЕ ЦІ ДВІ СТАТТІ ПРО
ВИРІВНЮВАННЯ ТЕКСТУ:
ЯКА З НИХ ДОПОМОГЛА ВАМ КРАЩЕ
ЗАПАМ’ЯТАТИ ІНФОРМАЦІЮ?
6. Meet Your Type: FontShop Field Guide
http://smad.jmu.edu/shen/webtype/alignment.html
7. ЦІКАВА ПОДАЧА ІНФОРМАЦІЇ ВПЛИВАЄ
НА ЇЇ ЧИТАБЕЛЬНІСТЬ.
МОВА ЙДЕ НЕ ЛИШЕ ПРО ЛЕЙАУТ ТА ФОРМАТУВАННЯ,
А Й ПРО НЕЗВИЧНЕ ПОРІВНЯННЯ
(ЯК СИДЯТЬ ЛЮДИ В КІНОТЕАТРІ)
8. ЯК НАМ В ПРОДУКТОВІЙ ДОКУМЕНТАЦІЇ
ПОДАТИ ІНФОРМАЦІЮ ТАК, ЩОБ ВОНА БУЛА
НЕ ЛИШЕ КОРИСНА, А Й ЦІКАВА?
ЗРАЗУ СКАЖУ: МОВА НЕ ЙТИМЕ ПРО ВМІННЯ ПИСАТИ ГАРНО
9. eleks.com
The vast majority of writing advice
focuses on "writing well" as if it were
the same as telling a great story.
This is exactly where many aspiring writers fail—
they strive for beautiful metaphors,
authentic dialogue, and interesting characters,
losing sight of the one thing that every
engaging story must do:
ignite the brain's hardwired desire
to learn what happens next.”
- Lisa Cron, “Wired for Story”
10. eleks.com
Regardless of how beloved his books may be,
no one says author Dan Brown is a great writer.
Perhaps most succinct, and scathing, is fellow
author Philip Pullman’s assessment that
Brown’s prose is “flat, stunted and ugly,” and
that his books are full of “completely flat and two-
dimensional characters… talking in utterly
implausible ways to one another.
So why is The Da Vinci Code one of the best-selling
novels of all time? Because, from the very first
page, readers are dying to know what happens
next.
Learning to write a story is more important than
learning to write well: otherwise, you are risking
to create beautifully written “Who cares?”
- Lisa Cron, “Wired for Story”
11. eleks.com
ЦЕ ПРЕЗЕНТАЦІЯ БУДЕ ДЛЯ ВАС АКТУАЛЬНА,
ЯКЩО ВИ ПРАЦЮЄТЕ З БУДЬ-ЯКИМ ВИДОМ
ДОКУМЕНТАЦІЇ
ТЕХНІЧНА
software architecture doc,
deployment guide,
API guide,
...
ДЛЯ КОРИСТУВАЧІВ
user manual, help article,
blog post,
...
ПРОЦЕСНА/
ІНФОРМАЦІЙНА
Requirements spec,
proposal, status report,
...
13. ДЛЯ ПОЧАТКУ, ПОТРІБНО ПРЕДСТАВИТИ ПЕРСОНАЖА.
ВАЖЛИВО, ЩОБ ЧИТАЧІ РОЗУМІЛИ З ПЕРШОЇ
СТОРІНКИ, ДЛЯ КОГО САМЕ ЦЕЙ ДОКУМЕНТ,
А ТАКОЖ НАГАДУВАТИ ПРО ЦЕ В КОЖНОМУ РОЗДІЛІ
17. 1. Executive Summary
Customer has requested that we, as an independent
information security and compliance partner, provide this
proposal in reference to an initiative driven by the Customer’s
commitment to security and the need to protect its critical
information and systems.
We identified weaknesses in systems that leave them
susceptible to an external or internal threat. We use
sophisticated manual processes as well as automated tools to
evaluate the systems from the perspective of authenticated
users; these processes identify security vulnerabilities including
logic flaws (business logic). Verified findings and actionable
recommendations are provided to assist Customer in reducing
the risk to critical systems.
These proposed consulting services will identify potential risks
or gaps in security or compliance that exist in the relevant
scope and will enable us to recommend the security and
industry best practice approach for the Customer to mitigate
the risks based on the findings.
This proposal, based on consideration of the scope and metrics
discussed, describes Company’s specific service and overall
engagement methodologies...
КЛІЄНТ,
КЛІЄНТИ КЛІЄНТА,
СИСТЕМИ КЛІЄНТА
ПОВИННІ НЕ ПРОСТО
ЗГАДУВАТИСЬ, А БУТИ ДІЙОВИМИ
ОСОБАМИ
(ПІДМЕТАМИ В РЕЧЕННЯХ)
ДІЙОВА ОСОБА = ЧИТАЧ (КЛІЄНТ)
ДІЙОВА ОСОБА = АВТОР
(КОМПАНІЯ, ЯКА НАДАЄ ПОСЛУГИ)
19. eleks.com
Renowned curator Jacques Sauniere staggered
through the vaulted archway of the museum’s Grand
Gallery.
He lunged for the nearest painting he could see, a
Caravaggio.
As he had anticipated, a thundering iron gate fell
nearby, barricading the entrance to the suite. The
parquet floor shook. Far off, an alarm began to ring...
A voice spoke, chillingly close. “Do not move.”
чия це
історія
про що
історія
20. eleks.com
Renowned curator Jacques Sauniere staggered
through the vaulted archway of the museum’s Grand
Gallery.
He lunged for the nearest painting he could see, a
Caravaggio.
As he had anticipated, a thundering iron gate fell
nearby, barricading the entrance to the suite. The
parquet floor shook. Far off, an alarm began to ring...
A voice spoke, chillingly close. “Do not move.”
... The attacker aimed his gun again. “When you are
gone, I will be the only one who knows the truth.”
The truth . In an instant, the curator grasped the true
horror of the situation.
If I die, the truth will be lost forever . Instinctively, he
tried to scramble for cover.
https://davincicode.bib.bz/prologue
в чому
інтрига
чия це
історія
про що
історія
25. eleks.com
ПРИКЛАД З DROPBOX USER GUIDE,
КОЛИ ПОТРЕБАМ І ЦІЛЯМ КОРИСТУВАЧА
ПРИСВЯЧЕНА МАКСИМАЛЬНА КІЛЬКІСТЬ УВАГИ.
ТАКИЙ ПОЧАТОК СТАТТІ МОТИВУЄ
(ВИКЛИКАЄ ЦІКАВІСТЬ ДО ТОГО, ЩО БУДЕ ДАЛІ –
ЯК САМЕ ДОСЯГТИ ЦІЛЕЙ І ЯКІ ТРУДНОЩІ МОЖУТЬ
ВИНИКНУТИ В ПРОЦЕСІ)
27. eleks.com
Хто головний герой?
Якщо героїв декілька,
чи представлені
вони усі?
Якщо ми не окреслимо
роль (персону), читач
не зможе побудувати
емпатію з нашим
документом.
Чи зав’язуються події
на першій сторінці
документу/в першому
абзаці розділу?
Не обмежуйтесь
вступним описом
(the purpose of this
document is to…).
Щось повинно
відбуватись вже, щоб
читачу було цікаво, що
буде далі або як будуть
розвиватись події.
Що “на кону” (в чому
полягає конфлікт)?
Читач повинен вже на
цей момент зрозуміти
загальну картину
(до чого в результаті
зводиться вся історія).
В документації для
користувачів, це може
бути кінцева вигода
з проілюстрованим
результатом.
ПІДСУМОК
28. eleks.com
ЯК ЗРОЗУМІТИ, ЧИ ВДАЛОСЬ
ВСТАНОВИТИ РЕЛЕВАНТНІСТЬ?
ЧИТАЧІ ПРОВОДЯТЬ БІЛЬШЕ ЧАСУ НА СТОРІНЦІ.
ЯКЩО НІЧОГО НЕ ЗМІНИЛОСЬ,
ПЕРЕВІРТЕ, ЧИ ПРАВИЛЬНО ПОБУДОВАНА
НАВІГАЦІЯ ДО СТОРІНКИ.
29. КІНЦЕВА МЕТА, ДО ЯКОЇ ВСЕ ВЕДЕ
леймотив || “so what?” factor || позбуваємось зайвого
30. eleks.com
ТЕ, ЩО “НА КОНУ”, ВИЗНАЧАЄ
ЛЕЙМОТИВ (ТЕМУ, РИТМ)
ДОКУМЕНТУ/СТОРІНКИ
ЯКИЙ ЛЕЙМОТИВ ЦИХ ІСТОРІЙ?
42. eleks.com
Evaluate every bit of information
using the “so what” factor: filter out
unnecessary and distracting information.
Instead of mentioning all that happens,
cherry-pick the events that are relevant
to the story.
Those are the events that help the person
achieve the goal(s).
- Lisa Cron, “Wired for Story”
45. eleks.com
Чи проміжні цілі
ведуть до досягнення
кінцевої цілі?
Перед кожним “як”
(напр., завантажити
документи у сховище)
повинні бути “чому”
і “навіщо” (напр.,
уникнути хаосу в
документах і швидко
знаходити потрібну
інфу), які в результаті
ведуть до кінцевої цілі.
Чи розуміємо ми
кінцеву ціль героя?
Кінцева ціль завжди
внутрішня і пов’язана
з трансформацією
(подолати страх,
лінь, досягти мрії).
Вона повинна бути
сформульована на
рівні продукту
(наприклад, вийти на
новий рівень бізнесу).
Чи вся інформація,
яку ми надаємо,
веде до досягнення
проміжних цілей?
Якщо читач не розуміє
впродовж 35 секунд,
до чого веде
“розмова”, читач
зазвичай покидає
документ.
Уникайте plain text,
розбивайте
розділи/статті
на чіткі секції.
ПІДСУМОК
46. eleks.com
ЯК ЗРОЗУМІТИ, ЧИ ВДАЛОСЬ СФОКУСУВАТИСЬ
ЛИШЕ НА НЕОБХІДНІЙ ІНФОРМАЦІЇ?
ЧИТАЧІ ВИЯВЛЯЮТЬ ЕМОЦІЇ ПІСЛЯ ПРОЧИТАНОГО:
ВОНИ ОТРИМАЛИ НЕ ЛИШЕ ЗНАННЯ, А Й НАТХНЕННЯ.
47. eleks.com
ЩЕ ОДИН ПРИКЛАД З DROPBOX USER GUIDE,
ЯКИЙ МАЄ ДУЖЕ ХОРОШУ СТРУКТУРУ
(THE WHY > THE HOW > THE WHAT IF)
51. We are cool and know
how to do create cool docs.
We think you need some.
The page will merge the content
from the 3 existing pages.
As a result, you get
1 go-to page will all info.
Users will be happy.
Company is looking to increase user
happiness. Self-help content can
help with this.
WHAT’s AT STAKE
Users get lost among 3 pages.
Eventually, if users can’t do sth easily,
there’s a chance they won’t do it at all.
SO WHAT
Having 1 new page will solve this, as
well as....
HOW DO WE GO ABOUT IT
Steps 1 happy - 2 happy - 3 happy.
DOCUMENTATION VISION FOR PROPOSAL:
“BEFORE” VERSION
DOCUMENTATION VISION FOR PROPOSAL:
“AFTER” VERSION
Based on analysis, we suggest
creating a new page.
Based on analysis, we suggest
creating a new page.
We’ll implement this using
Steps 1 - 2 - 3.
52. ВСЕ, ЩО МОЖЕ ПІТИ НЕ ТАК,
ПОВИННО ПІТИ НЕ ТАК
причини уникання конкретики || коли деталі вислизають
53. eleks.com
КОРИСТЬ ІСТОРІЇ САМЕ В ТОМУ,
ЩО ВОНИ ВЧАТЬ НАС, ЯК ДІЯТИ/НЕ ДІЯТИ
В КОНКРЕТНИХ СИТУАЦІЯХ
ЯКЩО ЗАБРАТИ З GAME OF THRONES
НЕОСНОВНІ СЦЕНАРІЇ,
МИ ВТРАТИМО БАГАТО ІНФОРМАЦІЇ
І МАЛО ЧОГО НАВЧИМОСЯ
59. eleks.com
Чи охопили ми всі
можливі варіанти?
Наприклад, коли питаємо себе,
в якому місці це відбувається,
ми продумуємо, де знаходиться
програма (на якому пристрої),
де знаходиться користувач
(вдома, в офісі, і т.д.).
Це викликає питання, які там
умови...
Чи в кожний момент
читач розуміє...
Що відбувається
Хто є героєм (виконавцем дії)
В який час це відбувається
(хронологія подій)
В якому місці це відбувається
Які були передумови?
ПІДСУМОК
60. eleks.com
ЯК ЗРОЗУМІТИ, ЧИ МИ ПЕРЕДБАЧИЛИ ВСЕ,
ЩО МОГЛО ПІТИ НЕ ТАК?
ЧИТАЧІ ПІДТВЕРДЖУЮТЬ,
ЩО ДОКУМЕНТ/СТАТТЯ БУЛИ КОРИСНИМИ.
62. “What’s great about story and its underlying
structure is that it provides you with a framework—
a formula, if you will—
for turning your customers into heroes.
Plot points, high points, and all.”
– DONNA LICHAW, THE USER’S JOURNEY
65. МИ ЧАСТО УПУСКАЄМО ПРОМІЖНІ ЕТАПИ ВИРІШЕННЯ ПРОБЛЕМИ
(НАРОСТАННЯ ІНТРИГИ),
А ПІСЛЯ ВИРІШЕННЯ ПРОБЛЕМИ РАПТОВО НАСТАЄ
“HAPPY EVER AFTER”
66. КІНЦЕВИЙ РЕЗУЛЬТАТ ВАЖЛИВИЙ, І ПОТРІБНО ПОВІДОМИТИ ЙОГО
ЯКОМОГА ШВИДШЕ,
АЛЕ ПРИ ЗАСВОЄННІ ІНФОРМАЦІЇ,
ПРОЦЕС НЕ МЕНШ ВАЖЛИВИЙ, НІЖ РЕЗУЛЬТАТ
67. THERE IS A PROBLEM, AND A NEW
APPROACH WAS CHOSEN TO FIX IT
68. THERE IS A PROBLEM, AND A NEW
APPROACH WAS CHOSEN TO FIX IT
IT WASN’T EASY—MANY DIFFERENT
CONSIDERATIONS CAME TO LIGHT
69. THERE IS A PROBLEM, AND A NEW
APPROACH WAS CHOSEN TO FIX IT
IT WASN’T EASY—MANY DIFFERENT
CONSIDERATIONS CAME TO LIGHT
FIRST OF ALL, THE CURRENT
APPROACH CASES A HICCUP HERE
AND HERE.
NEW APPROACH WOULD FIX THAT
70. THERE IS A PROBLEM, AND A NEW
APPROACH WAS CHOSEN TO FIX IT
IT WASN’T EASY—MANY DIFFERENT
CONSIDERATIONS CAME TO LIGHT
FIRST OF ALL, THE CURRENT
APPROACH CASES A HICCUP HERE
AND HERE.
NEW APPROACH WOULD FIX THAT
BESIDES, NEW APPROACH WOULD
IMPROVE THIS, AND THIS, AND EVEN
THIS
71. THERE IS A PROBLEM, AND A NEW
APPROACH WAS CHOSEN TO FIX IT
IT WASN’T EASY—MANY DIFFERENT
CONSIDERATIONS CAME TO LIGHT
FIRST OF ALL, THE CURRENT
APPROACH CASES A HICCUP HERE
AND HERE.
NEW APPROACH WOULD FIX THAT
BESIDES, NEW APPROACH WOULD
IMPROVE THIS, AND THIS, AND EVEN
THIS
NOW, WE CANNOT USE NEW APPROACH
ALL OVER EITHER.
IT’S NOT LIKE THE CURRENT APPROACH
IS TOTALLY USELESS. THESE ARE
SPECIFIC CASES WHERE IT OPTIMIZES
THINGS
72. THERE IS A PROBLEM, AND A NEW
APPROACH WAS CHOSEN TO FIX IT
IT WASN’T EASY—MANY DIFFERENT
CONSIDERATIONS CAME TO LIGHT
FIRST OF ALL, THE CURRENT
APPROACH CASES A HICCUP HERE
AND HERE.
NEW APPROACH WOULD FIX THAT
BESIDES, NEW APPROACH WOULD
IMPROVE THIS, AND THIS, AND EVEN
THIS
NOW, WE CANNOT USE NEW APPROACH
ALL OVER EITHER.
IT’S NOT LIKE THE CURRENT APPROACH
IS TOTALLY USELESS. THESE ARE
SPECIFIC CASES WHERE IT OPTIMIZES
THINGS
YOU KNOW WHAT, LET’S LEAVE THE
CURRENT APPROACH HERE AND HERE.
AND USE THE NEW APPROACH IN
CASES WE MENTIONED BEFORE.
THAT SHOULD GIVE A PRETTY PERFECT
SOLUTION. YAY.
74. ЯК РЕЗУЛЬТАТ, МИ МАЄМО КОНТЕКСТ:
ЯКА ПОТОЧНА СИТУАЦІЯ І ЩО В НІЙ НЕ ТАК
ЯК ДІЯТИ, ЩОБ ЇЇ ВИРІШИТИ,
ЧОМУ МИ ДІЄМО САМЕ ТАК, А НЕ ІНАКШЕ,
ЯКІ ЩЕ БУЛИ ВАРІАНТИ ПОДІЙ І ЧОМУ ВОНИ НАМ
НЕ ПІДХОДЯТЬ.
ТЕКСТ В КОНТЕКСТІ ЗАПАМ’ЯТОВУЄТЬСЯ НАБАГАТО КРАЩЕ
77. ПРИГАДАТИ
ІСТОРІЮ, ЯКА НА
ВАС ВПЛИНУЛА
(НАВЧИЛА ВАС
ЧОГОСЬ)
ВИОКРЕМИТИ
КЛЮЧОВІ
ПРИЙОМИ
(ЯК ЦЕ ВДАЛОСЬ
АВТОРУ?)
ВИКОРИСТАТИ
ЇХ У ВАШОМУ
ПОТОЧНОМУ/
НАСТУПНОМУ
ДОКУМЕНТІ
1 2 3
НАДІСЛАТИ НА
LESIA.ZASADNA
@YAHOO.COM
ТА ОТРИМАТИ
ФІДБЕК
4