Microsoft насправді не накладає багато обмежень на те, що ви можете робити зі своїм довідковим контентом. Навіть якщо ваше рішення отримає сертифікацію, ви можете додавати будь-які додаткові функції, якщо ваш довідковий контент відповідає певним вимогам. Давайте відкладемо шлях створення абсолютно іншої довідкової системи для вашого рішення. У цій статті ми обговоримо варіанти, з якими ви можете зіткнутися, якщо хочете, щоб довідка вашого рішення відповідала стандартній документації, щоб ви могли безперешкодно інтегрувати свій власний довідковий контент у стандартний сервер довідки.
Тепер, коли стандартну документацію на сервері довідки перенесено з chm-файлів до HTML-файлів, посібники Microsoft Office Word або PDF більше не надаються, окрім деяких допоміжних документів. Фактично, документація також доступна на MSDN, але з дещо іншим макетом. Це, ймовірно, означає, що для користувацької довідки також слід відмовитися від старих добрих посібників користувача та дотримуватися виключно сервера довідки, чи не так? Не зовсім. Все залежить від мети, якої ви намагаєтеся досягти, і від того, як ви хочете представити інформацію кінцевому користувачеві.
Використовуючи Сервер довідки вже кілька років, цілком очевидно, що цю систему не можна назвати універсальним рішенням для задоволення всіх ваших потреб, пов'язаних з документацією. Його впровадження значно спростило внутрішній процес створення довідки. Тепер ви можете легко вносити корективи навіть без перекомпіляції всього проекту. Вміст довідки може знаходитися на сервері, до якого можуть підключатися численні клієнти Microsoft Dynamics NAV, і всі вони матимуть найновішу версію. Вам не потрібно думати про певні проблеми, з якими вам доводилося стикатися раніше, такі як індекс або складний зміст. З іншого боку, Сервер довідки має свої недоліки, такі як надмірно спрощена функція пошуку порівняно з тим, що було в chm-файлах.
Маючи понад 5 років досвіду використання Сервера довідки, ми щойно зрозуміли, що не хочемо відмовлятися від документів Word та PDF. Принаймні, поки що. Ось чому.
Є цілі, які документація, що надається на Сервері довідки, насправді не дозволяє нам досягти. Давайте розглянемо ключові відмінності між документами Word/PDF та онлайн-довідкою на Сервері довідки.
Сервер довідки (HTML):
-
Ідеально підходить для контекстно-залежної довідки. Сервер довідки надає контекстно-залежну довідку для об’єктів та елементів керування Microsoft Dynamics NAV. Це, звичайно, не обмежує цю довідку наданням іншої інформації, такої як опис концепцій або практичні посібники для допомоги у виконанні завдань.

- Тематично . Інформація надається невеликими фрагментами – темами. Таким чином, якщо ви, наприклад, хочете дізнатися більше про певну область, вам доведеться перемикатися між гіперпосиланнями. Існує ймовірність пропустити певні теми або загубитися в окремих текстах.

- Мінімум зображень . Навіть якщо HTML-файл на сервері довідки може містити зображення або скріншоти, їх кількість зводиться до мінімуму завдяки тому, що перед відкриттям теми довідки у вас перед очима є клієнт Microsoft Dynamics NAV або ви можете за потреби відкрити вікно безпосередньо з певних тем. Це також спрощує процес ведення документації, оскільки вам не потрібно стежити за найменшими змінами в інтерфейсі користувача вашого рішення.
Посібники користувача (docx/pdf):
-
Зв'язне розташування. На відміну від численних тем на сервері довідки, посібник у форматі docx/pdf зазвичай має зв'язну структуру, яка дозволяє читачеві сприймати інформацію логічно та добре організовано. Це ідеально, якщо ви хочете дізнатися якомога більше інформації про певну галузь і хочете переконатися, що кожна її частина пов'язана або випливає природним та зрозумілим чином.

- Багатий на візуальні засоби . Оскільки зручно надсилати документ комусь без необхідності встановлювати сервер довідки або навіть Microsoft Dynamics NAV, такий документ зазвичай містить велику кількість зображень, оскільки цільовий читач може не мати доступу до Microsoft Dynamics NAV. Недоліком цього є те, що оновлення такої документації може стати проблемою.

- Незалежність : така документація не вимагає Microsoft Dynamics NAV або сервера довідки. Це може бути корисним, коли вам потрібно надати швидку допомогу та уникнути будь-яких проблем, пов'язаних з розгортанням.
Як бачите, жоден із шляхів не є ідеальним. Наш підхід наразі полягає в тому, щоб дотримуватися обох цих форматів, які доповнюють один одного. Завдяки підтримці Microsoft документів Word на сервері довідки Microsoft Dynamics NAV, ви можете зробити свої документи доступними для завантаження з сервера довідки, на додаток до або замість онлайн-вмісту довідки. Що стосується PDF-файлів, вони частково підтримуються: ви можете завантажити їх із сервера, але не можете читати їх безпосередньо через веб-браузер "з коробки". Хоча, з невеликою модифікацією файлу msdnTheme.css, читання PDF-файлу на сервері довідки може стати ще одним варіантом для читача. Ми вважаємо, що чим більше варіантів для користувача, тим краще. Нехай вони самі вибирають, що для них найкраще.
Ще один момент, який слід враховувати, вирішуючи, який формат обрати для вашої документації, це те, як ви збираєтеся підтримувати її в довгостроковій перспективі. Якщо ваше рішення є довгостроковим проектом, який буде зростати, а ваша команда документації навряд чи зміниться, пізніше ви можете зіткнутися з проблемою оновлення документації: як впоратися з постійними змінами в безлічі тематичних файлів у величезному проекті. Хоча Microsoft Office Word надає чудову функцію відстеження змін, яка може врятувати вас від незліченних оновлень протягом усього проекту, ваш HTML-редактор не обов'язково матиме таку функціональність. Це не є проблемою для невеликого проекту, але може перетворитися на головний біль для колосального рішення, яке постійно змінюється.
А як щодо майбутнього?
Поточна версія Сервера довідки точно не є остаточною. Команда довідки Microsoft усвідомлює, що керування довідкою на Сервері довідки може бути громіздким, і шукає способи його покращення. Набір інструментів довідки не оновлювався досить давно. Тому не дивуйтеся, дізнавшись, що остання версія для Microsoft Dynamics NAV 2013 R2. Зверніть увагу, що її все ще можна використовувати для створення довідкового контенту для пізніших версій Microsoft Dynamics NAV.
У Microsoft Dynamics NAV 2017 було запроваджено підказки, які дозволяють створювати коротку довідку з розблокування для елементів керування полями та діями, просто заповнивши властивість елемента керування. Підказки є частиною нового трирівневого підходу до допомоги користувачам:
- Почати
Інтерфейс користувача (наскільки це можливо) зрозумілий і не потребує пояснень.
Ось чому ви помітите зміни в багатьох об’єктах сторінки та появу нових посібників з налаштування.

- Розблокувати
Вбудована допомога користувачам («підказки») для відповідей на більшість запитань.
Ось чому багато об'єктів сторінки тепер містять текст підказки.

- Дізнатися більше
Концептуальні теми на сервері довідки описують сценарії, робочі процеси та можливості.
Ці три рівні ще розробляються, але це основа на майбутнє. Команда допомоги користувачам NAV перейшла на новий набір інструментів, заснований на програмному забезпеченні з відкритим кодом та MarkDown зі смаком GitHub. HTML-файли генеруються за допомогою DocFx, що забезпечує набагато чистіший HTML. Однак, більше інформації про цей новий набір інструментів буде надано пізніше. Ми з нетерпінням чекаємо на більше новин щодо цих змін. Сподіваємося, що вони зроблять наше життя простішим та цікавішим у майбутньому.
Отже, вибір формату документації слід робити з урахуванням ваших цілей, потреб бізнесу та, бажано, потреб кінцевого користувача. Оберіть найкращу стратегію, яка буде вигідною для всіх сторін у довгостроковій перспективі, та будьте готові до змін, які можуть трапитися з нами найближчим часом.