Руководство пользователя ПО

Используя готовый шаблон документации, вы значительно экономите время на создание структуры проекта с нуля и на поиск и изучение информации о том, как это делается. Само содержание разделов уже частично заполнено текстовым и графическим контентом, предлагая вам сразу приступить к вводу информации именно о вашем продукте, а не думать о форме ее подачи.

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

Если вы считаете, что в программе не хватает нового специфического шаблона и он может быть полезен многим пользователям, мы готовы разработать такой шаблон. Пожалуйста опишите вашу задачу и поделитесь своими мыслями, шаблон какого документа был бы полезен для вас. Ждем ваших писем на: help@drexplain.com.

Узнать больше о готовых шаблонах руководств вы можете здесь.

Как создать шаблон руководства пользователя ПО в Dr.Explain?

Для того, чтобы создать шаблон руководства, нужно при запуске программы в главном меню открыть пункт "Файл", далее "Создать локальный проект по шаблону" и выбрать "Руководство пользователя ПО".

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

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

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

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

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

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

Расширенные настройки экспорта. Документация постоянно улучшается, наступает момент, когда нужна печатная версия документа или контекстная справка в формате CHM. Dr.Explain решает такие задачи эффективно и быстро.

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

Целевая аудитория Dr.Explain — это как опытные авторы, так и новички. Простые и понятные инструменты делают программу легкой в усвоении и ускоряют написание проектов любого уровня. Рассмотрите программу, если:

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

Пользователи о шаблонах в Dr.Explain

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

Луис Кесслер, руководитель компании Behold Genealogy

Интервью с Луисом

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

Натали ван де Виле, биоинформатик и менеджер по продуктам компании BioAware

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

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

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

• О переменных - как они упрощают процесс написания документации
• Как быстро перенести документацию в online-формат