Блог технического писателя Ильи Жукова

Форматы электронной документации CHM, WebHelp и EWriter давно используются для создания и распространения электронных книг и учебников. Разработать такое учебное пособие можно в бесплатной программе, например, HelpNDoc. Чтобы пользоваться таким учебником, установка дополнительного ПО не требуется — достаточно операционной системы Windows и веб-браузера. В электронном учебнике наряду с текстом, рисунками и видео можно использовать и другие мультимедийные материалы, например упражнения и тесты. Они пригодятся для тренировки навыков и оценки знаний. В этой статье я расскажу, как бесплатно создать и добавить тест в электронную книгу в формате CHM, WebHelp и EWriter.

Рисунки в проекте Help and Manual можно единообразно оформить тремя способами. Во-первых, это можно сделать в графическом редакторе, например в Impict. Во-вторых, для рисунка можно создать стиль в редакторе стилей. Эта возможность доступна, начиная с версии 9. В этой статье я расскажу о третьем способе единообразного оформления рисунков в проекте Help and Manual – при помощи пользовательского CSS-класса. Его можно реализовать в любой версии Help+Manual, в том числе, 7, 8 и 9.

При работе с форматами, основанными на HTML, для оформления контента в документах можно использовать каскадные таблицы стилей, cascading style sheets или CSS. Данная технология также пригодится при изменении стандартных и разработке своих шаблонов документации, skin-файлов. В этой статье я расскажу, как подключить свою таблицу стилей к проекту Help and Manual.

Я по образованию филолог. Специализируюсь на разработке пользовательской документации на английском и русском языках. С формулами в документации сталкиваюсь редко и поэтому придерживаюсь общепринятого подхода: набрал в редакторе формул, вставил в документацию и забыл. Но что делать, если у вас в документации много формул, и их нужно донести до пользователя в формате CHM? И при этом вы хотите, чтобы в проекте формулы были редактируемыми, а в документации выглядели профессионально и так, как вы их набрали. В этой статье я расскажу, как подключить js-библиотеку MathJax в HTML Help (CHM).

Часто технический писатель получает исходные данные от аналитиков, разработчиков, тестировщиков, маркетологов и других специалистов в форматах DOC, DOCX и RTF (реже, из-за размера файлов). Эти же форматы используются, если у технического писателя или у его коллег временно, например, в дороге, нет доступа к файлу проекта H&M. В этой связи вопрос импорта файлов MS Word в другие программы всегда остается актуальным. В этой статье я расскажу о возможностях программы Help+Manual по импорту файлов MS Word.

Форматы документов MS Word - DOC, DOCX и RTF - являются сегодня самыми распространенными и популярными форматами, в которых можно сохранять документы и обмениваться ими. По сравнению с упрощенными визуальными редакторами текста, работать с документами в MS Word комфортней. За время своего существования MS Word стал не только стандартом работы с документами, но и делом привычки. Ни социально-исторический контекст, ни возможность перехода на бесплатные «аналоги» не влияют на популярность форматов MS Word. В этой статье я расскажу о возможностях программы HelpNDoc по импорту документов MS Word.

Как и любая программа, HelpNDoc обладает рядом достоинств и недостатков. К неоспоримым достоинствам HelpNDoc можно отнести наличие бесплатной версии, возможность скрыть и удалить рекламные баннеры, документированный API, описание устройства шаблонов выходных документов в форматах CHM (HTML Help) и WebHelp и другие. Среди основных недостатков обычно выделяют отсутствие перевода пользовательского интерфейса на русский язык, а также документации на русском языке. В этой статье я расскажу, почему данные недостатки больше не актуальны.

Последние статьи

Как вставить тесты в CHM и WebHelp…

Форматы электронной документации CHM, WebHelp и EWriter давно используются для создания и распространения электронных книг и учебников. Разработать такое учебное пособ...

Читать полностью...

Оформление рисунков в Help+Manual при по…

Рисунки в проекте Help and Manual можно единообразно оформить тремя способами. Во-первых, это можно сделать в графическом редакторе, например в Impict. Во-вторых, для ...

Читать полностью...

Подключение таблицы стилей к проекту Hel…

При работе с форматами, основанными на HTML, для оформления контента в документах можно использовать каскадные таблицы стилей, cascading style sheets или CSS. Данная т...

Читать полностью...

Формулы в HTML Help (CHM)

Я по образованию филолог. Специализируюсь на разработке пользовательской документации на английском и русском языках. С формулами в документации сталкиваюсь редко и по...

Читать полностью...

Импорт документов MS Word в Help+Manual…

Часто технический писатель получает исходные данные от аналитиков, разработчиков, тестировщиков, маркетологов и других специалистов в форматах DOC, DOCX и RTF (реже, и...

Читать полностью...

Поиск в WebHelp находит удаленные раздел…

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

Читать полностью...

Контекстная справка в приложениях Window…

Понятие контекстной или контекстно-зависимой справки (от англ. context-sensitive help) появилось в 1987 году с выходом формата WinHelp. Изначально контекстная справка ...

Читать полностью...

Как поддерживать скриншоты в актуальном …

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

Читать полностью...

Книга «Разработка технической документац…

Уважаемые коллеги! Если вам нужно быстро освоить разработку документации по ГОСТ, рекомендую обратить внимание на книгу В.А. Глаголева «Разработка технической документ...

Читать полностью...

Перевод выходных документов в Help and M…

Выбрав русский язык и русскую кодировку в настройках проекта Help and Manual, многие авторы после первой сборки удивляются, увидев в выходных документах английские сло...

Читать полностью...

Размер и расположение окна CHM при перво…

Разработчик справки в формате CHM может задать размер и расположение окна, которые будут использоваться при первом запуске CHM-файла. После того, как пользователь пере...

Читать полностью...

Рваные края скриншотов в Help and Manual…

Многие платные редакторы скриншотов, например, SnagIt, FastStone Capture и др., умеют создавать эффект рваных краев. В сети Интернет можно найти множество видеоуроков ...

Читать полностью...
новое в Help and Manual 9

Новое в Help and Manual 9

23 ноября 2022 года компания EC Software к 25-летнему юбилею выпустила 9-ю версию программного комплекса Help and Manual (выходит c 1997 года). Комплект шаблонов Premi...

Читать полностью...

Создание CHM-справки в бесплатной програ…

KEL CHM Creator — это «новая» хорошо забытая программа, выпущенная в 2012 году, предназначенная для создания и декомпиляции CHM-файлов. Программа не требовательна к ре...

Читать полностью...

KEL CHM Creator — бесплатная программа д…

Если вам нужно создать CHM-файл, и вы больше не хотите пользоваться глючной программой HTML Help Workshop, тогда KEL CHM Creator — это ваш вариант. Программа позволяет...

Читать полностью...
ключевые слова

Ключевые слова в Help+Manual…

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

Читать полностью...

Все о справке и документации для пользователей!

Следить за новыми статьями:

© Илья Жуков, 2019-2024. Охраняется законом об авторском праве.