Макропеременные

Разработчики документации часто сталкиваются с проблемой многократного использования одного и того же фрагмента текста. В таких случаях они часто прибегают к очевидным решениям — "Ctrl+C", Ctrl+V" или каждый раз вводят заново необходимую информацию.

Для того чтобы избежать "рутины" в процессе написания документации, в Dr.Explain есть функция, которая значительно повысит вашу производительность — это текстовые макропеременные. Они полезны, если вы часто используете одни и те же фрагменты текста в своем руководстве, такие как название компании, название продукта, контактные данные и так далее. Переменные особенно полезны, когда нужно много раз писать один и тот же текст, который периодически изменяется — например, версия документируемой программы.

Как работают макропеременные в Dr.Explain?

Допустим, вам нужно в руководстве множество раз написать версию программы или адрес электронной почты. Вместо того, чтобы каждый раз их писать — задайте переменную. В следующий раз не придется набирать текст от руки, нужно будет только выбрать переменную с подходящим значением.

Если вам нужно изменить номер версии или контактный адрес электронной почты во всем проекте — обновите значение переменной в настройках проекта. Dr.Explain автоматически внесет изменения на все страницы, содержащие эту переменную в тексте.

Для того чтобы добавить переменные в ваш проект нажмите иконку в разделе "специальные объекты" или откройте раздел "Переменные" в настройках проекта. Далее задайте имя для переменной, а затем ее значение.

Таким образом, когда вы будете работать над проектом, в редакторе у вас будут видны имена переменных, а в финальном экспорте будут подставлены их актуальные значения.

Примеры пользовательских документаций, созданных в Dr.Explain

На этой странице приведены ссылки на реальные пользовательские документации, разработанные в Dr.Explain. Ниже представлена подборка скриншотов с некоторыми примерами, которые демонстрируют возможности программы.

Какие преимущества вы получите с Dr.Explain?

Dr.Explain избавит от ручной работы, например, он эффективен, если в документации очень много повторяющегося текста. С макропеременными вам не придется заниматься дублированием контента вручную.

Удобство поддержки актуальности данных. Использование макропеременных облегчает поддержку актуальности информации. О том, чем грозит устаревание контента в пользовательской документации, мы писали в этом материале.

Меньше рутинных задач — больше креативной работы. Макропеременные избавляют от рутины, такой как редактирование одинаковых данных в разных местах документации. Не нужно тратить время на написание однотипной информации — сконцентрируйтесь на улучшении контента.

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

Для кого подходит Dr.Explain?

Dr.Explain подходит как крупным, так и небольшим организациям, как новичкам, так и специалистам с большим опытом. Простота и удобство инструментов не требуют длительного изучения, а набор шаблонов позволяет существенно сократить время на создание качественных справочных систем. Dr.Explain — верный выбор, если требуется:

нужно регулярно обновлять данные: контактную информацию, версию программного продукта или целые блоки текста;
организовать работу над одним документом нескольких авторов;
нужна гибкая ценовая политика для приобретения программы;
нужно приложение для настольного ПК;
нужна проверка орфографии на нескольких языках;
нужна возможность изменять дизайн документа.

Часто задаваемые вопросы

Есть ли у вас страница со списком ваших клиентов?

Со списком наших клиентов вы можете ознакомиться на этой странице.

Кто разработчик программы? Иностранная студия?

Нет. Dr.Explain создан в России и входит в единый реестр российских программ.

Есть шаблоны, выполненные в соответствии с ГОСТ?

Есть шаблоны документаций, разработанные по стандартам ГОСТ 19 и ГОСТ 34.

Есть возможность связаться с вашей службой поддержки по некоторым вопросам?

Есть.

Есть ли видео-уроки для работы с вашей программой?