Использование Dr. Explain для разработки программной документации

Разработка программной документации – длительный процесс, требующий особой внимательности. Технические писатели и разработчики ищут способы упростить данный процесс при помощи специальных инструментов. Один из таких инструментов – отечественная программа, вышедшая на международный уровень, Dr. Explain. В чем же особенность данного продукта?

Идея создания Dr. Explain появилась в 2004 году, а к 2005 году вышла первая англоязычная версия продукта. Денис Журавлев (разработчик продукта) ставил перед собой цель – разработать инструмент для быстрого документирования. Dr. Explain позволяет создавать встроенную в программу справочную систему, настраивать ее визуальный стиль. Инструмент адаптирован под специфику отечественного рынка и имеет русскоязычный интерфейс. При создании Dr. Explain учтены требования государственных стандартов и подходы к разработке российского ПО.

Dr. Explain отличает ряд преимуществ:

• легкий и продуманный интерфейс;

• автоматическая поддержка требований ГОСТ 19 и ГОСТ 34;

• возможность редактирования аннотаций для пояснительных выносок на снимках экрана;

• поддержка механизмов Help ID;

• возможность выбора формата выходных данных (pdf, html, chm или rtf);

• одновременная работа нескольких пользователей;

• возможность добавления видеороликов;

• готовые шаблоны руководств;

• специальные рублевые цены;

• адаптивность web-форматов под мобильные устройства.
  

Рассмотрим возможности бесплатной версии. При запуске программы перед нами открывается следующее окно.

На странице предлагается создать новый проект, открыть уже существующий, импортировать внешние файлы (документ из Microsoft Word, RTF-документ, CHM-документ, HLP-документ, одиночный HTML-документ и папку с документами в форматах html, txt, xml) или открыть недавние проекты. На верхней панели через «Настройки» можно также выбрать язык интерфейса.

При создании нового проекта необходимо выбрать определенный путь:

• создать локальный проект;

• создать или забрать общий проект на сервере;

• создать локальный проект с использованием шаблона (руководство пользователя по ГОСТ 34);

• создать общий проект на сервере с использованием шаблона (руководство пользователя по ГОСТ 34).

Страница создания локального проекта выглядит следующим образом.

Данную страницу можно поделить на две области – область навигации и редактор страниц. В верхнем левом углу представлена структура будущего документа, которую можно изменять при необходимости. В левом нижнем углу – описаны свойства выбранного раздела и ключевые слова. Текстовый редактор расположен в правой части. В нем можно выбрать необходимый шрифт (размер, начертание), вставить в документ видео, картинку, ссылку, таблицу и др. На странице есть возможность предпросмотра документа в HTML, CHM и PDF.

Такие же инструменты доступны на странице создания локального проекта с использованием шаблона. Структура шаблона соответствует ГОСТ 34. В шаблонах содержатся подсказки и примеры для заполнения разделов документа, что значительно упрощает процесс разработки.

Программа имеет ряд недостатков:

• отсутствие режима рецензирования (возможности внесения замечаний);

• отсутствие поддержки WinHelp;

• ограниченный функционал проверки правописания.

Dr. Explain – отличный инструмент для технического писателя в России. Программа учитывает специфику разработки пользовательской документации и help-справок, характерные для отечественного рынка. Встроенные шаблоны согласованы с требованиями ГОСТ 19 и 34. Dr. Explain позволяет создавать справку с использованием пояснений к скриншотам. Программа улучшает внешний вид документации и экономит время разработки.