Во время поддержки проекта справки со временем ряд разделов устаревает. Вы исключаете их из сборки, возможно, даже удаляете из проекта. Собираете выходную документацию WebHelp — в содержании удаленных разделов нет. Но поиск в WebHelp находит удаленные разделы. Из результатов поиска их можно открыть. В этой статье я расскажу, почему так происходит, и как решить эту проблему на примере программ Help and Manual и HelpNDoc.

Полезные советы

17 мая 2023

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

Рисунки, схемы, скриншоты и другие изображения являются неотъемлемой частью любой пользовательской документации. Один скриншот с выносками может дать начинающему пользователю больше информации, чем страница печатного текста. Несмотря на это, многие авторы всячески избегают изображений. Они делают пользовательскую документацию текстовой, ссылаясь на трудоемкость обновления рисунков. В этой статье я расскажу, как поддерживать скриншоты в актуальном состоянии.

Полезные советы

16 апреля 2023

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

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

Полезные советы

28 января 2022

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

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

Help+Manual

15 января 2022

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