Макропеременные
Разработчики документации часто сталкиваются с проблемой многократного использования одного и того же фрагмента текста. В таких случаях они часто прибегают к очевидным решениям — "Ctrl+C", Ctrl+V" или каждый раз вводят заново необходимую информацию.
Для того чтобы избежать "рутины" в процессе написания документации, в Dr.Explain есть функция, которая значительно повысит вашу производительность — это текстовые макропеременные. Они полезны, если вы часто используете одни и те же фрагменты текста в своем руководстве, такие как название компании, название продукта, контактные данные и так далее. Переменные особенно полезны, когда нужно много раз писать один и тот же текст, который периодически изменяется — например, версия документируемой программы.
Как работают макропеременные в Dr.Explain?
Допустим, вам нужно в руководстве множество раз написать версию программы или адрес электронной почты. Вместо того, чтобы каждый раз их писать — задайте переменную. В следующий раз не придется набирать текст от руки, нужно будет только выбрать переменную с подходящим значением.
Если вам нужно изменить номер версии или контактный адрес электронной почты во всем проекте — обновите значение переменной в настройках проекта. Dr.Explain автоматически внесет изменения на все страницы, содержащие эту переменную в тексте.
Для того чтобы добавить переменные в ваш проект нажмите иконку на панели инструментов или откройте раздел "Переменные" в настройках проекта. Далее задайте имя для переменной, а затем ее значение.
Таким образом, когда вы будете работать над проектом, в редакторе у вас будут видны имена переменных, а в финальном экспорте будут подставлены их актуальные значения.
Примеры пользовательских документаций, созданных в Dr.Explain
На этой странице приведены ссылки на реальные пользовательские документации, разработанные в Dr.Explain. Ниже представлена подборка скриншотов с некоторыми примерами, которые демонстрируют возможности программы.
Какие преимущества вы получите с Dr.Explain?
- Если нужно обновить версию продукта во всех разделах — достаточно изменить значение переменной один раз. Не нужно искать по всему тексту и править каждое упоминание вручную.
- Если над документацией работает несколько авторов — использование переменных гарантируют, что все применяют одинаковые названия, контакты и версии. Разночтения исключены.
- Если вы готовите документацию для разных клиентов или версий продукта — комбинируйте переменные с условным выводом, чтобы показывать разный контент разным аудиториям.
- Меньше рутины — больше творчества. Освободите время от механической работы и сосредоточьтесь на качестве контента.
Для кого подходит Dr.Explain?
Dr.Explain подходит как крупным, так и небольшим организациям, как новичкам, так и специалистам с большим опытом. Простота и удобство инструментов не требуют длительного изучения, а набор шаблонов позволяет существенно сократить время на создание качественных справочных систем.
- Если вы регулярно обновляете контактные данные, версии продукта или названия — переменные избавят от необходимости править одно и то же в каждом разделе.
- Если над документом работает несколько авторов — единые переменные обеспечат синхронность и исключат ошибки.
- Если вы выпускаете разные версии документации для разных клиентов — переменные в сочетании с условным выводом позволят персонализировать контент без дублирования проектов.
Пользователи о работе с макропеременными в Dr.Explain
"Нам очень нравятся переменные в Dr.Explain, поскольку они позволяют нам версионировать документацию в одном проекте. Пользователи могут легко увидеть, что перед ними последняя версия документа".
Дэвид Суиндон, ИТ-директор Trustco Group Holdings
Интервью с Дэвидом
"Поскольку Dr.Explain специально разработан для работы с документацией, он значительно упростил весь процесс. Например, поиск, индексация, гиперссылки и т.д."
Майк Маклафлин, единственный разработчик Champion Software
Интервью с Майком
Часто задаваемые вопросы
Можно ли использовать переменные в таблицах, подписях к изображениям и других элементах?
Можно. Переменные работают в любом текстовом поле — в обычном тексте, таблицах, подписях к изображениям, в названиях разделов и т.д.
Работают ли переменные при экспорте во все форматы (PDF, CHM, HTML)?
Да. При экспорте в любой формат (PDF, DOCX, CHM, HTML) переменные заменяются на их актуальные значения. В готовом документе пользователь видит конечный текст, а не имена переменных.
Видит ли пользователь в готовой документации, что использовались переменные?
Нет. В экспортированном документе (PDF, CHM, HTML) пользователь видит только конечные значения. Сами переменные остаются внутри проекта и не видны в финальной версии.
Есть ли у вас страница со списком ваших клиентов?
Со списком наших клиентов вы можете ознакомиться на этой странице.
Есть шаблоны, выполненные в соответствии с ГОСТ?
Есть шаблоны документаций, разработанные по стандартам ГОСТ 19 и ГОСТ 34.
Есть возможность связаться с вашей службой поддержки по некоторым вопросам?
Есть.
Есть ли видео-уроки для работы с вашей программой?
Есть. Наш профиль на Youtube.