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

В справке и пользовательской документации маркированные и нумерованные списки используются для структурирования информации и для оформления пошаговых инструкций. Чтобы повысить наглядность документации, маркеры в списках можно выделить жирным или цветным шрифтом. Такое оформление сделает процедуры и другую структурированную информацию более заметной. В данной статье я расскажу, как выделить маркеры списков в Help&Manual 5, 6 и 7. Материал также пригодиться дизайнерам: при разработке макетов документации хорошо знать о стандартных возможностях инструментов технического писателя.

Итак: список неиспользуемых рисунков составлен, но в Help&Manual 5 и 6 нет функции их автоматического перемещения в отдельную папку. Так как же их автоматически удалить? Очень просто: нужно скопировать список неиспользуемых рисунков из полного отчета в буфер обмена, вставить в текстовый редактор, заменить в списке кое-что при помощи функции поиска и замены и сохранить список как BAT-файл, который удалит все файлы. Рассмотрим данный способ подробнее.

С выпуском новых версий в приложениях исправляют ошибки, добавляют новый функционал, а также корректируют графический пользовательский интерфейс. Бывает и так, что дизайн пользовательского интерфейса меняется полностью, например, при переходе от объемного дизайна к плоскому. Во время обновления пользовательской документации технический писатель не только вносит изменения в текст, но и обновляет скриншоты. Обычно это десятки рисунков, в крупных проектах — сотни и тысячи. В одном проекте, который я обновлял, справка для программного комплекса ГОССТРОЙСМЕТА 2.0, было 1467 скриншотов. В другом проекте, справка для МойОфис Частное Облако, — ровно 1000.

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

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

10 февраля 2020 года вышла 8-я версия Help+Manual. Любой желающий может бесплатно скачать пробную версию с сайта компании-разработчика и оценить ее потенциал. В течени...

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

Работа со стилями в Help and Manual 7

Чтобы внешний вид нового CHM-файла соответствовал оригиналу, необходимо создать стили, применить их к проекту и очистить встроенное форматирование. Это позволит обеспе...

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

Форматы справки для ОС Linux

В рамках замещения импортного программного обеспечения все больше государственных структур переходят на отечественные сборки Linux. Прежде всего, это Alt Linux и Astra...

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

Сборка CHM-файла в Help and Manual

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

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

Основные настройки проекта в Help and Ma…

Если для сборки справки не используется шаблон (skin-file), внешний вид и основной функционал CHM-справки берется из настроек проекта. В этой статье я расскажу о том, ...

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

Импорт CHM в Help and Manual

Программный комплекс Help and Manual позволяет импортировать документацию из ряда форматов, в том числе, из HTML и CHM. Готовую документацию можно загрузить как в суще...

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

Как отредактировать CHM в Help and Manua…

Если вам нужно внести несколько небольших правок в CHM-файл, такую задачу можно успешно решить при помощи бесплатных программ HTML Help Workshop и Notepad++. Серьезная...

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

Как сделать качественные скриншоты

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

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

Внесение изменений и сборка нового CHM-ф…

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

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

Создание и настройка проекта в HTML Help…

Установив необходимые бесплатные программы, мы разобрали исходный файл api.chm и получили 64 файла (подробнее смотрите материал Декомпиляция CHM-файла). Это основная ч...

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

Декомпиляция CHM-файла

Файл в формате CHM представляет собой скомпилированный HTML. В него могут входить HTML-страницы, рисунки, таблицы стилей, скрипты и другие файлы. Подробное описание со...

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

Редактирование CHM бесплатными программа…

Если заказчику или работодателю не принципиально, какое программное обеспечение использовать, я предпочитаю редактировать CHM в Help+Manual 7. Но как показывает практи...

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

Как отредактировать CHM-файл

Пользовательская документация для приложений, работающих в ОС Windows, чаще всего поставляется в формате CHM как встроенная в программу справка. Технические писатели, ...

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

Как создать справку в формате CHM

Формат HTML Help или CHM был разработан компанией Microsoft в 1997 г. Сегодня CHM остается стандартом справки для приложений, работающих в ОС Windows. Средство для про...

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

Бесплатный локальный сервер HM2GO для We…

Одна из моих предыдущих статей была посвящена особенностям работы WebHelp на локальных компьютерах. Некоторые популярные браузеры, в том числе Google Chrome, Opera и Я...

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

Дата в полном формате с месяцем в родите…

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

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

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

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

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