Інструменти для створення довідки: локальні чи SaaS-проекти — вибір правильного варіанту для вашого проєкту
Technical
трав. 14, 2024 2098 перегляди 2 час читання

Інструменти для створення довідки: локальні чи SaaS-проекти — вибір правильного варіанту для вашого проєкту

Денис Федоров, провідний технічний автор, Xpand:

На початку проекту одним із перших рішень, яке потрібно прийняти, є вибір інструменту для створення довідки, який ваша команда технічних авторів використовуватиме для документування рішення. Перехід на інший HAT (інструменти для створення довідки) в майбутньому є непростим завданням, тому вкрай важливо прийняти правильне рішення на ранній стадії.

Ви можете запитати: «Що ж таке інструмент для створення довідки взагалі?», особливо якщо ви не працюєте в галузі технічного письма (TW). Інструмент для створення довідки – це програмний додаток, спеціально розроблений для допомоги технічним авторам у створенні, управлінні та публікації різних типів документації, таких як посібники користувача, файли онлайн-довідки, бази знань та навчальні посібники. По суті, інструмент для створення довідки забезпечує структуроване середовище для організації контенту, часто використовуючи такі функції, як шаблони, посібники зі стилю та контроль версій, щоб забезпечити узгодженість та ефективність протягом усього процесу документування. Крім того, HAT зазвичай пропонують потужні можливості редагування, включаючи форматування тексту, інтеграцію мультимедіа та інтерактивні елементи, що дозволяє авторам створювати захопливий та інформативний контент.

По суті, інструмент для створення довідки слугує комплексним рішенням для технічних авторів, дозволяючи їм ефективно створювати високоякісну документацію, яка відповідає потребам кінцевих користувачів, дотримуючись при цьому галузевих стандартів і передових практик. Однак, на ринку пропонуються дві основні моделі розгортання для HAT: локальні інсталяції та рішення «програмне забезпечення як послуга» (SaaS). У цій статті детально розглядаються переваги та недоліки кожного підходу, що дозволяє вам приймати обґрунтоване рішення на основі конкретних потреб вашого проекту.

Локально встановлені інструменти для створення довідки

Приклади: Adobe Robohelp , MadCap Flare

Локально встановлені HAT – це програмне забезпечення для створення документації, яке завантажується та встановлюється на жорсткий диск вашого комп’ютера.

Давайте розглянемо переваги, а також недоліки цієї моделі.

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

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

+ Локально встановлені HAT дозволяють безперебійно працювати офлайн, не покладаючись на підключення до Інтернету, що особливо вигідно в ситуаціях, коли доступ до Інтернету ненадійний.

+ Інструменти для створення локальної довідки часто надають можливість генерувати вивід у кількох форматах, таких як HTML, PDF, DOCX, CHM тощо, що забезпечує легкий доступ до документації на різних платформах і пристроях.

+ / - Вони можуть запропонувати одноразову плату на відміну від моделі передплати. Це може бути перевагою або недоліком залежно від розміру команди та ваших планів, а також від того, чи хочете ви мати доступ до найновіших функцій. Масштабування ліцензій користувачів може бути громіздким і пов’язаним із додатковими витратами.

- Публікація може бути складною. Зазвичай, з локальними HAT, вам доводиться самостійно керувати публікацією свого контенту. Хостинг не включено або може надаватися як окреме рішення. Це означає, що публікація може вимагати більше часу, залучати ІТ-команду та спричиняти додаткові витрати. Процес публікації оновлень буде менш зручним. Наприклад, якщо результатом є сайт довідки, вам може знадобитися повторно опублікувати весь сайт навіть після невеликих змін.

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

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

- Локальні HAT зазвичай недоступні на мобільних пристроях.

Сподобалася стаття? Перегляньте ще одну статтю автора про технічне письмо та його нюанси - Рекомендації щодо технічного письма для успішного запуску продукту .

Інструменти для розробки довідки SaaS

Приклади: Document360 , ClickHelp

З іншого боку, SaaS HAT – це хмарні рішення, доступ до яких здійснюється через веб-браузер. Вибір такого рішення зробить процес створення/керування документацією досить відмінним порівняно з локально встановленим HAT.

+ Легка публікація. SaaS-інструменти зазвичай не лише забезпечують середовище для створення/керування контентом, але й пропонують послуги хостингу, що означає, що ви можете публікувати свій контент безпосередньо з програмного забезпечення, зазвичай на веб-сайті довідки. Цей процес зазвичай дуже швидкий і простий, що дозволяє публікувати оновлення одним клацанням миші. Крім того, ви зазвичай можете публікувати невеликі оновлення (одну тему), замість того, щоб перепублікувати весь сайт.

+ Командна співпраця з SaaS HAT набагато простіша порівняно з локальним програмним забезпеченням, оскільки вбудована функція контролю версій, що усуває будь-які проблеми щодо конфліктів оновлень. Для віддалених команд або географічно розподілених співробітників інструменти SaaS часто забезпечують чудову доступність. Кожному автору чи розробнику контенту не потрібно нічого встановлювати – все, що їм потрібно, це обліковий запис із ліцензією. Додавання або видалення користувачів зазвичай є простим процесом у рамках плану підписки, що дозволяє легко налаштувати його відповідно до потреб проекту без клопоту з керуванням окремими ліцензіями.

+ Підтримка зазвичай краща за моделі SaaS, де ви можете регулярно проводити навчальні сесії, отримувати персональні новини та мати можливість запитувати певні функції. Загалом, оновлення за такого підходу є регулярнішими. Постачальники займаються оновленнями програмного забезпечення, гарантуючи, що користувачі завжди мають доступ до найновіших функцій та покращень без необхідності ручного встановлення чи оновлень. Підтримка повністю лежить на плечах постачальника послуг, а це означає, що якщо виникає проблема, постачальник несе відповідальність за її виправлення або пошук рішення.

+ SaaS-рішення зазвичай доступні на мобільних пристроях, що може бути корисним у певних сценаріях.

+ / - Усі SaaS-інструменти для розробки довідки використовують модель ліцензування на основі підписки. Перевага це чи недолік залежить від потреб вашого бізнесу, а також від бюджету вашого проекту. Перш ніж приймати рішення, обов’язково дослідіть переваги та функції, що надаються кожним типом підписки.

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

- Як правило, результатом SaaS HAT є довідковий сайт або база знань, іноді з додатковою можливістю експорту контенту у форматі PDF або DOCX. Тому, якщо вас цікавлять інші формати, SaaS може бути не для вас.

- Якщо ваш проєкт стосується висококонфіденційної інформації, інструменти SaaS забезпечують менший контроль над безпекою даних.

- Для доступу до програмного забезпечення обов'язковий доступ до Інтернету.

Вибір правильного інструменту

Як локальні, так і SaaS-платформи розгортання HAT пропонують цінні функції для технічних авторів. Розуміючи переваги та недоліки кожної моделі розгортання та узгоджуючи їх із конкретними потребами вашого проекту, ви можете прийняти обґрунтоване рішення та вибрати інструмент, який дозволить вам створювати виняткову документацію.

Ви випадково щось знаєте про Xpand?

Xpand – це компанія з розробки програмного забезпечення для продуктів та послуг, яка допомагає організаціям по всьому світу керувати їхніми системами Microsoft Dynamics ERP та CRM. Ми надаємо послуги клієнтам та партнерам у різних форматах, починаючи від впровадження та розробки Microsoft Dynamics 365 Business Central і закінчуючи оновленням Business Central, починаючи з ранньої версії Navision Financials 2.0. Більше про наші послуги – https://www.xpandsoftware.com/services .

Наш основний продукт, Xpand Portal , який має сильну присутність на ринку вже понад 7 років, пропонує компаніям комплексне та настроюване веб-рішення для оптимізації доступу до різних джерел даних, таких як системи ERP та CRM, та підвищення загальної продуктивності.

Він розроблений простим та зручним у використанні, з швидким та інтуїтивно зрозумілим налаштуванням для задоволення ваших конкретних потреб. Якщо вам потрібна додаткова інформація про рішення Xpand Portal, будь ласка, зв'яжіться з нами . Наша команда та я будемо раді допомогти вам з вашим проектом веб-порталу.