Довідкова система ( «хелп»)

Наші послуги

Чим ми можемо вам допомогти

Консультації та рецензії

Розробка технічної документації на продукцію для державних потреб

Розробка технічної документації на прикладні сервіси

Розробка документації на комерційні продукти

впровадження DITA

Технічний переклад

стандарти

ЕСКД (ГОСТ 2)

ЕСПД (ГОСТ 19)

КСАС (ГОСТ 34)

ISO / IEC

предмети

пристрої

програми

комплекси

платформи

процеси

системи

інфраструктури

документи

інструкції

по розгортанню

по експлуатації КТС

технологічні

описи

програми

системи

мови

керівництва

адміністратора

оператора

користувача

по експлуатації

програміста

сист. адміністратора

Інші

формуляр системи

Повноцінна довідкова система складається, по крайней мере, з двох частин: загальної і контекстної.

У загальну частина зазвичай включають матеріал всіх наявних посібників: користувача або оператора. адміністратора. системного адміністратора та інших документів, зрозуміло при наявності таких. Більш того, матеріал, який через великий обсяг невигідно друкувати на папері або незручно шукати в лінійному документі, нерідко включають тільки в довідкову систему. Особливо це стосується описів бібліотек функцій і класів.

У контекстну частина довідкової системи включають:

  • опис кожного режиму і діалогового вікна;
  • підказки за елементами головного вікна, вікон документів і діалогових вікон;
  • підказки по пунктам меню та кнопок панелей інструментів;
  • підказки по вживаним термінам.

Загальною частиною Новомосковсктель користується як електронною книгою.

Методика і стиль викладу

Довідкова система - це гіпертекст. Про те, яким вимогам він повинен задовольняти, щоб його переваги перед текстом лінійним були зведені нанівець, написано багато книг і ще більше статей. Мова в них йде переважно про веб-сайтах, від яких технічна документація, звичайно, відрізняється. Не маючи можливості глибоко вникати цю проблематику тут і зараз, наведемо кілька основних правил написання гіпертексту.

  1. Слід прагнути до того, щоб кожен розділ був самодостатню статтю, при обмеженому обсязі в цілому (нехай не повністю) зрозумілу Новомосковсктелю у відриві від решти матеріалу. Інакше кажучи, розділ повинен бути чимось на зразок статті в енциклопедії або ґрунтовної відповіді на поставлене кимось питання. Це може досягатися, зокрема, більш активним дублюванням тексту (визначень, концепцій), ніж в лінійному документі.
  2. Якщо повне розуміння розділу неможливо без ознайомлення з деякими іншими розділами довідки, на них повинні бути зроблені посилання. Також настійно рекомендується робити посилання на визначення термінів, що вживаються в тексті розділу.
  3. У гіпертексті виключені (оскільки позбавлені сенсу) неявні посилання з одного розділу в інший, які в лінійному тексті робляться за допомогою виразів «як було сказано вище». «Як буде показано нижче» і т. П.

Проте, на практиці довідкова система часто є текст керівництва користувача, представлений в певному електронному форматі. Що не йде на користь справі, але значно простіше і дешевше.

Програмний комплекс ІНЕК-Страховик 5.0, модуль «Бухгалтерія». Довідкова система в форматі Microsoft HTML Help

ІНЕК-Страховик - програмний комплекс, призначений для автоматизації діяльності страхових компаній. Версія 5.0 програмного комплексу включала в себе кілька прикладних модулів, одним з яких був модуль «Бухгалтерія». Програмний комплекс ІНЕК-Страховик випускається компанією ІНЕК. Технічна документація на його п'яту версію була розроблена «Філософтом». На рис. 1 показано вікно довідкової системи модуля «Бухгалтерія».

Довідкова система ( «хелп»)

Малюнок 1. Довідкова система в форматі Microsoft HTML Help

Довідкова система ( «хелп»)