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

качество текста

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

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

Вряд ли кто-то считает тестирование справки хоть сколько-нибудь сложной задачей. Тестирование документации вообще очень редко упоминается в профильной литературе. Многие скажут: а что тут сложного? Открыл справку, сравнил описание с тем, как работает программа, и всё! А потом приходится читать замечания, написанные так, как будто их писали люди, вообще не имеющие представления о том, что такое справка, где и как она должна работать. Попробуем разобраться, как добиться корректной работы справки в формате WebHelp на локальном компьютере, и какие средства можно для этого использовать.

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

Что нового в Help+Manual 10

21 сентября 2025 года вышла 10-я версия Help and Manual. Комплект шаблонов Premium Pack был обновлен немного позже, в начале 2026 года, до актуальной версии 6. Програм...

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

5 способов декомпиляции CHM-файлов…

CHM-файл не редактируется напрямую, это архив LZX. Часто возникают ситуации, когда исходного файла проекта нет, а CHM нужно обновить или перевести на иностранный язык...

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

Вызов разделов CHM-справки…

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

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

Настройка окна справки в формате EWriter…

EWriter — это формат справки и электронных книг для Windows от разработчика Help+Manual, компании EC Software. Несмотря на то, что формат EWriter не так популярен, как...

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

Книга «Документирование программного обе…

Книга Татьяны Анатольевны Макаровских представляет собой реферативную подборку материалов, посвященных документированию программных средств. Данное учебное пособие адр...

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

Книга «Профессия технический писатель ил…

Если вы ничего не знаете ни о технических писателях, ни о технической документации, эта книга для вас! Книга Михайлова А.В. идеально подойдет студентам-технарям или ст...

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

Как вставить тесты в 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, многие авторы после первой сборки удивляются, увидев в выходных документах английские сло...

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

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

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

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