Статусы разделов

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

Как работать со статусом разделов в Dr.Explain?

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

Если к написанию раздела еще не приступили — окрасьте его серым цветом, что будет напоминать вам и команде, что тема ещё не готова. Желтый цвет означает, что тема пишется и над ней работают, а красным цветом помечаются разделы, ожидающие проверки или утверждения. Зеленым цветом будут отображаться готовые темы, полностью прописанные и заполненные.

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

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

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

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

• Визуальный контроль прогресса. Тепловая карта позволяет мгновенно оценить, какая часть документации готова, а какая требует внимания, без необходимости открывать каждый раздел.
• Упрощение командной работы. Все авторы видят актуальное состояние задач: кто что пишет, что на проверке, а что уже можно не трогать.
• Помощь в планировании. Статусы помогают равномерно распределять нагрузку, выявляя "красные" (проблемные) зоны, требующие вмешательства.
• Прозрачность процесса для руководителя. Менеджер или старший автор всегда может за пару секунд оценить общий прогресс по проекту.
• Удобство при поддержке нескольких версий. Например, при обновлении документации под новую версию продукта статусы помогают отслеживать, какие старые разделы уже актуализированы.

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

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

• Руководителям групп авторов. Тепловая карта дает объективную картину прогресса разработки и помогает распределять задачи.
• Техническим писателям, работающим над большими проектами. Статусы помогают не запутаться в десятках и сотнях страниц, показывая, какие части завершены.
• Командам, которые поддерживают документацию на нескольких языках. Статусы позволяют синхронизировать работу переводчиков и редакторов.
• Разработчикам, которые планируют релизы пользовательской документации. Статусы упрощают контроль версий перед экспортом.
• Авторам, которые хотят наладить личный процесс работы. Даже при индивидуальной работе статусы помогают видеть "узкие места" и не забывать о незавершенных разделах.

Пользователи о работе со статусами разделов в Dr.Explain

"Как выяснилось в ходе тестирования Dr.Explain, во-первых, к дизайн справки легко кастомизируется. Мы смогли быстро воплотить в жизнь нужный нам дизайн. Во-вторых, понравилась возможность установки статусов для разделов. Это очень удобно, особенно в нашем случае, когда приходится поддерживать справку на нескольких языках".

Ольга Михеева, руководитель отдела документирования компании ELMA

Интервью с Ольгой

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

Наталья Обухова, бизнес-аналитик компании CRM Expert

Интервью с Натальей

"У вас есть возможность просто отметить корневые узлы, чтобы они были скрыты, а затем создать документацию, включающую только то, что видно."

Дэвид Суиндон, главный директор по информационным технологиям Trustco Group Holdings

Интервью с Дэвидом

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

Смотрите также

• Управляйте структурой проекта
• Индекс ключевых слов
• Блокировка разделов