Рекомендации по работе в модуле "Пользовательская документация"

Модуль «Пользовательская докумендация» предназначен для создания и централизованного хранения документации пользователей продукта. Он представлен категорией «Документация пользователя».

Здесь мы собрали некоторые рекомендации, которые позволят вам наиболее эффективно использовать модуль.

Структура

Используйте элемент «Папка (к)» для объединения инструкций по модулям, проектам или другим параметрам.

Внутри папок можно создавать другие папки для дополнительной вложенности документации.

Создание документации

Используйте встроенный текстовый редактор Bizon для написания и оформления документации.

Не забывайте сохранять документы по окончании редактирования. Каждая сохранённая версия документа будет отображаться в информационном блоке «Файлы», и вы сможете при необходимости вернуться к старой версии.

Для выбора актуальной версии документа, которая будет отображаться в приложении «Файл», проставляйте ей параметр «Сделать основным» в информационном блоке «Файлы» (контекстное меню файла → «Сделать основным»).

Также вы можете загружать в систему уже готовые документы. Для этого выберите «Загрузить файл» в информационном блоке «Файлы».

Связи

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

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

Статусы

Используйте статусы элементов «Инструкция пользователя». Значения статусов могут зависеть от договорённостей внутри вашей команды. Например, они могут показывать готовность документа к публикации:

Не доступен – документ не проверен и не готов к публикации;
Доступен – документ проверен и готов к публикации;
Аннулирован – документ проверен, публикация не требуется;
Требуется доработка – документ проверен, необходимо внести правки.