План развития

Этот раздел показывает ближайшие направления развития One File Docs.

Импорт из HTML

Импорт HTML поможет забирать готовые страницы, статьи и старые справочные материалы из существующих сайтов, лендингов или экспортов других систем.

Это ускорит миграцию уже опубликованного контента в One File Docs и позволит дальше поддерживать его в одном месте.

Поддержка API для других языков и REST-сервисов

Отдельное направление развития - расширить текущую поддержку API, которая сейчас ориентирована на C#, на другие языки программирования и внешние REST-интеграции.

Сюда входят стабильные HTTP endpoints, предсказуемые JSON-форматы запросов и ответов, примеры для популярных языков, а также сценарии для backend-сервисов, CI/CD, генераторов контента, внутренних порталов и других автоматизаций без жёсткой привязки к одному стеку.

Это позволит встраивать One File Docs в существующие процессы команд, быстрее подключать внешние системы и использовать сервис как универсальный documentation backend.

Импорт из OpenAPI и Swagger

Импорт из OpenAPI и Swagger поможет быстрее собирать API Reference и связанную документацию на основе уже существующих спецификаций.

Такой импорт должен уметь забирать endpoints, методы, параметры, request и response schemas, описания, коды ошибок и группировку по тегам, чтобы команда не дублировала одну и ту же структуру вручную.

Это особенно полезно для REST API, внутренних платформ и публичных developer portals, где спецификация уже является источником истины и должна превращаться в читабельную документацию с минимальной ручной доработкой.

Динамический контент на основе JSON

Динамические разделы уже принимают встроенный JSON схемы 1.0 и создают корневую страницу, вложенные страницы, навигацию и переиспользуемые ресурсы внутри экспортированного viewer.

Это полезно для сценариев, где структура документа не фиксирована заранее: например, для атласа примеров, каталога интеграций, галереи кейсов или справочника сущностей, страницы которого меняются между export.

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

Система плагинов для типовых задач

Плагин-система поможет выносить повторяющиеся рабочие сценарии в готовые расширения вместо ручной сборки каждого документа с нуля.

Это особенно полезно для типовых задач: стандартные блоки onboarding, повторяющиеся integration guide, брендированные шаблоны, подключение аналитики, PrismJS, feedback-виджеты, embed-сценарии, экспортные пресеты и другие часто используемые настройки.

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

ИИ-инструменты для работы с текстом

ИИ-функции помогут быстрее готовить и улучшать текст прямо в editor без постоянного переключения между внешними сервисами и документом.

В первую очередь сюда входят переписывание фрагментов, сокращение длинных section, исправление формулировок, улучшение структуры, генерация черновиков и адаптация текста под формат инструкции, help-статьи, onboarding или product documentation.

Это особенно полезно для команд, которые часто обновляют документацию, приводят тексты к единому стилю или быстро собирают первую версию материала перед ручной доработкой.

Поделиться идеями и потребностями

Если вам не хватает какой-то возможности, напишите нам со своей идеей, сценарием использования или рабочей потребностью. Такие сообщения помогают лучше понимать, что добавлять в продукт дальше.

Перейти в контакты