eWriting. Обзор технологического процесса

Что такое eWriting?
eWriting — это технология быстрого и качественного документирования, позволяющая создавать документацию, удовлетворяющую мировым стандартам.
eWriting — это проверенная на практике технология, позволяющая неподготовленным людям создавать пользовательскую, проектную и рекламную документацию высокого уровня.
eWriting — это шаблоны презентаций, White Papers, проектной документации, а также инструкции и шаблоны для создания справок.

Шаблоны и стили
Печатные документы создаются в Microsoft Word. Для каждого вида документа предназначен специальный шаблон. Технология eWriting предусматривает наличие единого набора стилей во всех шаблонах. Это необходимо для правильной переносимости текста между документами разных видов.
Например, при копировании текста из печатного руководства в DOC-файл, являющийся источником для создания справки, текст мгновенно меняет свое форматирование в соответствии с требованиями к форматированию справок.

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

eWriting. Технологический процесс
Процесс создания документов состоит из следующих шагов:
Анализ технических спецификаций
Создание папки руководства
Написание руководства
Создание PDF-файла
Создание справки

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

Создание папки руководства
Анализ спецификаций
Создание папки руководства
Написание руководства
Создание PDF-файла
Создание справки
Этапы

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

Создание PDF-файла
Итоговые документы преобразовываются в формат Adobe PDF, потому что:
Документы Word могут иметь различный вид в зависимости от настроек принтера.
Документы Word не всегда корректно работают с графикой.

Создание справки
Справки создаются на основе печатных руководств. Руководства перед созданием справок специальным образом редактируются. Справки по технологии eWriting создаются в RoboHELP Office. Процесс подготовки печатных документов и использование RoboHELP детально описаны в руководстве по использованию технологии.