Импорт файлов Swagger/OpenAPI, предварительный просмотр в режиме читателя, создание сортируемых таблиц. Что еще есть в ноябрьском обновлении Документерры?
В ноябре 2022 года вышло обновление Документерры — у нас уже есть подробный обзор. В этой статье мы решили разобрать некоторые функции детальнее.
Например, теперь пользователи могут импортировать файлы Swagger/OpenAPI в Документерру — это позволит хранить API-документацию и руководства пользователя на одной платформе. Если ваш контент размещён на разных порталах, то у вас не получится быстро находить нужную информацию, так как полнотекстовый поиск будет недоступен. Кроме того, дизайн публикаций в разных инструментах будет отличаться. Таким образом, импорт файлов Swagger/OpenAPI поможет вам управлять документацией централизованно.
После импорта таких файлов в Документерру вы получите специальный элемент дерева страниц в проекте. В этом случае Swagger вам понадобится только для того, чтобы редактировать API-документацию, которую можно сразу обновить в Документерре.
Например, давайте импортируем следующий файл в JSON-формате:
https://petstore.swagger.io/v2/swagger.json
1. Откройте проект и нажмите кнопку ИМПОРТИРОВАТЬ.
2. Выберите подходящий формат для импорта (OpenAPI) и нажмите ДАЛЬШЕ.
3. Вставьте URL файла и снова нажмите ДАЛЬШЕ.
Мы успешно импортировали файл Swagger/OpenAPI в свой проект.
Обратите внимание, что вы можете редактировать файлы только в Swagger и потом обновлять импортированные страницы в Документерре.
Предварительный просмотр в режиме читателя — еще одна новая функция. Теперь можно быстро узнать, как страница проекта будет выглядеть для читателей. Просто нажмите на кнопку в виде глаза, и Документерра покажет контент в читательском интерфейсе.
Чтобы вернуться к пользовательскому интерфейсу, нажмите на кнопку «В режим автора».
Эта функция позволит вам быстро переключаться между редактированием материала и предпросмотром контента. Так вы сможете сэкономить время для более важных задач.
Кроме того, теперь работать с таблицами в Документерре стало еще удобнее. Технические писатели часто создают таблицы с большим количеством данных. Иногда читателям трудно воспринимать такие объёмы информации, поэтому нужно помочь им разобраться с данными. Например, теперь в Документерре можно создать сортируемые таблицы.
Для этого вам нужно открыть свойства таблицы, выбрать пункт «Разрешить сортировку» и нажать ОК.
Затем можно отсортировать данные столбца — эта функция позволит вашим читателям быстрее находить нужную информацию. Например, пользователи смогут отсортировать текст в алфавитном порядке, а числа — от наименьшего к наибольшему.
В этой статье мы рассмотрели некоторые функции ноябрьского релиза Документерры, а именно: импорт файлов Swagger/OpenAPI, предварительный просмотр в режиме читателя и создание сортируемых таблиц. Эти и другие улучшения позволят вам управлять технической документацией еще удобнее!