Создание справочной документации к продукту

Система управления проектами DEVPROM позволяет разработчикам ПО готовить справочную документацию к программным продуктам без использования дополнительных инструментов, например, Author-It или RoboHelp, предоставляя следующие ключевые возможности:

  • Создание любого количества справочных документов произвольной вложенности при помощи Wiki.
  • Экспорт документации в различные форматы: RTF (MS Word), HTML, CHM (Microsoft Help).
  • Автоматическое связывание разделов справочной документации с исходными требованиями к продукту.
  • Отслеживание актуальности покрытия разделами документации исходных требований, трассировка требований в разделы справочной документации.
  • Планирование задач по подготовке справочной документации, интегрированное в общий процесс разработки ПО.
  • Списание времени, затраченного на подготовку или исправление справочной документации.
  • Рецензирование справочной документации путем вовлечения всей команды проекта.

Возможности экспорта

Если вам важно подготовить документацию, но не важно ее оформление, то используйте простые возможности экспорта: HTML и RTF. При этом используются стандартные стили для каждого формата экспорта.

 

Если для ваших пользователей или заказчика важным фактором является также внешнее оформление документации, использование фирменного стиля (цветов, шрифтов, подложек и т.п.), то вы можете создавать собственные стили экспорта при помощи стандартных возможностей HTML: задание верхнего и нижнего колонтитулов, внедряемых в каждый раздел документации, задание CSS-стилей.

 

С использованием собственных шаблонов экспорта в HTML вы можете выгружать справочную документацию в виде одного HTML-файла или в формате Microsoft Help (.chm файл).

Документация в формате Microsoft Help

Выполнив экспорт в формате CHM вы скачиваете автоматически подготовленный архив, в котором содержатся:

  • разделы файла справки
  • файлы с изображениями
  • файл проекта Microsoft Help (.hhp), используемый для компиляции файла справки в файл .chm
  • файл с содержанием справки (.hhc)

Вам остается только распаковать архив, и при помощи компилятора (hhc.exe) входящего в состав дистрибутива для подготовки Microsoft Help, получить готовый файл справки.

Еще интересные статьи на эту тему: