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

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

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

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

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

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

Кагарлицкий Ю.В. Разработка документации пользователя программного продукта. Методика и стиль изложения. — 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правочно-информационный портал «Русский язык», онлайн-справочник по русскому языку для работников СМИ и Интернет-пользователей.

Главред.ру

Главред.ру

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

Текст.ру

Текст.ру

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

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

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

Создание 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. Сегодн...

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

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

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

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

Как повысить качество текста инструкций

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

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

Закон построения нехудожественного текст…

Вы не задумывались, почему некоторые тексты читаются на одном дыхании, а через другие приходится продираться? Почему одна статья запоминается на лету, как бы сама собо...

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

Примечания и предупреждения в тексте инс…

Важную информацию в тексте можно выделять по-разному. Можно целые предложения оформлять жирным, подчеркнутым и курсивным шрифтом. Можно написать все слова в предложени...

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

Методика чтения научных книг

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

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

Книга «Пиши, сокращай: как создавать сил…

Наводя порядок в книжном шкафу, нашел книгу Максима Ильяхова и Людмилы Сарычевой «Пиши, сокращай: как создавать сильный текст». Я прочитал ее летом 2018 года, но отзыв...

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

Как починить поиск в русском PDF

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

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

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

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

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

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

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

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

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

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

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