Блог технического писателя Ильи Жукова

Поиск в WebHelp находит удаленные разделы

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

 

Причина

Удаленные разделы WebHelp появляются в результатах поиска из-за «наложения» новых и старых файлов в целевой папке. Поисковый индекс генерируется из результирующих файлов в данной папке. Дополнительно, если вы не будете регулярно очищать папку с WebHelp на сервере, удаленные разделы могут появиться в результатах поиска Google и других поисковых систем.

 

Решение

1. На локальном ПК всегда очищайте целевую папку перед сборкой WebHelp. И Help and Manual, и HelpNDoc умеют это делать автоматически.

 

Help and Manual

В Help and Manual в окне параметров сборки пометьте флажок Delete all files in the output folder before publishing (Удалить все файлы в целевой папке перед публикацией). Данная настройка сохраняется только на текущий сеанс работы с программой.

 

очистка целевой папки в Help and Manual

 

HelpNDoc

В HelpNDoc в настройках шаблона в раскрывающемся списке Clean output directory (Очистить целевую папку) выберите Always (Всегда). Данная настройка сохраняется до ее следующего изменения.

 

очистка целевой папки в HelpNDoc

 

2. Выкладывайте WebHelp на сервер следующим образом:

  • Создайте на одном уровне со старой папкой WebHelp новую папку с другим названием.
  • Скопируйте новый WebHelp в новую папку.
  • Быстро переименуйте папки.
  • Папку со старым WebHelp удалите.

 

Добавить комментарий

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

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