Как коммуникаторы используют Doc-To-Help

07.10.2015

Недавно в нашем магазине появилась возможность приобрести продукт для создания контента Doc-To-Help, который совместим с Microsoft Word. Мы писали о возможностях данного софта для технических писателей, а сегодня расскажем о его особенностях в контексте различных форматов и типов документов.

Основанное на Word^™ простое в использовании решение для создания, управления и публикации онлайн-справок, руководств и методик, электронных книг и другой документации

Doc-To-Help используется техническими коммуникаторами, разработчиками руководств, поддержкой пользователей, преподавателями и другими авторами контента для создания документации к программному обеспечению, онлайн-справок, инструкций к продуктам, руководств, которые могут быть опубликованы во множестве форматов, включая отзывчивый веб, PDF, ePub и другие.

Создавайте контент в Word^™ (или используйте существующие файлы Word^™), управляйте им и работайте совместно с другими писателями, а также публикуйте в любом количестве форматов, позволив Doc-To-Help сделать всю работу.

Наиболее частые решения

Документация и поддержка пользователей

Успех пользователей вашего программного обеспечения ограничен только качеством и доступностью инструкций, справки и документации, которые вы им предоставляете. В зависимости от природы приложений вам могут потребоваться руководства в одной или нескольких из следующих форм: онлайн-справка (просмотр запускается из интерфейса), справка на вашем сайте, контент на мобильных устройствах и распечатанные PDF-инструкции. Технические писатели и разработчики используют Doc-To-Help, чтобы писать инструкции к программному обеспечению, базы знаний, руководства и другие инструкции, и публиковать в необходимом количестве форматов. Самое главное: им необходимо только один раз создать контент и затем публиковать его туда, куда нужно. Это избавляет их от необходимости переделывать контент для каждого формата и упрощает процесс публикации информации там, где она необходима пользователям.

Проект на изображениях выше — пример документации к программному обеспечению, идущий в составе Doc—To—Help. Этот пример предлагается вам в помощь при начале работы над документацией к ПО. Слева направо: Топик в редакторе контента Doc—To—Help, вывод NetHelp, просматриваемый в браузере, и вывод, предназначенный для печати PDF.

Посмотрите самостоятельно

• Просмотрите инструкцию к Doc-To-Help в формате NetHelp и PDF.
• Пример документации к программному обеспечению, входящий в состав Doc-To-Help. Загрузите Doc-To-Help и откройте папку с примерами, чтобы просмотреть его.

Руководства, процедуры и регламенты

Doc-To-Help переводит ваши процедурные инструкции, справочники для сотрудников и регламентирующую информацию в интерактивный веб-сайт с функцией поиска, и это позволяет легко находить информацию и сократить затраты на печать. Многие организации пишут и управляют своими справочниками в Microsoft^® Word^™ и распространяют их в виде оригинальных документов, сохраняют их в PDF или печатают. В любом случае, информацию тяжело найти, по ней тяжело производить поиск и она не интерактивная. Когда необходимо внести обновления, инструкции приходится распространять повторно. Doc-To-Help улучшает этот процесс с помощью создания легко развёртываемого централизованного сайта с автоматически генерируемым содержанием, ссылками «См. также», поисковой системой и другими функциями. Когда приходит время для обновления, то всё, что вам необходимо – обновить сайт.

Проект на изображении выше — пример руководства для сотрудника, идущего в составе Doc—To—Help. Этот пример был создан из существующего документа Microsoft^® Word^™. Слева направо: Исходный документ Word^™, вывод в NetHelp, просматриваемый в браузере, и PDF для печати.

Посмотрите самостоятельно

• Посмотрите работающую версию вывода в NetHelp для этого примера
• Пример «Сотрудник» входит в состав Doc-To-Help. Загрузите Doc-To-Help и откройте папку с примерами, чтобы его увидеть.

Учебные материалы

Преподаватели используют Doc-To-Help для оптимизации процесса разработки материалов для обучения. Одни преобразуют существующие документы Microsoft^® Word^™ в сайт для электронного обучения, а другие пишут с нуля в редакторе контента Doc-To-Help. В любом случае, публиковать обновления учебных материалов и создавать карты контента для особых выводов в онлайне и по запросу — просто.

Например, пользователи могут создавать версии инструкции для преподавателя и для студента, проставляя тэги в тексте для включений/исключений. Если вы хотите поддерживать печатные и онлайн-версии материалов, вы можете включить интерактивные функции, такие как видео, в онлайн-версии и опустить их для печатных версий.

На изображении выше отрывок официального учебного пособия Doc-To-Help. Этот пример — реальный отрывок из нашего официального учебного пособия, так что это хорошая отправная точка, от которой можно начать создание ваших собственных инструкций.

Посмотрите самостоятельно

• Пример «Обучение» включён в Doc-To-Help. Загрузите Doc-To-Help и откройте папку с примерами, чтобы его увидеть.

Руководства на оборудование и технические инструкции

Многие клиенты используют Doc-To-Help для создания руководств пользователя и технических инструкций на оборудование. Традиционно пользователи и технические специалисты рассчитывают на распечатанные инструкции при установке, использовании и ремонте оборудования. Проблема заключается в том, что эти инструкции могут быть объёмными и неудобными, они быстро становятся неактуальными и легко повреждаются. Doc-To-Help упрощает публикацию существующих инструкций (или позволяет создать новые с нуля) в веб-формат для просмотра на мобильном браузере или в формат EPUB для электронных книг. В любой случае, технические специалисты и пользователи могут использовать планшеты и получать быстрый доступ к необходимой информации. Обновление при этом производится так же просто как написание нового контента и повторная публикация. Нет необходимости что-то печатать, переплетать, нет повреждений и других проблем.

Базы знаний для поддержки и ИТ

Doc-To-Help эффективен при создании информации, которую необходимо легко находить. Это уменьшает нагрузку на сотрудников техподдержки и увеличивает скорость ответов на вопросы и решения проблем. Лучший способ сделать это — опубликовать хорошо организованную онлайн-базу знаний с функцией поиска. Независимо от того, импортируете ли вы существующие документы и публикуете в виде единой веб-системы с функцией поиска или используете редактор контента Doc-To-Help для написания отдельных статей, процесс происходит бесшовно.

Источник: How Communicators Use Doc-To-Help

Тэги: Doc-To-Help, MadCap, MS Word, PDF, единый источник, инструменты, управление контентом, форматирование, форматы, шаблоны