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

Полезные советы

12 марта 2024

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

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

Полезные советы

28 января 2024

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

Во время поддержки проекта справки со временем ряд разделов устаревает. Вы исключаете их из сборки, возможно, даже удаляете из проекта. Собираете выходную документацию WebHelp — в содержании удаленных разделов нет. Но поиск в WebHelp находит удаленные разделы. Из результатов поиска их можно открыть. В этой статье я расскажу, почему так происходит, и как решить эту проблему на примере программ Help and Manual и HelpNDoc.

Полезные советы

17 мая 2023

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

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

Полезные советы

16 апреля 2023

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

Я не люблю брать в руки разрисованные книги. Текст исчиркан, подчеркнут, зачеркнут. Ручкой, карандашом, маркером. Уголки страниц загнуты. На полях рукописные пометки, кляксы и другая грязь. В этой статье я расскажу о методике чтения нехудожественной литературы, которая позволяет оставить книгу после себя чистой.

Полезные советы

28 января 2022

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

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

Help+Manual

15 января 2022

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