Шаблон руководства пользователя ПО

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

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

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

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

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

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

Шаг 1. Выберите шаблон

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

Шаг 2. Наполните документ контентом

Заменяйте тексты-заготовки описанием вашего продукта. Чтобы добавить скриншоты, используйте инструмент захвата экрана — программа автоматически сделает снимок окна и пронумерует элементы.

Шаг 3. Экспортируйте в нужный формат

Выберите формат для экспорта.

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

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

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

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

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

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

Начинающим авторам, которые пишут руководство пользователя впервые и не знают, с чего начать. Шаблон показывает проверенную структуру и дает примеры формулировок.
Разработчикам, которым нужно быстро выпустить документацию. Открыли шаблон — заменили текст — экспортировали.
Командам, которые поддерживают несколько версий продукта В одном проекте можно хранить документацию для разных версий. Исправили описание — автоматически обновились все руководства и справочные файлы.
Компаниям, которым нужна документация в корпоративном стиле Настроили дизайн шаблона один раз — теперь все руководства выглядят единообразно, даже если их готовят разные авторы.

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

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

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

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

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

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

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

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

Можно ли править структуру шаблона?

Да, вы можете добавлять, удалять и переименовывать разделы. Шаблон — это стартовая точка, а не жёсткая схема.

Можно добавлять текстовые блоки и использовать переменные для повторяющегося контента?

Можно.

В программе есть темы оформления?

Есть.

Какая максимальная вложенность разделов?

Вложенность разделов не ограничена.

При импорте в программу старой документации сохранится ее структура?

Сохранится.

Есть бесплатная версия программы?

Есть. Вы можете пользоваться ей без ограничений по времени. Скачать бесплатную версию Dr.Explain можно на этой странице.

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

Документируйте интерфейсы автоматически