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

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

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

Проекты

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

Когда вы будете готовы предоставить контент своим читателям, вы выполняете действие «Опубликовать» для своего проекта. В результате система создает публикацию.

Публикации

Публикация — это «снимок» контента вашего проекта (или его части), сделанный в определенный момент времени, который вы предоставляете своим читателям. При выполнении действия «Опубликовать» для проекта в Документерре система применит параметры, заданные в мастере публикации, и создаст публикацию. Контент публикации будет отделен от контента вашего проекта. Публикации имеют свой контент и страницы. Это означает, что вы можете продолжать вносить изменения в свой проект, и они не повлияют на публикацию. Чтобы перенести изменения в публикацию из проекта, выполните действие «Опубликовать» и в режиме «Обновить» перенесите последний контент страницы в существующую публикацию.

Публикации на портале могут иметь несколько уровней видимости:

  • Закрытая. Данная публикация доступна только для авторов (после входа в систему). Такой уровень видимости полезен при экспорте контента в какой-либо загружаемый формат, например PDF, а создание публикации — это лишь промежуточный шаг.
  • Ограниченная. Доступна для авторов и авторизованных читателей (после входа в систему). Данный уровень видимости используется для создания документации, защищенной паролем. Для чтения вашим читателям необходимо войти в систему.
  • Открытая. Доступна для всех (вход в систему не требуется). Поисковые системы также могут индексировать такие публикации, поэтому их страницы будут отображаться в результатах поиска в Google, Bing и т.д.

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

Теперь давайте обозначим основные различия между этими двумя понятиями:

  • Проекты — это черновики, которые могут видеть только авторы; публикации — это окончательные версии ваших документов, доступные читателям. 
  • Можно экспортировать публикации в различных печатных форматах, таких как PDF, EPUB или DOCX. Для получения более подробной информации обратитесь к этому разделу: Создание документа в формате PDF.
  • Можно редактировать как публикации, так и проекты. Непосредственное редактирование публикации может потребоваться для быстрого исправления опечатки в опубликованном документе без прохождения процесса публикации. Помните, что изменения, внесенные непосредственно в публикации, также должны быть внесены в проект.
  • У проектов и публикаций есть что-то общее: страницы, Дерево страниц, стили, скрипты, файлы, настройки и т.д. При создании публикации вы получаете копию всех этих элементов. Однако элементы, связанные с публикацией из единого источника и динамическим выводом данных (сниппеты, условные блоки, переменные, элементы навигации), компилируются в окончательный HTML-код, а не остаются прежними.

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