При разработке онлайн-документации в системе Документерра необходимо начать с создания нового проекта. В этом разделе вы узнаете, что такое проект, как он связан с публикацией и что нужно сделать, чтобы ваша онлайн-документация стала доступной для читателей.
- Проекты и публикации
- Создание публикации
- Изменение видимости публикации
- Что произойдет, если страница была изменена во время публикации?
Проекты и публикации
Проект— это контейнер для страниц справки, но проекты недоступны для читателей. Они используются только на этапе создания документации в рамках стандартного процесса создания документации.
По окончании создания контента ваше руководство пользователя должно стать доступным для читателей, поэтому вы должны опубликовать свой проект. В результате этого процесса создается публикация.
Вы можете сделать публикацию доступной для всех в Интернете, ограничить доступ к ней только зарегистрированными пользователями с ролью авторизованных читателей или сделать ее приватной и видимой только для авторов —это зависит от вас.
Вы также можете создать скачиваемую версию документации в одном из поддерживаемых форматов (PDF, DOCX, HTML5 WebHelp и т.д.). Для получения более подробной информации обратитесь к этому разделу: Форматы экспорта.
Создание публикации
| Ниже описан полный процесс публикации. Чтобы узнать как можно быстро публиковать страницы прямо из проекта, читайте Быстрая публикация из редактора страниц. |
Чтобы создать публикацию, необходимо выполнить следующие действия:
- Перейдите на страницу Проекты.
- Выберите проект, который вы хотите опубликовать, и нажмите кнопку Опубликовать рядом с заголовком проекта.
-
Откроется Мастер публикации проекта:
- Укажите название для публикации — данное название будет видно читателям.
-
Настройте видимость публикации. Она может быть открытой, закрытой или приватной:
-
Вы можете управлять условным контентом проекта с помощью условных тегов.
|
Совет |
| На этом же шаге вы можете разрешить публикацию страниц только со статусом «Готово». | |
- Нажмите кнопку Дальше и дождитесь создания публикации .
- На последнем шаге вам будет предоставлена ссылка на созданную публикацию и ссылки на CSS-файлы, скопированные из проекта.
- Нажмите Завершить.
После нажатия кнопки Завершить на странице Проекты появится публикация. Нажмите на нее, чтобы просмотреть окончательный результат.
|
Примечание |
| Если у вас есть ссылки на страницы, которые не публикуются в текущей операции (например, в случае частичного обновления), они будут преобразованы в смарт-ссылки. | |
Изменение видимости публикации
Чтобы изменить уровень видимости публикации, выберите публикацию и нажмите кнопку Настройки.
В разделе Общее → Видимость и доступ можно изменить уровень видимости.
Таким образом можно создавать и настраивать публикации в системе Документерра.
Что произойдет, если страница была изменена во время публикации?
Публикация не является мгновенным процессом и может занять некоторое время. Сначала система соберет список всех страниц для публикации, а затем начнет копировать их в публикацию одну за другой. За это время страница может быть изменена. В этом случае система Документерра выдаст предупреждение в журнале публикации.
-
Если вы публикуете только страницы со статусом Готово, и во время публикации статус страницы был изменен, система Документерра выдаст предупреждение в журнале:
Статус страницы X был изменен в процессе публикации. Страница больше не находится в состоянии «Готово». Страница была опубликована, но мы рекомендуем вам проверить содержание страницы в публикации: Y. -
Если страница заблокирована во время ее публикации (например, кто-то редактирует ее), Документерра выдаст предупреждение в журнале:
Страница X в настоящее время заблокирована пользователем XYZ. Страница была опубликована, но мы рекомендуем вам проверить содержание страницы в публикации: Y.
В обоих случаях страницы будут опубликованы. В первом случае контент, скорее всего, не изменился, тогда как во втором случае кто-то мог отредактировать контент страницы, и вместо той, которую вы намеревались опубликовать, может быть опубликована измененная (то есть, скорее всего, незаконченная) версия.
В этом случае вы можете перейти к своему проекту, найти данную страницу и откатить ее к предыдущей версии, опубликовать эту страницу, а затем снова откатить ее к измененной версии.