Запросить демо
Запросить демо
Документерра: руководство пользователя

Стандартный процесс создания документации

Цель любого процесса создания справочной документации — получить в итоге руководство пользователя. В системе Документерра все начинается с создания проекта для написания контента. Конечную цель можно трактовать как публикацию руководства пользователя онлайн и обеспечение его доступности для читателей, т.е. публикацию своего проекта. В зависимости от команды технических писателей путь от проекта до публикации может быть различным. Документерра не навязывает один конкретный рабочий процесс — вы сами выбираете, как работать над проектом, чтобы достичь конечной цели. В этом разделе мы узнаем, как выглядит типичный процесс и из чего он состоит.

Создание проекта

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

Нажмите кнопку Создать проект на странице Проекты, чтобы открыть мастер создания проекта.

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

Создание страниц справки

После создания проекта выделите его на панели проектов и нажмите кнопку Открыть выбранный проект на панели инструментов — откроется редактор проектов.

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

Чтобы изменить контент страницы, нажмите кнопку Редактировать в левом верхнем углу страницы. После этого текущая страница справки будет заблокирована для других участников, чтобы они не могли вмешиваться в работу над контентом. После этого контент страницы перейдет в режим редактирования.

Если вы посмотрите на нижнюю часть редактора страниц, то увидите три вкладки:

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

Настройка внешнего вида

Установите галочку в группе опций "Параметры брендинга" в глобальных настройках, чтобы портал документации максимально соответствовал стилю вашей компании. Укажите фавикон, свой логотип и другие настройки.

Еще одна вещь, которую вы, возможно, захотите изменить, — это домашняя страница портала документации, которая отображается, когда читатели переходят по URL-адресу вашего портала, не открывая конкретную страницу справки. Например, эта ссылка указывает на главную страницу нашего портала документации: https://documenterra.ru/.

Назначение страниц для рецензентов

Когда страница справки готова, ее можно назначить рецензенту — эксперту в данной предметной области, техническому редактору, менеджеру группы технических писателей и т.д. Для этого необходимо изменить поле Исполнитель и установить статус На проверке. Использование статусов не является обязательным, но может быть полезным для облегчения просмотра хода проекта, фильтрации страниц в Дереве страниц по статусам, просмотра распределения страниц по статусам в статистике проекта и т.д. По завершении рецензирования рецензент изменит статус страницы на Готово и вернет ее владельцу.

Если у рецензентов есть замечания или вопросы по содержанию страницы, они могут добавить Комментарии рецензента, чтобы владелец мог на них ответить.

Когда страница назначается пользователю, ему может быть отправлено уведомление по электронной почте — этой процедурой можно управлять в настройках портала. Эти уведомления могут содержать несколько последних примечаний от рецензента, что позволит получателю понять контекст.

Публикация руководства онлайн

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

В мастере публикации укажите видимость создаваемой публикации. Например, можно опубликовать документ в режиме Закрытая публикация для финального рецензирования, а затем в свойствах публикации изменить видимость публикации на Открытая публикация.

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

Экспорт в печатные форматы

Вы можете экспортировать любую публикацию в один из поддерживаемых печатных форматов: PDF, DOCX, ODT, ePub и др.

Для этого необходимо выбрать нужную публикацию в дереве проектов и нажать кнопку Опубликовать/Экспортировать на панели инструментов — откроется мастер публикации. Сначала необходимо указать формат. Еще одним важным моментом является конфигурация экспорта: если у вас ее еще нет, то, возможно, вам придется ее создать. Конфигурации экспорта сохраняют настройки экспорта для последующего повторного использования.

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

Отслеживание статистики и улучшение контента

Документерра предоставляет статистику как по проектам, так и по публикациям, хотя параметры статистик отличаются.

Статистика проекта помогает понять ход и готовность проекта. Она показывает распределение статей по статусам или по владельцам страниц — вы можете видеть, сколько страниц уже готово, а сколько еще находится в работе.

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