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

Руководство по публикации

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

Проекты и публикации

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

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

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

Вы также можете создать скачиваемую версию документации в одном из поддерживаемых форматов (PDF, DOCX, HTML5 WebHelp и т.д.). Для получения более подробной информации обратитесь к этому разделу: Форматы экспорта.

Создание публикации

Чтобы создать публикацию, необходимо выполнить следующие действия:

  1. Перейдите на страницу Проекты.
  2. Выберите проект, который вы хотите опубликовать, и нажмите кнопку Опубликовать под заголовком проекта.
  3. Откроется Мастер публикации проекта:
    Первый шаг мастера публикации
  4. Укажите название для публикации — данное название будет видно читателям.
  5. Настройте видимость публикации. Она может быть открытой, ограниченной или закрытой:
    Параметры видимости публикации в Мастере публикации
  1. Вы можете управлять условным контентом проекта с помощью условных тегов.
    Раздел «Условные теги» в Мастере публикаций
Совет
На этом же шаге вы можете разрешить публикацию только страниц со статусом «Готово».
  1. Нажмите кнопку Далее и дождитесь создания публикации .
  2. На последнем шаге вам будет предоставлена ссылка на созданную публикацию и ссылки на CSS-файлы, скопированные из проекта.
  3. Нажмите Завершить.

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

Публикация на странице «Проекты»

Примечание
Если у вас есть ссылки на страницы, которые не публикуются в текущей операции (например, в случае частичного обновления), они будут преобразованы в смарт-ссылки

Изменение видимости публикации

Чтобы изменить уровень видимости публикации, выберите публикацию и нажмите кнопку Настройки.

Кнопка «Настройки публикации» на странице «Проекты»
В разделе Общее → Видимость и доступ, можно изменить уровень видимости.

Раздел «Видимость и доступ» в настройках публикации

Таким образом можно создавать и настраивать публикации в системе Документерра.

Что произойдет, если страница была изменена во время публикации?

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

  • Если вы публикуете только страницы со статусом Готово, и во время публикации статус страницы был изменен, система Документерра выдаст предупреждение в журнале:
    Статус страницы X был изменен в процессе публикации. Страница больше не находится в состоянии «Готово». Страница была опубликована, но мы рекомендуем вам проверить содержание страницы в публикации: Y.
  • Если страница заблокирована во время ее публикации (например, кто-то редактирует ее), Документерра выдаст предупреждение в журнале:
    Страница X в настоящее время заблокирована пользователем XYZ. Страница была опубликована, но мы рекомендуем вам проверить содержание страницы в публикации: Y.

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

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