Статусы разделов
В Dr.Explain система статусов тем дает возможность наблюдать за прогрессом вашей работы. Задайте разделу определенный статус, который отметит его в дереве разделов соответствующим цветом.
Как работать со статусом разделов в Dr.Explain?
Чтобы задать статус теме, кликните соответствующую иконку в свойствах раздела. Логику присвоения статусов вы можете определить сами либо следовать предложенной ниже.
Если к написанию раздела еще не приступили — окрасьте его серым цветом, что будет напоминать вам и команде, что тема ещё не готова. Желтый цвет означает, что тема пишется и над ней работают, а красным цветом помечаются разделы, ожидающие проверки или утверждения. Зеленым цветом будут отображаться готовые темы, полностью прописанные и заполненные.
Данная функция сделает из структуры еще не готовой документации тепловую карту, на которой будет показан прогресс всех частей вашего проекта. Благодаря статусам разделов вы сможете отслеживать процесс написания документации и планировать дальнейшую работу.
В дереве проекта вы также можете защитить разделы от нежелательных изменений и наделять темы ключевыми словами для удобства навигации по документации.
Примеры пользовательских документаций, созданных в Dr.Explain
Пользовательская документация, как и любой другой документ, постоянно обновляется, и важно видеть общую картину: какие разделы завершены и нуждаются в актуализации информации, какие еще находятся в разработке и т.д. В программе Dr.Explain автор может видеть фронт работ и оценить приоритетность задач. Однако не последнюю роль в эффективности инструмента для написания руководств пользователя играет возможность прорабатывать дизайн проекта. Это влияет на усвоение материала и на восприятие документа в целом:
Какие преимущества вы получите с Dr.Explain?
Система статусов в Dr.Explain превращает структуру документации в наглядную карту прогресса, где каждый раздел отмечен цветом в зависимости от его готовности. Это упрощает планирование и контроль.
Контроль прогресса. Система статусов помогает визуально отслеживать ход работы: какие разделы ещё требуют внимания, а какие готовы к публикации.
Гибкая настройка внешнего вида справочной документации. Это позволяет создавать документацию, которая соответствует стилю вашего веб-сайта или приложения.
Типовые шаблоны. Готовые макеты руководств пользователя экономят время. В команде шаблоны особенно полезны: новички сразу видят, как правильно оформлять темы, не нарушая принятую структуру.
Для кого подходит Dr.Explain?
Dr.Explain подходит для экспертов и новичков: первые найдут в нем инструменты по реализации возможностей, выходящих за рамки стандартной документации, вторые легко создадут первый проект, который будет соответствовать современным требованиям. Вам стоит установить Dr.Explain, если:
- нужно в краткие сроки написать справочную систему и экспортировать ее в несколько разных форматов;
- нужен надежный софт с многолетней историей поддержки;
- нужна возможность отслеживать процесс работы над всеми разделами масштабного проекта;
- нужна возможность создавать разделы с неограниченной вложенностью;
- нужно десктопное решение;
- нужны инструменты для автоматического создания аннотированных скриншотов.
Пользователи о работе со статусами разделов в Dr.Explain
"Как выяснилось в ходе тестирования Dr.Explain, во-первых, к дизайн справки легко кастомизируется. Мы смогли быстро воплотить в жизнь нужный нам дизайн. Во-вторых, понравилась возможность установки статусов для разделов. Это очень удобно, особенно в нашем случае, когда приходится поддерживать справку на нескольких языках".
Ольга Михеева, руководитель отдела документирования компании ELMA
Интервью с Ольгой
"Возможность установки статуса раздела тоже оказалась очень удобной, особенно, после импорта старой версии справки легко отслеживать, какие разделы требуют обновления, в каких еще ведутся изменения, а какие уже обновлены и актуальны".
Наталья Обухова, бизнес-аналитик компании CRM Expert
Интервью с Натальей
Часто задаваемые вопросы
Есть проверка орфографии в Dr.Explain?
Есть проверка с поддержкой нескольких языков.
Можно изменять структуру документации перетаскиванием разделов?
Можно. При помощи драг-н-дроп можно перемещать раздел в любую область документации.
Можно импортировать свой старый проект в программу и продолжить его разработку в ней?
Можно. При этом структура вашего проекта сохранится.
Где можно посмотреть примеры проектов, созданных в вашей программе?
Примеры пользовательских документаций можно посмотреть на этой странице.
Можно создать веб-версию документации без знаний кода?
Можно. Dr.Explain генерирует онлайн-документацию пользователя автоматически.
Будет ли виден статус раздела в конечном документе?
Не будет. Статус раздела — это специальная пометка, отражающая текущее состояние разработки или редактирования темы (раздела) в проекте справки. Он не отображается конечным пользователям, но очень полезен для внутренней организации работы.