Документерра позволяет вам выполнять "миграцию" вашего контента из множества различных приложений, импортируя ваш контент в различных форматах. Они включают HTML, MS Word, Confluence, MadCap Flare, RoboHelp и многое другое. Полный список поддерживаемых форматов приведен ниже.
"Миграция" контента - это полный процесс переноса вашей документации из одного приложения в другое. Он начинается с поиска подходящего приложения и заканчивается, когда весь ваш контент готов к использованию в новом приложении. Он состоит из множества этапов, включая процесс импорта, подготовку содержимого до и редактирование содержимого после импорта и т.д.
| Если у вас есть вопросы, вам нужна помощь в миграции или вы хотите импортировать пользовательский/неподдерживаемый формат, наша команда будет рада помочь! Свяжитесь с нами по адресу support@documenterra.ru. |
Если вы хотите сразу перейти к действию, вы можете следовать инструкциям по импорту из разных приложений (руководства по импорту из определенных форматов находятся чуть ниже):
Confluence
RoboHelp
MadCap Flare
Paligo
Archbee
Help+Manual
ZenDesk
HelpNDoc
Document360
Author-it
GitBook
ReadMe
Но если вы хотите узнать больше о переносе документации в Документерру и о том, как работает процесс импорта в нашем приложении, продолжайте читать.
Поиск подходящего и совместимого приложения
Каждый процесс переноса начинается с поиска приложения, которое может импортировать имеющуюся у вас документацию и соответствует вашим требованиям. Здорово, что вы нашли такое! Документерра поддерживает множество форматов для импорта, поэтому не должно возникнуть никаких проблем с переносом контента из самых популярных приложений для создания документации.
Если вы хотите перейти на Документерру, используя неподдерживаемый формат, вы всегда можете связаться с нами через sales@documenterra.ru. Наша команда по миграции будет рада найти возможность облегчить вам процесс переноса документации!
Прежде чем загружать весь свой контент, было бы неплохо взглянуть на наше приложение в действии. Вы можете заказать демонстрацию и получить бесплатную пробную версию, чтобы ознакомиться с Документеррой.
Подготовка содержимого перед импортом
Поскольку вы переходите к приложению для создания документации, основанному на принципе "одна статья — одна тема", вам может потребоваться потратить некоторое время на реструктуризацию вашего контента, особенно если вы используете приложение, основанное на другом принципе, такое как MS Word. Не стесняйтесь экспериментировать и попробовать импортировать свой контент, чтобы посмотреть, как он будет выглядеть после импорта. Так вы можете получить представление о том, как структурировать свой контент в вашем текущем приложении для достижения наилучших результатов.
Мы также рекомендуем ознакомиться с некоторыми из следующих разделов, в зависимости от формата файла, который вы используете для импорта в Документерру:
Прежде чем импортировать контент, продумайте его будущую структуру. Потому что в Документерре, в дополнение к возможности группировать ваши статьи под родительским элементом дерева статей, вы можете разделить контент на разные проекты.
Не забудьте проверить содержимое и удалить документы и файлы, которые вам не нужно переносить.
Процесс импорта
Импорт - это автоматизированный процесс, который берет ваш контент в любом поддерживаемом формате и переносит его в Документерру. Это может быть отдельная операция или часть процесса "миграции". Импорт, являющийся частью миграции, значительно ускоряет процесс, поскольку избавляет вас от необходимости копировать и вставлять содержимое вручную. Мы рекомендуем всегда проверять ваш контент после импорта, чтобы убедиться, что он правильно перенесен.
Документерра поддерживает следующие форматы для импорта:
|
Формат файла
|
Описание
|
|---|---|
|
Файл CHM
|
Формат файлов контекстной справки, разработанный корпорацией Microsoft (Microsoft Compiled HTML Help). Рекомендуемый формат.
|
|
HTML/XHTML/заархивированный Web Help
|
Разметка страниц, изображения, стили и скрипты в одном ZIP-архиве.
|
|
DOC или DOCX
|
Файл Microsoft Word. |
|
Файл RTF
|
Межплатформенный формат хранения текстовых документов с форматированием (Rich Text Format).
|
|
Файл ODT
|
Открытый формат документов для офисных приложений (OpenDocument, OpenOffice.org).
|
|
YAML, YML или JSON
|
Форматы сериализации данных (OpenAPI).
|
|
Файл PDF |
Файл Adobe Portable Document Format.
|
Если у вас есть возможность выбрать, в каком формате экспортировать вашу документацию, вот несколько заметок, которые могут помочь вам выбрать наилучший из них:
- Рекомендуемый формат — CHM, поскольку его внутренняя структура основана на HTML, что обеспечивает наилучшие результаты импорта. В процессе импорта сохраняется структура оглавления, ключевые слова, стили и скрипты исходного документа. Чтобы узнать больше, обратитесь к этому разделу: Импорт из CHM.
- Формат WebHelp содержит дополнительные файлы, такие как навигация, скрипты и тому подобное, поэтому, если вы импортируете файл WebHelp, вам потребуется поработать с форматированием до и после импорта — удалить ненужные HTML-файлы, такие как основные страницы или страницы поиска. Более того, обычно страницы со статьями хранятся в одной папке в архиве WebHelp, поэтому после импорта они будут находиться на одном уровне в дереве страниц, и вам придется реорганизовать их вручную. Это легко сделать просто перетаскивая страницы в самом дереве страниц. Чтобы узнать больше об импорте из формата WebHelp или другого HTML-подобного формата, обратитесь к этому разделу: Импорт из HTML.
- Формат MS Word сильно отличается от онлайн-форматов, поэтому после импорта вы можете заметить небольшие различия в стилях. Документерра выполнит обработку стилей, чтобы упростить обслуживание импортированного содержимого в будущем. Чтобы узнать больше, обратитесь к этому разделу: Импорт из Microsoft Word.
Вы можете найти ссылки на подробное описание процесса импорта в зависимости от формата файла, который вы используете, выше.
Проверка содержимого после импорта
После завершения импорта содержимого мы рекомендуем выполнить несколько действий:
- Просмотрите свой контент и проверьте, все ли содержимое было перенесено правильно. Исправьте там, где это необходимо.
- Замените элементы, созданные вашим прежним приложением (списки связанных статей, навигационные элементы следующий/предыдущий, нижние и верхние колонтитулы), на элементы, предлагаемые Документеррой. Вы можете использовать глобальный поиск и замену, чтобы найти и удалить (или заменить) эти элементы сразу по всему порталу.
- Убедитесь, что контент структурирован в соответствии с вашими потребностями. Реструктурируйте его, если это необходимо.
| Хотя в большинстве случаев достаточно выполнить операцию импорта существующего контента, чтобы оказаться в шаге от доставки контента читателям, чем лучше структурирован ваш унаследованный контент, тем лучше результаты импорта. |