Документация элемента
Инструкции создаются для элемента. Самостоятельный продукт объединяет документацию входящих в него элементов, если у продукта не указана внешняя ссылка документации.
Создайте страницы
- Откройте документацию в «Управлении» и выберите свой элемент.
- Создайте страницу, замените «Новая страница» понятным названием.
- Добавьте текст и блоки содержимого. Начните с назначения, требований и первого действия пользователя.
- Создайте дочерние страницы для отдельных сценариев. Используйте дерево для поиска по названию, раскрытия разделов и изменения порядка.
- Нажмите «Сохранить». Автосохранение примерно раз в минуту сохраняет изменённое содержимое, но перед уходом дождитесь успешного сохранения вручную.
- Откройте «Просмотр», затем публичную документацию элемента с сайта и проверьте результат.
Отдельного переключателя черновика у страницы нет. Сохранённые изменения могут сразу стать публичными, если элемент доступен через опубликованный продукт. Подготовьте текст перед сохранением.
Редактор документации с деревом страниц и режимами правки и просмотра.
Организация дерева
Можно переименовывать, перемещать и дублировать страницы. Дублирование копирует одну страницу, без её дочерних страниц. Удалить страницу с дочерними нельзя: сначала переместите или удалите детей. Нельзя перемещать страницу к другому элементу или создавать круговую иерархию.
В просмотре доступны масштаб 80–140% и режим «Экран». Анализ и рекомендации помогают улучшить текст, но итоговую точность проверяет автор.
В текущем редакторе действия копирования ссылки и открытия на сайте могут не получить адрес страницы. Для проверки переходите к документации через публичную страницу элемента или продукта. Дополнительные статьи: навигация покупателя, ссылки продукта.