Что такое One File Docs

One File Docs — это сервис для создания интерактивной многостраничной документации, которая собирается в один HTML-файл.

Основная идея

Внутрь итогового файла встраиваются страницы, изображения, стили, скрипты и навигация. В результате получается не статичный документ, а цельная документация, которая остается многостраничной, открывается в браузере и ведет себя как небольшой documentation-site, но при этом существует как один файл.

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

Типовые сценарии

продуктовая документация и релизные материалы
onboarding-документы, обучающие сценарии и интерактивные гайды
инструкции, manuals и support-материалы
внутренние базы знаний, которые удобно передавать как единый HTML-файл