Рассмотрены способы сокращения затрат и времени на разработку пользовательской документации к программному обеспечению и техническим системам. Их конкретную реализацию мы продемонстрируем на примере работы в программе Dr.Explain ( http://www.drexplain.ru ). В частности, освещены такие вопросы, как: - автоматизация документирования пользовательских интерфейсов; - использование и настройка визуальных шаблонов документа; - создание документации в различных форматах на основе одного источника; - автоматизация экспорта и публикации документов; - использование переменных; - управление проектом и совместная работа. Также презентация включает обзор основных возможностей и типовых сценариев применения программы Dr.Explain.

1. Быстрая разработка
пользовательской документации в
программе Dr.Explain
Журавлев Денис
Индиго Байт, г.Самара
26 марта, 2014 г

2. От лица и по поручению …
Разрабатываем программное обеспечение для
сопровождения IT-продуктов с 2004 года
Помогаем техническим писателям, инженерам,
разработчикам ПО, тренерам, специалистам тех.
поддержки
Боремся с рутиной, когнитивным диссонансом,
«насыщенными интерфейсами», неудобствами
Применяем автоматизацию, минимализм,
шаблонизацию, здравый смысл, специфическое
чувство юмора
Используемое средство: Dr.Explain
Знакомство

3. Средство массового удивления
Dr.Explain - программа для быстрого
создания пользовательской
документации
Тысячи пользователей по всеми миру создают
• Файлы помощи для программ и технических
систем
• Справочные online-системы
• Создание печатных руководств и инструкций
Фишки
• Автоматическое аннотирование
пользовательских интерфейсов
• Продуманный до клика минимализм
• «Все включено»
Знакомство

4. …, вредно не мечтать
Необходимо быстро разработать
пользовательскую документацию к
программному продукту в различных
форматах
Хочется
• Быстрый старт
• Минимум рутины и максимум автоматизации
• Различные форматы из одного проекта
• Без программирования
• Быстрое обновление и повторное
использование
• Чувство локтя
Знакомство

5. Быстрый старт
Простая установка
На старт!
Исполнение желаний
Внимание! Марш!
www.drexplain.ru

6. Быстрый старт
Русскоязычный интерфейс и документация
Исполнение желаний

7. Быстрый старт
Тестовый пример-проект
Исполнение желаний
• Доступен в стартовом диалоге
при запуске
• Это пользовательская
документация к реальному
приложению TBS Cover Editor
• Позволяет в пару кликов увидеть
конечный результат
• Содержит различные элементы
• Позволяет быстро понять
влияние настроек и параметров
на вывод

8. Быстрый старт
Продуманный до клика минимализм
Исполнение желаний
• Только нужные функции всегда под рукой
• Гибкие настройки «под капотом»
• Минимальное число кликов и «пробег» мышки
• Предварительный просмотр в один клик. Даже PDF!
• Горячие клавиши на частые операции

9. Быстрый старт
Импорт старой документации из различных форматов
Исполнение желаний
Импортируйте
• Старые файлы помощи
• Документы MS Word и RTF
• Отдельные текстовые файлы
• Каталоги с файлами
• Поддержка любых кодировок
• Автоматическое создание
оглавления проекта
• Максимально возможное
сохранение стилей форматирования

10. Быстрый старт
Лояльность бесплатного режима
Исполнение желаний
• Водяные знаки на всех
изображениях
• Работайте бесплатно без
ограничения по времени
• Нет ограничений на размер
проекта
• Полностью подготовьте
документацию к финальному
экспорту бесплатно
• После регистрации не требуется
переделывать всю работу заново

11. «Смерть рутине»или «Автоматизируй это»
Шаблон нового проекта
Исполнение желаний
Уже готовы и настроены
• Обложка
• Динамическое оглавление
• Заготовка первого раздела
• Оптимизированные
языковые настройки
• Автоматическое
именование файлов
• Оптимизированные
настройки экспорта проекта

12. «Смерть рутине»или «Автоматизируй это»
Автоматизированное документированние интерфейсов
Исполнение желаний
Распознает и аннотирует:
• Окна приложений
• Меню и подменю
• Веб-страницы
• Java-приложения (SWING)
• Flash-приложения (SWF)
При захвате скриншота программа анализирует структуру окна и автоматически создает
изображение с пояснительными выносками
Пример разбора окна: http://youtu.be/yHOWe2uQNx0 Пример разбора меню: http://youtu.be/H8HJjUqJbbE

13. «Смерть рутине»или «Автоматизируй это»
Текстовые переменные
Исполнение желаний
Быстрая вставка
повторяющихся фрагментов
текста
Одномоментное изменение
всех вхождений

14. «Смерть рутине»или «Автоматизируй это»
HTML код и специальные объекты редактора
Исполнение желаний
Используйте объект «HTML» для
• Добавления динамического
контента или JavaScript в online
руководства
• Встраивания сложных элементов
в текст раздела
• Вставки специфических тегов
• «Тонкой» настройки элементов и
их поведения

15. «Смерть рутине»или «Автоматизируй это»
Статусы разделов и визуализация степени готовности проекта
Исполнение желаний

16. «Смерть рутине»или «Автоматизируй это»
Автоматическая публикация online-руководств после экспорта
Исполнение желаний
Публикация на любом
сайте по FTP протоколу
Публикация на
облачной платформе
Tiwri.com

17. «Смерть рутине»или «Автоматизируй это»
…, а также
Исполнение желаний
Автоматическое построение поискового индекса
Режим командной строки для автоматизации
релизов и пакетной обработки
Проверка проекта на целостность, связанность,
полноту и наличие ошибок
Присвоение Help ID значений для создания
контекстно-зависимых файлов помощи
… и многое другое

18. Форматов много, он – один …
От файла помощи, до печатного руководства пользователя
Исполнение желаний
Создайте из одного проекта
• Online-руководство с
поиском и индивидуальным
дизайном
• Файл помощи для
приложения
• Печатное руководство в
формате PDF или RTF, с
обложкой, оглавлением и
полноценной поддержкой
русского языка

19. Вы не программист? И не надо!
Полнотекстовый поиск в online-руководствах
Исполнение желаний
• Автоматическое
построение поискового
индекса
• Подсветка результатов
• Не требуется установки
баз данных
• Не требуется настройки
скриптов
• Работает даже не
бесплатных хостингах

20. Вы не программист? И не надо!
Встройте документацию в корпоративный сайт
Исполнение желаний
• Возможность полностью
встроить документацию в
сайт
• Управление раскладкой
страницы
• Визуальный редактор
для «шапки», «подвала»,
«боковушек»
• Настройка разделов
HTML-документа
• Возможность вставки
любого кода в «шапку»,
«подвал», «боковушки»

21. Вы не программист? И не надо!
Настройте визуальные стили
Исполнение желаний
• Возможность вписать
документацию в стиль
• Коллекция готовых
цветовых схем
• Изменение цветовой
схемы в визуальном
редакторе
• «Тонкая настройка» с
помощью CSS

22. Повторное использование и обновление
Быстрая замена скриншотов
Исполнение желаний
Замена скриншотов в
анотированных
экранах с
сохранением всех
описаний
Минимальное время на
обновление
документации для новой
версии продукта

23. Повторное использование и обновление
Копирование и перенос разделов
Исполнение желаний
Возможность
копирования
поддерева разделов
и вставки в другой
документ
• Облегчает повторное
использование контента
• Работа над разными
частями документации с
дальнейшим
копированием в
финальный документ

24. Чувство локтя
Полноценная поддержка от разработчиков на всех этапах
Исполнение желаний
Отечественная компания, воспитанная
западным рынком
Русскоязычные обучающие материалы
Бесплатная поддержка на русском языке
Прямое общение с разработчиками
Сниженные цены в рублях
Оплата для юридических лиц с полным
пакетом бухгалтерских документов

25. Взгляд в будущее
Только радость впереди!
И напоследок…
Совместная работа над проектами
через платформу tiwri.com
Улучшение редактора
Больше автоматизации
Тонкий клиент, работа в браузере
Ведение документации на
нескольких языках

26. Есть вопросы? Пишите
Установите, запустите
и работайте!
www.drexplain.ru
Журавлев Денис
info@drexplain.com