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

Руководства пользователя с ограниченным доступом

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

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

Создание руководства пользователя с ограниченным доступом

Предположим, у вас есть проект, который должен быть опубликован и виден только ограниченной аудитории.
Чтобы создать публикацию, нажмите кнопку Опубликовать под названием проекта.
На шаге 1 мастера публикации проекта задайте для уровня видимости значение Ограниченная публикация. Ваш проект будет доступен только для авторов и авторизованных читателей. Авторизованные читатели —это особый тип пользователей —они имеют доступ к документации с ограниченным доступом, но не имеют доступа к страницам, доступным авторам (страница проектов, настройки, управление пользователями и т.д.). Кроме того, авторизованный читатель не может изменять контент документации.
Перейдите к дальнейшим шагам мастера, как вы обычно делаете это при создании публикации .
После создания публикации вы можете открыть домашнюю страницу портала документации без входа в систему. Это поможет вам убедиться, что публикация не отображается в списке общедоступных документов. Созданная публикация будет доступна только пользователям, которые авторизуются на вашем портал документации —авторизованным читателям и авторам. Чтобы легко выполнить эту проверку, вы можете использовать закрытый режим или режим инкогнито вашего веб-браузера.

Создание учетной записи авторизованного читателя

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

Настройка прав доступа авторизованных читателей

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

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

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

Чтобы управлять правами доступа одного авторизованного читателя, перейдите в раздел Инструменты → Пользователи и роли → Авторизованные читатели и нажмите кнопку Редактировать профиль пользователя нужного пользователя. Затем перейдите в раздел Роли и права доступа, где вы можете выбрать, к каким публикациям пользователь будет иметь доступ:
Чтобы управлять правами доступа групп авторизованных читателей, перейдите в Инструменты → Пользователи и Роли → Роли авторизованных читателей. Вы увидите список созданных вами авторизованных читателей и их групп доступа (дополнительные сведения о группах доступа авторизованных читателей смотри в следующем разделе: Группы доступа авторизованных читателей). Выберите публикации, которые будут доступны для каждой группы доступа авторизованных читателей:

Особенности документов с ограниченным доступом

При создании онлайн-документации с видимостью Только для авторизованных читателей вы должны знать о нескольких вещах:

Если анонимный читатель попытается получить доступ к документу с ограниченным доступом по прямой ссылке, он будет перенаправлен на страницу авторизации.
Поскольку Документы с ограниченным доступом требуют входа в систему, они не индексируются поисковыми системами. Это означает, что эти документы не будут индексироваться поисковиками Google, Yahoo, Bing и т.д. Если вы ожидаете получить некоторую преимущества в плане SEO от онлайн-документации, убедитесь, что вы разумно ограничили доступ.

Дополнительные опции для защиты руководств пользователя

Существует несколько вариантов защиты онлайн-документации в системе Документерра. О них можно прочитать здесь: Защита руководств пользователя.

Частичное обновление — алгоритм обновления Дерева страниц Скрыть публикацию из списков публикаций