Управляйте структурой проекта

У вас возникали трудности в работе над руководством пользователя из-за большой вложенности разделов? Со временем такая документация превращается с запутанную систему, которую сложно поддерживать автору и невозможно понять пользователю. В этой ситуации очень не хватает визуального отображения взаимосвязей между разделами.

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

Что такое управление структурой в Dr.Explain?

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

Работая над проектом, вы можете:

• создавать, удалять, скрывать разделы;
• перемещать, переименовывать разделы;
• включать автоматическую нумерацию (для всех разделов документации или только для некоторых);
• изменять статус раздела, чтобы видеть прогресс работы ("ожидается редактирование", "редактирование завершено" и т.д.);
• блокировать раздел от внесения случайных изменений другими авторами при совместной работе над одним документом;
• задавать условия вывода раздела в финальный документ.

Как управлять структурой разделов в Dr.Explain?

Перемещение разделов

Перемещение разделов осуществляется одним из трех способов:

• перетаскиванием: зажмите левой кнопкой мыши раздел (документ), который нужно переместить, и перетащите его в нужный раздел;
• вызовом контекстного меню: на документе, который требуется переместить, вызовите контекстное меню правой кнопкой мыши и выберите нужное действие (например, "уменьшить уровень", если нужно переместить раздел на уровень ниже и "увеличить уровень", если нужно поднять раздел на уровень выше);
• с помощью горячих клавиш.

Автоматическая нумерация

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

Примеры оформления нумерации разделов:

Процесс работы над документацией в виде тепловой карты

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

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

Блокировка раздела

Блокировка раздела помогает закрыть завершенный раздел от редактирования, чтобы избежать случайных правок и оставить только возможность его просмотра. Это может быть очень полезно при работе над одним проектом нескольких авторов. Можно заблокировать только родительский раздел или родительский раздел + дочерние.

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

Инструменты Dr.Explain делают процесс создания пользовательской документации удобным и эффективным. Ниже представлены результаты их применения:

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

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

Понятная иерархическая структура. Разделы и подразделы легко добавляются, переименовываются или перемещаются. Это позволяет быстро выстраивать логичную навигацию, даже для сложных многоуровневых руководств.

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

Гибкость и адаптивность. Автор может легко реорганизовать материал: объединять темы, менять порядок разделов или создавать связи между ними. Это особенно полезно при доработке документации или адаптации её под разные версии продукта.

Наглядность. Древовидный интерфейс даёт чёткое представление о содержимом проекта. Это помогает быстро ориентироваться в больших объёмах информации, находить «пробелы» в структуре и равномерно распределять контент.

Удобство планирования. Тепловая карта помогает оценить готовность документа вообще и отдельно взятого раздела в частности.

Документация неограниченного размера. Создание документации с разделами любой вложенности значительно расширяет возможности масштабирования.

Блокировка разделов. Запрет на редактирование помогает избежать ошибок при совместной работе.

Преимущества работы со структурой проекта в Dr.Explain

Авторы руководств пользователя начинают искать более функциональную альтернативу, когда сталкиваются с ограничениями в своем текстовом редакторе. В большинстве случаев это MS Word. Сравним работу с разделами в двух программах.

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

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

• сложно управляться с разросшейся документацией;
• проекту необходима навигация;
• требуется полноценный поиск по разделам;
• нужна возможность изменять внешний вид руководства;
• нужно упростить работу со скриншотами и изображениями;
• работа замедляется из-за необходимости использовать сторонний софт;
• нужна печатная и веб-версия пользовательской документации;
• нужна среда для совместной работы над проектом;
• нужна долгосрочная поддержка программы;
• нужна бесплатная версия для ознакомления с возможностями программы.

Пользователи об управлении структурой проекта в Dr.Exlain

"Легко вставлять изображения. Легко структурировать документ, можно сразу увидеть результат. Мне нравится простота создания версий PDF и Word. Создав CHM, мы можем легко добавить его в наши приложения .NET."

Алекс Мьюир, управляющий директор компании Database Software Solutions Ltd

Интервью с Алексом

"Сначала мы писали справочные документы в Microsoft Word, но людям было сложно ими пользоваться и находить нужную информацию. Мы попробовали два или три пакета для создания справок, прежде чем остановились на Dr.Explain. Dr.Explain прост в использовании и создает хорошо отформатированные справочные документы с широкими возможностями поиска."

Боб Гримшоу, основатель компании C-A-Solutions

Интервью с Бобом

"Автоматический захват экрана Dr.Explain избавляет меня от постоянного копипастинга, программа помогает мне в структурировании разделов, хорошо реализована работа со ссылками и управление в целом."

Винни Скосана, технический писатель из Hensoldt

Интервью с Винни

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