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

Публикация

При работе с вашим контентом — создании, редактировании, ревью и т.д. — вы работаете с проектом, который недоступен вашим читателям. Только залогиненные Авторы имеют к нему доступ.

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

Онлайн документация

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

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

Читательский интерфейс

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

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

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

Публикация готового руководства и создание онлайн-версии проекта - это вопрос нескольких кликов:  Опубликовать руководство.

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

При создании публикации система автоматически генерирует идентификатор публикации на основе имени публикации; вы можете изменить идентификатор во время процесса публикации. Идентификатор публикации используется как часть URL-адреса опубликованных страниц. Помните, что идентификаторы публикаций должны быть уникальными для всего портала — они также не могут совпадать с идентификаторами проектов.

Идентификатор публикации в URL

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

Например, если вы начнете создавать публикацию с именем Руководство пользователя 2.0, система автоматически сгенерирует идентификатор rukovodstvo-polzovatelya-2-0. Затем Документерра создаст папку с тем же именем. 

Таким образом, раздел "Getting Started" в этой публикации будет иметь следующий URL-адрес:

https://docs.hedronlabs.org/articles/#! user-guide-version-2-0/getting-started

Обновление онлайн-публикации

После создания публикации вы можете обновить ее в любое время, чтобы она соответствовала вашему проекту. Вы можете полностью заменить существующую публикацию содержимым вашего проекта несколькими щелчками мыши. Или вы можете обновить только её часть — отдельную страницу или набор страниц — используя нашу функцию частичного обновления. Частичное обновление позволяет перенести изменения, внесенные в проект, в публикацию, затрагивая только выбранные страницы, оставляя другие нетронутыми. Это позволяет ускорить доставку готовых документов — вы можете публиковать отдельные страницы, как только они будут готовы, не дожидаясь завершения всего проекта.

Чтобы начать работу с частичным обновлением, ознакомьтесь с этими ресурсами:

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

Ограничение доступа к онлайн-публикациям

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

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

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

Но создание приватных и закрытых публикаций - не единственный способ защитить вашу документацию в Документерре. Есть и другие методы.

Скачиваемое руководство

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

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

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

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

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

В некоторых случаях вам может понадобиться получить документацию в формате "чистого" HTML, чтобы ваши HTML-файлы содержали только содержание статей - без TOC и пользовательского интерфейса читателя. Такая необходимость может возникнуть, например, если вы хотите создать документацию в Документерре, но опубликовать ее в другой системе. Документерра позволяет вам это сделать; вы можете создать такой "чистый" HTML-вывод, следуя шагам, описанным в разделе Создать HTML-руководство.