Как преобразовать документ Word в интерактивную HTML-документацию

Зачем переносить руководство из Word в интерактивный HTML

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

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

Подготовьте DOCX перед импортом

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

Проверьте изображения до импорта. Обрежьте ненужные поля, уменьшите чрезмерно большие скриншоты и добавьте подписи, если смысл не объяснен соседним текстом. Сложные плавающие объекты, текстовые блоки, колонтитулы, сноски и печатная верстка могут потребовать ручного восстановления в HTML.

Импортируйте Word и перестройте страницы

Создайте документ в One File Docs через сценарий импорта Word. Полученное содержимое станет редактируемой основой. Проверьте, как заголовки разделили материал, а затем объедините или разделите его по задачам читателя, не сохраняя каждый разрыв печатной страницы.

Печатная страница и страница документации решают разные задачи. Выделите в ясные разделы установку, быстрый старт, настройку, примеры и устранение неполадок. Сократите повторяющиеся названия и назначьте стабильные идентификаторы до добавления внутренних ссылок. Для длинных разделов включите оглавление по заголовкам.

Проверьте элементы, которые нельзя перенести механически

Универсальное преобразование Word в HTML не может восстановить все дизайнерские решения. Сравните результат с исходником, особенно внимательно проверяя вложенные списки, объединенные ячейки, код, информационные блоки, формулы, подписи изображений и ссылки на закладки.

Замените оформление, имеющее смысл только на бумаге. Указания «смотрите страницу 18» должны стать прямыми ссылками. Широкие таблицы иногда лучше разделить или переписать. Текст на скриншотах по возможности следует заменить обычным текстом, чтобы он оставался доступным для поиска.

• Все заголовки находятся на правильном уровне.
• Списки и таблицы сохранили смысл.
• Изображения читаются при обычной ширине содержимого.
• Внутренние и внешние ссылки ведут к нужным адресам.
• Печатные колонтитулы и номера страниц удалены или заменены.

Экспортируйте новое HTML-руководство

Настройте название документа, оформление, навигацию, поиск и цветовые схемы, затем запустите экспорт. One File Docs упакует просмотрщик и импортированное содержимое в один HTML-файл, который открывается в браузере и может быть опубликован на статическом хостинге.

Проверяйте экспорт отдельно от исходного DOCX. Найдите термины из разных глав, перейдите по ссылкам, просмотрите изображения и измените размер окна браузера. При необходимости сохраните Word как архив, но выберите один редактируемый источник истины для дальнейших обновлений, чтобы версии не расходились.