Уважаемые коллеги!
Когда начинаешь заниматься чем-то новым, тратишь много времени на поиск качественной информации: статьи по теме, книги, справочники, обучающие материалы и т.п. При этом в начале пути сложно понять, «то это или не то». Чтобы начинающему техническому писателю было от чего оттолкнуться, рекомендую следующие книги, инструменты и онлайн-сервисы.
Книги по специальности
Кагарлицкий Ю.В. Разработка документации пользователя программного продукта
Кагарлицкий Ю.В. Разработка документации пользователя программного продукта. Методика и стиль изложения. — 2-е изд., испр. и доп. — М.: ООО «Философт Сервисы», 2012. — 232 с.
Заказать можно здесь.
Гультяев А.К. Help. Разработка справочных систем
Гультяев А.К. Help. Разработка справочных систем: учебный курс. СПб., 2004. - 269 с.
Зинсер У. Как писать хорошо
Зинсер У. Как писать хорошо. Классическое руководство по написанию нехудожественных текстов.
М., 2016. - 292 с.
Программы
Help+Manual — программный комплекс для разработки справки и технической документации в различных форматах. Помимо редактора, в его состав входят:
- Screen Capture Tool – средство создания скриншотов;
- Impict Image Editor – редактор рисунков;
- Print Manual Designer – редактор шаблонов для PDF-документов.
- Средства проверки правописания, создания контекстной справки и другие.
Лучшее решение для создания пользовательской документации
Help & Manual — это незаменимый инструмент для программистов, а также для тех, кто занимается русификацией документации. Работать с программой не сложнее, чем с обычным офисным приложением, а количество форматов, в которых можно сохранить результаты, позволяет использовать её практически в любых условиях.
FastStone Capture — простая и функциональная программа для создания и редактирования скриншотов
(есть портативная версия). Сайт разработчика программы.
FastStone Image Viewer — программа для просмотра рисунков в OC Windows (бесплатная для домашнего использования). Сайт разработчика программы.
Сервисы
Грамота.ру
Cправочно-информационный портал «Русский язык», онлайн-справочник по русскому языку для работников СМИ и Интернет-пользователей.
Главред.ру
Сервис проверки нехудожественных текстов (очистка от словесного мусора, проверка синтаксиса). Но не увлекайтесь, думайте самостоятельно!
Текст.ру
Бесплатный сервис проверки текста на уникальность (поиск дубликатов и орфографических ошибок). Не увлекайтесь, думайте самостоятельно.
