Разработка технической документации и технические писатели Технические писатели и разработка технической документации

 obmen_soobsheniyami.png Чат для технических писателей 
 Зарегистрируйтесь
Страницы: 1
RSS
Переиспользование текста
 
Здравствуйте!
Начальство поставило перед нами следующую задачу. Мы пишем руководства пользователя для трех подсистем, у каждой уникальный дизайн, но практически одинаковый функционал. Возможно ли на базе ПО dr.explain организовать работу таким образом, чтобы не приходилось править один и тот же текст в трех проектах? Например во Flare это реализовано при помощи инструмента условные теги (conditional tags), есть ли в dr.explain что-то подобное? Или, возможно, есть другие способы решить поставленную задачу с использованием вашего ПО?
Заранее спасибо!
 
Здравствуйте!

К сожалению, на данный момент требуемый функционал (conditional section) в программе отсутствует.

Можно попробовать применить следующий подход: все разделы под все подсистемы пишутся в одном и том же проекте. Когда нужно создать файл с документацией (например, PDF) для первой подсистемы, все разделы, не относящиеся к этой подсистеме, маркируются как неэкспортируемые (правой кнопкой по разделу, далее выбрать "Показать/скрыть" из выпадающего меню). Разделы, относящиеся только к одной подсистеме, можно помечать цветом, выставляя им статус - "в процессе", "закончено" или "ожидается" - это дает желтый, зеленый и красный цвета фона.
Если нужно скрыть раздел вместе со всеми подразделами, достаточно применить операцию "Скрыть" к этому разделу, все подразделы будут исключены из экспорта автоматически.

Чтобы не менять вручную уникальные для каждой подсистемы настройки (например, колонтитулы, строки и переменные), можно поступить следующим образом: для каждой подсистемы создать отдельные проекты, у которых выставить нужные настройки (меню Настройки->Настройки проекта), и сохранить их под различными именами (например, подсистема1.gui). Разделов в этих проектах может и не быть, будут использоваться только их настройки. Далее, в основном проекте, перед экспортом справки, нужно зайти в меню Настройки и выбрать пункт Импорт настроек. Далее в открывшемся диалоге нужно указать путь к проекту, из которого будут импортироваться настройки (например, подсистема1.gui) и нажать кнопку Импорт.

Мы планируем добавить возможность использования содержимого разделов для нескольких проектов в будущих версиях программы.
 
izogfif, Спасибо за развернутый ответ. Действительно хороший рабочий вариант.
Еще  один вопрос: возможно ли в качестве переменных использовать что-то кроме текста, например, изображения? Может быть как-то через специальные переменные?
 
Цитата
Еще  один вопрос: возможно ли в качестве переменных использовать что-то кроме текста, например, изображения? Может быть как-то через специальные переменные?

Нет, к сожалению, пока что нет.
Страницы: 1
Читают тему