База знаний ABAP программиста

1405186568_118806С увеличением объема информации необходимой для выполнения своих профессиональных обязанностей, перед каждым IT специалистом, а в особенности программистами, встаёт задача её быстрого поиска, для чего информация должна быть хорошо структурирована, актуальна, а поиск по ней должен выдавать релевантные результаты.

В данной статье будет рассмотрен один из способов построения простейшей базы знаний, с помощью продукта Help & Manual (H&M).

Ранее являясь Delphi разработчиком, часто приходилось использовать базу знаний DRKB (Delphi Russian Knowledge Base), база содержит более 4000 хорошо классифицированных и тщательно оформленных статей. Основным на то время вариантом этой базы являлся CHM файл (Microsoft Compressed HTML Help — формат справки от MS).

Внешне структура справки выглядит следующим образом:

drkb

Благодаря хорошей структурированности, можно было всегда быстро и легко найти ответы на возникающие в процессе разработки вопросы, чему так же способствовал встроенный в CHM файл поиск.

Разработка на языке ABAP как и Delphi подразумевает использование большого числа технологий: концепции работы с базами данных, объектами словаря, всевозможными способами межсистемной интеграции, средствами построения отчётности, знаний в области API для различных модулей SAP (например, функции работы с инфотипами HR), технологий расширения системы и множества других.

С помощью SDN и портала справочной системы SAP (help.sap.com), а так же источников в интернете можно решить большинство вопросов связанных с поиском нужной информации, однако и они полностью не решают некоторые из них, да и структурированность оставляет желать лучшего.  В качестве дополнительного источника информации и с целю сохранения и накопления опыта, мной была создана похожая на DRKB база знаний, только относительно языка ABAP и за вычетом некоторых её недостатков.

Недостатки CHM как формата для базы знаний:

  • Нет возможности встраивать внешние форматы электронных документов, таких как PDF, DJVU и др.
  • Нет возможности встраивать видео
  • Отсутствие нормальной кроссплатформенности
  • Отсутствие возможности работы через Web

В качестве ПО для создания базы был выбран H&M, альтернативным решением может быть Doc-To-Help. Оба продукта позволяют создавать справочную систему в Web формате, с возможностью изменения шаблонов «под себя».

Структура базы данных в настоящий момент выглядит следующим образом:

help_structure

Как видно из рисунка, сейчас это около 3000 статей, заметок, внешних ссылок на литературу и прочие источники (размер в настоящий момент около 45 ГБ). Встраивание внешних файлов выполняется через iframe, следующим образом:

external_pdf

Просмотр файла файла в браузере:

help_in_web

Видео интегрируется через HTML тэг Video:

H&M позволяет вставлять в содержимое статей форматированный текст из Word:

code_highlight

Кроме того в справочной системе есть встроенный поиск наподобие поиска в CHM файлах:

web_search

Создание и использование подобной базы знаний позволяет в значительной степени ускорить поиск необходимой в повседневной деятельности информации. H&M позволяет так же вести обновление/синхронизацию файла справки из нескольких источников, что делает её неким подобием Wiki.

Хотелось бы поинтересоваться у читателей данной статьи, есть ли подобные решения у Вас, может быть Wiki или нечто подобное?

Шаблон используемый при создании данной базы знаний можно взять тут.