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

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

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

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

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

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

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

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

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

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

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

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

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

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

Программы

Help+Manual 7

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

  • Screen Capture Tool – средство создания скриншотов;
  • Impict Image Editor – редактор рисунков;
  • Print Manual Designer – редактор шаблонов для PDF-документов.
  • Средства проверки правописания, создания контекстной справки и другие.
Актуальные версии: 7, 8, 9 (вышла 23.11.2022).

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

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

 

Программа Help & Manual ... в наше время считается одним из лучших продуктов для создания справочных систем и руководств.

Help & Manual — это незаменимый инструмент для программистов, а также для тех, кто занимается русификацией документации. Работать с программой не сложнее, чем с обычным офисным приложением, а количество форматов, в которых можно сохранить результаты, позволяет использовать её практически в любых условиях.

Блог Записки журналиста-программиста
Image

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

Image

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

Сервисы

Грамота.ру

Грамота.ру

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

Главред.ру

Главред.ру

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

Текст.ру

Текст.ру

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

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

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

Поиск в 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…

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

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

HTML Help Workshop – бесплатная программ…

В 1997 году Microsoft выпустила новый формат справки, HTML Help (CHM), а также бесплатную программу для создания и редактирования справки в этом формате — HTML Help Wo...

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

HelpNDoc — бесплатная альтернатива Help+…

Еще одной альтернативой RoboHelp и Help&Manual является программа HelpNDoc от французского разработчика, компании IBE Software. Это практически полный аналог HelpS...

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

HelpSmith — достойная альтернатива Help+…

Продолжая тему средств разработки справки и пользовательской документации, нельзя не рассказать о программе HelpSmith. Она работает по принципу единого источника и под...

Читать полностью...
отечественная программа для разработки справки

Dr.Explain — отечественная программа для…

За почти 30-летнюю историю существования RoboHelp и Help&Manual стали стандартом средств разработки справки и пользовательской документации в среде Windows. Сегодн...

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

Как вычитать свой текст: инструкция для …

В идеале любой технический текст кроме автора должен прочитать хотя бы один редактор и хотя бы один корректор. На практике дело ограничивается одним нормоконтролером и...

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

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

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

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