Embed Size (px)
DESCRIPTION
Довольно часто пользовательская документация содержит подробное описание интерфейса и функций продукта, но не отвечает на реальные вопросы пользователей. Елена расскажет, как можно решить эту проблему, а также как адаптировать текст к переводу на другие языки.
Citation preview
1
2 Гипербатон, Москва, 24 мая 2014 года
Особенности создания
документации
для пользователей
Елена Слободчикова
разработчик пользовательской документации Яндекса
Елена разработчик пользовательской
документации TFR, Гипéрбатон, Екатеринбург, 26 сентября 2014
3
Яндекс Екатеринбург
4
Ответить пользователю
5
Справка = вопросы + ответы
Служба поддержки
Яндекс.Метрика
Голова менеджера
Своя голова
6
Справка = вопросы + ответы
Короткие ответы
Пошаговые инструкции
«Быстрый старт»
7
8
Как делать хорошо
9
Единый стиль
1 сервис = 1 ответственный техписатель
Руководства по стилю и оформлению
Шаблоны
10
Наши принципы
Коротко и ясно
Разъясняем неочевидное
Вопросы от пользователей
Вначале – что и зачем, потом – как
Структура, удобная для пользователя
11
Было
12
Стало
13
Стало
14
Другой пример
15 Найди кота
16
Стартовая страница
17
Тема – отдельная страница
18
Мини-оглавления
19
Полезные ссылки
20
Двойные заголовки
21
Адаптивная верстка
22
Как помочь найти?
Стартовая страница
Тема – отдельная страница
Мини-оглавления
Полезные ссылки
Двойные заголовки
Ключевые слова
Адаптивная верстка
23
Стань своим
24
В чем разница?
Географические названия
Валюта
Разная функциональность
Отдельные домены
25
Домен ≠ язык
help.yandex.ru
help.yandex.ua
help.yandex.com
help.yandex.com.tr
Русский
Українська
English
Türkçe
26
Пример
help.yandex.ru
Минимальная сумма заказа в Яндекс.Директе
составляет 81 грн.
Мінімальна сума замовлення в Яндекс.Директі
становить 81 грн.
help.yandex.ua
Минимальная сумма заказа в Яндекс.Директе
составляет 300 рублей.
27
Как не запутаться?
<p>Минимальная сумма заказа в
Яндекс.Директе составляет
<ph locale="ru">300 рублей</ph>
<ph locale=“uk-ua ru-ua">81 грн</ph>.
</p>
28
Наши рецепты
Вопросы + ответы
Коротко и ясно
Структура
Стань своим
29
Результат
30
Елена Слободчикова
разработчик пользовательской документации компании «Яндекс»
Клуб технических писателей
clubs.ya.ru/x-plain
Электронная почта
