Постраничное создание документации
Документерра — это система создания документации на основе страниц. По сравнению с книжно-ориентированным подходом постраничный подход более эффективен для создания и управления документацией. В этом разделе описываются основные принципы работы в Документерре.
Страницы
Чтобы сделать документацию более эффективной и удобной для пользователя, следует создать страницу для каждого раздела или задачи, которую ищут читатели. Посмотрите на приведенный ниже пример. Здесь показаны два раздела с заголовками. Если это возможно и имеет смысл, лучше выделить их в отдельные страницы, особенно если каждый раздел довольно длинный.
Почему вы должны это делать? Написание контента в виде страниц по сравнению с созданием одного длинного документа имеет множество преимуществ. Страницы будет легче:
- Переводить. В системе Документерра можно создать многоязычное руководство пользователя . Для получения более подробной информации обратитесь к этому разделу: Создание многоязычной документации.
- Использовать повторно. Например, вам нужно повторно использовать страницу в разных местах Дерева страниц. Для этого не нужно копировать и вставлять контент. Для получения более подробной информации обратитесь к этому разделу: Повторное использование страницы в нескольких элементах Дерева страниц.
- Обновлять. В системе Документерра нет необходимости заново публиковать весь проект, если вам нужно обновить несколько переписанных или улучшенных страниц. Для этого можно использовать режим частичного обновления. В данном режиме можно вставлять новый контент в некоторые страницы, не меняя страницы, которые еще не готовы. Для получения более подробной информации обратитесь к этому разделу: Режим частичного обновления публикации.
- В случае страниц легче сотрудничать. Каждая страница имеет своего исполнителя, статус и владельца, поэтому разные страницы одного проекта могут быть назначены разным людям, могут рецензироваться отдельно, а также можно посмотреть историю изменений для каждой отдельной страницы.
Публикации
Публикация — это совокупность страниц. Вот как выглядит онлайн-документация:
Структура публикации похожа на оглавление, в ней есть различные разделы, представленные отдельными страницами. Это удобнее для пользователей, поскольку они могут быстро найти необходимую информацию. При этом им не нужно прокручивать длинный текст.