Илья Жуков - Технический писатель

Знания и технологии бесполезны, если ими не пользоваться в повседневной жизни для решения практических задач. Но пользоваться нужно и хотеть, и учиться. Сегодня из каждого утюга кричат о цифровизации всего, что можно цифровизировать, в том числе образования. Вкладывают миллиарды рублей в разработку разных платформ, порталов и пр. дребедени, которой по факту невозможно пользоваться из-за перегруженности сервисов. И длится это удовольствие уже не второй, и даже не третий год! Вы спросите, какой толк в жизни от программ для разработки документации? А вот какой: каждый может абсолютно бесплатно создать свой электронный учебник, учебное пособие и даже целый учебно-методический комплекс...

1 год назад

Подключение таблицы стилей к проекту Help and Manual

При работе с форматами, основанными на HTML, для оформления контента в документах можно использовать каскадные таблицы стилей, cascading style sheets или CSS. Данная технология также пригодится при изменении стандартных и разработке своих шаблонов документации, skin-файлов. В этой статье я расскажу, как подключить свою таблицу стилей к проекту Help and Manual. Перед подключением файл таблицы стилей необходимо загрузить в файлы проекта, Baggage Files. Так файл таблицы стилей будет всегда экспортироваться в выходные документы (в корневую папку) в форматах HTML Help (CHM), WebHelp, EWriter...

1 год назад

Весеннее обострение CCleaner – лечить или не лечить

Сегодня утром мои компы с Windows 10 успешно обновились. На одном из них после последней чистки я забыл удалить CCleaner. И вот уважаемый золотарь в очередной раз с гордостью сообщил, что в данном месте расположения компьютера он больше не работает. Что называется: никогда не было и вот опять… возникает вопрос, лечить или не лечить. Здесь и далее я опущу обиходные синонимы, обозначающие эту программу-чистильщика. Как я лечу это на Windows 10 Никак. Отключение обновлений в Windows 10 занимает много времени и приносит больше вреда, чем пользы...

1 год назад

Формулы в HTML Help (CHM)

Я по образованию филолог. Специализируюсь на разработке пользовательской документации на английском и русском языках. С формулами в документации сталкиваюсь редко и поэтому придерживаюсь общепринятого подхода: набрал в редакторе формул, вставил в документацию и забыл. Но что делать, если у вас в документации много формул, и их нужно донести до пользователя в формате CHM? И при этом вы хотите, чтобы в проекте формулы были редактируемыми, а в документации выглядели профессионально и так, как вы их набрали...

1 год назад

Импорт документов MS Word в Help+Manual Часто технический писатель получает исходные данные от аналитиков, разработчиков, тестировщиков, маркетологов и других специалистов в форматах DOC, DOCX и RTF (реже, из-за размера файлов). Эти же форматы используются, если у технического писателя или у его коллег временно, например, в дороге, нет доступа к файлу проекта H&M. В этой связи вопрос импорта файлов MS Word в другие программы всегда остается актуальным. Программный комплекс Help and Manual версий 7, 8 и 9 прекрасно импортирует RTF-файлы на русском языке, сохраненные программой MS Word. Перед импортом файлов DOC, DOCX и RTF, сгенерированных в других программах, откройте файлы в программе MS Word и сохраните в формате RTF. Прямой импорт из форматов DOC и DOCX не поддерживается. В большинстве случаев вы получите отличный результат с настройками по умолчанию. Если хотите глубже разобраться с возможностями и настройками импорта RTF-файлов в Help and Manual, на моем сайте вышла статья «Импорт документов MS Word в Help+Manual» . Переходите на сайт, задавайте вопросы в комментариях.

1 год назад

HelpNDoc – руководство пользователя на русском языке

Как и любая программа, HelpNDoc обладает рядом достоинств и недостатков. К неоспоримым достоинствам HelpNDoc можно отнести наличие бесплатной версии, возможность скрыть и удалить рекламные баннеры, документированный API, описание устройства шаблонов выходных документов в форматах CHM (HTML Help) и WebHelp и другие. Среди основных недостатков обычно выделяют отсутствие перевода пользовательского интерфейса на русский язык, а также документации на русском языке. В этой статье я расскажу, почему данные недостатки больше не актуальны...

1 год назад

Если вы разрабатываете пользовательскую документацию и ищете бесплатный аналог Help and Manual и Robohelp, обратите внимание на программу HelpNDoc. Она полностью бесплатна для личного использования. HelpNDoc работает по принципу единого источника и позволяет экспортировать документацию в форматы CHM, WebHelp (HTML), DOCX, RTF, PDF, EPUB, MD, QT и MOBI. API HelpNDoc документирован, что позволяет разрабатывать собственные шаблоны для выходных HTML-документов. Подробная полная инструкция на русском языке с примерами, посвященная разработке документации в HelpNDoc, теперь также доступна в формате электронной книги для Windows. Как настроить проект для использования русского языка? Как подключить русские словари? Как скрыть или удалить рекламные баннеры, не используя нелегальные программы? Как перевести на русский язык стандартные шаблоны? Как создать свой шаблон? Как управлять выгрузкой контента из проекта? Эти и другие вопросы подробно разобраны в книге «Разработка документации в HelpNDoc». Книга написана на основе личного 7-летнего опыта работы с HelpNDoc. С подробной информацией о книге можно ознакомиться по ссылке: help-spravka.ru/...l.. #пользовательскаядокументация, #helpandmanual, #robohelp, #helpndoc, #инструкциянарусском, #CHM, #Webhelp, #htmlhelp, #usermanual #Какнастроитьпроектдляиспользованиярусскогоязыка, #Какподключитьрусскиесловари, #Какскрытьилиудалитьрекламныебаннеры, #Какперевестинарусскийязыкстандартныешаблоны, #Каксоздатьсвойшаблон, #Какуправлятьвыгрузкойконтентаизпроекта

1 год назад

Выбрав русский язык и русскую кодировку в настройках проекта #HelpandManual, многие авторы после первой сборки удивляются, увидев в выходных документах английские слова. Они есть во всех форматах: #CHM, #WebHelp, #DOCX, #PDF. Возникает вопрос: как локализовать выходные документы в #HelpandManual, чтобы в них всё было на русском языке. Подробный ответ смотрите в статье Перевод выходных документов в Help and Manual help-spravka.ru/...e.. #локализация, #helpandmanual #webhelp #docx #pdf #настройкиCHM #help #документация #техническийписатель #technicalauthor #справка #помощь #technicalwriter, #localization

1 год назад

Как задать размер и расположение окна CHM для первого запуска? Где задаются эти настройки и как работают. Подробное описание смотрите в статье "Размер и расположение окна CHM при первом запуске" help-spravka.ru/...p.. #helpandmanual#helpndoc#htmlhelpworkshop#настройкиCHM#help#документация#техническийписатель#technicalauthor#справка#помощь

1 год назад

Кто занимается разработкой пользовательской документации, знает, что #КлючевыеСлова составляют #ПредметныйУказатель и позволяют читателю быстро найти в документе нужную информацию. Без предметного указателя #ПользовательскаяДокументация не может считаться качественной. Предлагаю пользователям #HelpandManual подробную #инструкцию по работе с ключевыми словами на русском языке. Подходит для Help+Manual версий 5, 6, 7, 8 и 9. Ключевые cлова в Help+Manual - help-spravka.ru/...s..

1 год назад

Вы не задумывались, почему некоторые тексты читаются на одном дыхании, а через другие приходится продираться? Почему одна статья запоминается на лету, как бы сама собой, а чтобы запомнить другую, ее приходится конспектировать и повторять миллион раз? Как думаете, дело в таланте автора? В силе текста? В правде? Многие ответят: конечно, да! Но это только часть правды. У текста есть и другая, формальная сторона, которая не менее важна, чем содержательная. В статье «Закон построения нехудожественного текста» help-spravka.ru/...e.. вы узнаете о правиле «семь плюс-минус два». Если его соблюдать, ваши тексты будут легче читаться и быстрее запоминаться. "А верите вы в него, или нет — не важно. Главное, чтобы это работало".

1 год назад

Кто пишет справку и пользовательскую документацию, знает, что такое Help&Manual и RoboHelp. За 30 лет существования эти программные комплексы стали стандартами средств разработки справки. Сегодня покупка лицензии Help&Manual и RoboHelp для большинства отечественных разработчиков документации стала практически не реальной. Существуют платные и бесплатные отечественные и зарубежные аналоги. Самыми популярными, на мой взгляд, являются Dr.Explain, HelpSmith и HelpNDoc. Краткие обзоры этих программ можно посмотреть на сайте help-spravka.ru в следующих статьях: - Dr.Explain — отечественная программа для разработки справки help-spravka.ru/...x.. - HelpSmith — достойная альтернатива Help+Manual help-spravka.ru/...s.. - HelpNDoc — бесплатная альтернатива Help+Manual help-spravka.ru/...n..

1 год назад