Рекомендую книги, инструменты, сервисы

Уважаемые коллеги!

Когда начинаешь заниматься чем-то новым, тратишь много времени на поиск качественной информации: статьи по теме, книги, справочники, обучающие материалы и т.п. При этом в начале пути сложно понять, «то это или не то». Чтобы начинающему техническому писателю было от чего оттолкнуться, рекомендую следующие книги, инструменты и онлайн-сервисы.

Книги по специальности

Кагарлицкий Ю.В. Разработка документации пользователя программного продукта

Кагарлицкий Ю.В. Разработка документации пользователя программного продукта

Кагарлицкий Ю.В. Разработка документации пользователя программного продукта. Методика и стиль изложения. — 2-е изд., испр. и доп. — М.: ООО «Философт Сервисы», 2012. — 232 с.

Заказать можно здесь.

Гультяев А.К. Help. Разработка справочных систем

Гультяев А.К. Help. Разработка справочных систем

Гультяев А.К. Help. Разработка справочных систем: учебный курс. СПб., 2004. - 269 с.

Зинсер У. Как писать хорошо

Зинсер У. Как писать хорошо

Зинсер У. Как писать хорошо. Классическое руководство по написанию нехудожественных текстов.
М., 2016. - 292 с.

Программы

Help+Manual 7

Help+Manual 7 — программный комплекс для разработки справки и технической документации в различных форматах. Помимо редактора, в его состав входят:

  • Screen Capture Tool – средство создания скриншотов;
  • Impict Image Editor – редактор рисунков;
  • Print Manual Designer – редактор шаблонов для PDF-документов.
  • Средства проверки правописания, создания контекстной справки и другие.

Лучшее решение для создания справки

Если у вас всё ещё есть вопрос, а как же создавать сами файлы справки, то я вам рекомендую воспользоваться программой Help & Manual - это лучшее решение для создания справки в форматах HLP, CHM, HXS, PDF, HTML, RTF и E-book.
Блог GunSmoker-a
Image

FastStone Capture — простая и функциональная программа для создания и редактирования скриншотов
(есть портативная версия). Сайт разработчика программы.

Image

FastStone Image Viewer — программа для просмотра рисунков в OC Windows (бесплатная для домашнего использования). Сайт разработчика программы.

Сервисы

Грамота.ру

Грамота.ру

Cправочно-информационный портал «Русский язык», онлайн-справочник по русскому языку для работников СМИ и Интернет-пользователей.

Главред.ру

Главред.ру

Сервис проверки нехудожественных текстов (очистка от словесного мусора, проверка синтаксиса). Но не увлекайтесь, думайте самостоятельно!

Текст.ру

Текст.ру

Бесплатный сервис проверки текста на уникальность (поиск дубликатов и орфографических ошибок). Не увлекайтесь, думайте самостоятельно.

Пример хорошей документации

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

Что нового в 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. Охраняется законом об авторском праве.