close

Вход

Забыли?

вход по аккаунту

код для вставкиСкачать
1
Инструменты для подготовки
пользовательской документации
Куненко Екатерина
разработчик пользовательской документации
TFR, Гипéрбатон, Екатеринбург, 26 сентября 2014
2
Обо мне
в Яндексе — чуть больше 1 года
разработчик пользовательской
документации
пишу Помощь для
Яндекс.Почты, Яндекс.Диска и
других сервисов
3
О чем поговорим
Этапы работы с документацией в Яндексе
Инструменты разработки и локализации документации
Некоторые практики применения инструментов
4
Этапы
документирования
Процессы, задействованные в подготовке
документации
5
Процессы
Разработка
текст + иллюстрации
Локализация
Публикация
Хранение
6
Орудия производства
Инструменты разработки и локализации
документации в Яндексе
Орудия производства
7
8
Логическая разметка (DITA XML)
HTML
PDF
EPUB
…
9
Логическая разметка (DITA XML)
Внешний
вид
Контент
Документ
10
Логическая разметка (DITA XML)
Документ
Icons: Double-J Design
11
Syntext Serna
12
Иллюстрации
Схемы
Скриншоты
Живые картинки
13
Схемы
MS Visio – коммерческий продукт
Dia – кроссплатформенный бесплатный
редактор диаграмм
14
Скриншоты
Jing и Snagit
GIMP и Dia
15
Живые картинки
16
Живые картинки — как?
1. Разметка областей на скриншоте
17
Живые картинки — как?
2. Получение координат
» Handy Image Mapper
18
Живые картинки — как?
3. Связь координат и ссылок в коде XML
<imagemap>
<image href="image/stat-letter-overview.png"/>
<area>
<shape>rect</shape>
<coords>461,14,622,49</coords>
<xref href="stat-letter/prompt.xml"/>
</area>
</imagemap>
19
Как сделать хороший скриншот
подобрать правильные данные
поиск
данных
долго
тестовые
аккаунты
затратно
графический
редактор
неудобно
20
21
Отладчики HTML-страниц
в браузерах
инструменты
разработчика (F12)
средства
разработчика (F12)
плагин Firebug
22
Средства документирования
Пишем
• Формат DITA XML, редактор Syntext Serna
Схемы
• MS Visio / Dia
Скриншоты
• Jing и Snagit / GIMP и Dia
Живые
картинки
• Handy Image Mapper
Хороший
скриншот
• инструменты разработчика в браузерах
Yandex, MS IE
• плагин Firebug для Mozilla FF
23
Локализация
Локализационная разметка
исходных текстов
Формат XLIFF
CAT-система SwordFish
Конвертер DITA-XLIFF
24
Публикация
Что
– сборка документации
– сборка пакетов для выкладки на кластер
Где
– разработческие *nix-серверы документации
Чем
– Putty, WinSCP и др.
– командная строка
25
Хранение
26
Системы контроля версий
• Хранение нескольких версий
документа
• Возможность возвращаться
к предыдущим версиям
• Контроль изменений
27
SVN-клиенты
Subversion command-line и
TortoiseSVN
Command-line SVN
28
Хранение контента
Тип документации (репозиторий)
Ветки репозитория
– разработческая
– стабильная
Языковые каталоги внутри ветки
Документы
29
Структура документа
DITA-топики (тексты)
image – иллюстрации
work – рабочие материалы
30
Хранение
Надежность
Прозрачность
Удобство
31
Учет
Учет
32
Как работает?
Люди
Задачи
Документы
33
Сделали так
34
Практические советы
35
Наши находки
Живые картинки
Отладчики HTML-страниц в браузерах
Организация репозитория для хранения документации
Система учета документации в багтрекере
36
Спасибо за
внимание!
37
Куненко Екатерина
разработчик пользовательской
документации
Клуб техписателей clubs.ya.ru/x-plain
[email protected]
38
1/--страниц
Пожаловаться на содержимое документа