Що таке технічна база знань і навіщо вона вам потрібна?
База знань - це спосіб управління технічною інформацією, так що на неї можна посилатися і її можна поширювати. Технічна база знань зазвичай містить інформацію про те, як використовувати можливості або процеси, відповідає на технічні питання і допомагає вирішити проблеми.
Якщо в роботі вашого бізнесу присутній додаток, розробляється програма або сайт містить унікальну функціональність, то кілька хороших технічних інструкцій полегшать їх використання, що буде корисно з безлічі причин:
- Вона надає собою сховище інформації з проблем, питань і їх рішень. Це означає, що коли проблема вирішена, рішення буде записано, що заощадить час в майбутньому.
- Технічні можливості та проблеми пояснені в термінах для дилетантів - таким чином представляючи собою зручну відправну точку, з якої можна почати і співробітникам, і клієнтам.
- Вона допомагає клієнтам вирішувати проблеми і знаходити відповіді на запити без необхідності звернення в технічну підтримку.
- Вона також може допомогти співробітникам вашої підтримки відповідати на питання швидше, якщо клієнти все-таки в неї звернулися.
Наступні пункти присвячені тому, як вам слід структурувати вашу базу знань і як описувати технічні деталі, з вдалими практичними прикладами з досвіду.
Як структурувати вашу технічну базу знань
Ваша база знань буде менш ефективна, якщо люди не зможуть знайти те, що шукають, так що дуже важливий спосіб, за допомогою якого ви структуруєте свій контент.
Виберіть легко сприймається розмітку, що дозволяє людям отримати інформацію, яку вони шукають, максимально швидко. Розділіть контент на секції і запропонуйте очевидний метод пошуку.
Приклад: База знань Groove має прозору розмітку і добре помітне вікно пошуку, що допомагає користувачам знайти саме те, що їм необхідно.
Добре складені заголовки допомагають людям знаходити, посилатися і поширювати статті з вашої бази знань. Завжди використовуйте зрозумілий, прямий мову і намагайтеся включити ключові слова, за якими користувачі можуть здійснювати пошук. Застосовуйте індивідуальний підхід, щоб користувачі розуміли, що вони знайшли правильну статтю, починаючи з її заголовка.
Приклад: Заголовки у Evernote зрозумілі, спрямовані на дію і написані на мові користувача.
форматування
Створіть стандартний формат, що забезпечує послідовність і простоту читання. Використовуйте, де це можливо, за допомогою яких традиційно правила. Наприклад, ви можете встановити, що шляхи (які даються користувачам для посилання) повинні завжди бути написані таким чином:
Файл> Зберегти як ...> Зберегти як jpg
Як писати вміст бази знань
Створіть прозорий процес для людей, які наповнюють вміст бази знань - це допоможе переконатися в тому, що нові питання, проблеми і рішення завжди реєструються. Пояснення можливостей, швидше за все, буде оформлятися по-іншому, але питання і проблеми, ймовірно, будуть слідувати стандартному формату трьох кроків.
Це дуже важливо для проблем. Переконайтеся, що ви включили наступну інформацію:
а) У чому полягає проблема? Переконайтеся, що включили досить деталей в частині опису проблеми, щоб люди знали, що знайшли саме ту проблему, з якою зіткнулися.
б) Чому це відбувається? Поясніть, чим викликана помилка, і надайте кроки, які ви зробите для її вирішення.
в) Як я дізнаюся, що в мене така ж проблема? Деяка інформація, яку ви можете захотіти включити в цьому місці - повідомлення про помилки або точні відомі обставини, що призводять до проблеми.
Далі обрисуйте відповідь на питання чи вирішення проблеми. Якщо рішення складне, розбийте його на легко здійсненні кроки, пояснюючи кожен технічний термін.
Приклад: Wistia включає в своїй довідці скріншоти.
Є надія, що більшість читачів знайдуть інформацію, яку шукають, або вирішать проблему, але тим, у кого це не вийде, необхідно запропонувати вихід. Куди вони можуть звернутися за отриманням допомоги, якщо рішення не працює? Якщо людям необхідно зв'язатися з вами, зробіть цю можливість очевидною. Також гарною ідеєю буде розміщення посилань на схожі або пов'язані проблеми, тому що це може допомогти вирішити проблему до дзвінка в службу підтримки.
Підказки з технічного письменства
Використовуйте просту мову навіть при написанні специфічних текстів для вашої користувальницької бази. Ніхто не хоче витрачати час на те, щоб пробиратися через технічний жаргон, всі хочуть знайти рішення своєї проблеми якомога швидше.
Пишіть для читання з екрану
Згідно наступних порад з написання ЧаВО. ви повинні писати контент бази знань для полегшення читання з екрану. Не пишіть одним великим блоком, розбивайте контент на частини для легкого скануючого читання.
Приклад: Basecamp розбиває свої статті на легкі для сканування кроки.
Вичитування і тестування рішень
Висновок - тримайте свою базу знань в тонусі
Також вам може бути цікаво:
- 111 джерел ідей для вашого блогу Корпоративний блог - в сучасному світі це необхідний інструмент для.
- 13 статистичних фактів про копірайтингу для вашого бізнесу У статті наведено добірка статистики з різних аспектів копірайтингу і.
- Оновлення сайту Дорогі друзі! З радістю повідомляємо, що сьогодні наш сайт починає.
- Як комунікатори використовують Doc-To-Help Нещодавно в нашому магазині з'явилася можливість придбати продукт для створення.
- Нові послуги для Вашого документування З сьогоднішнього дня ви можете скористатися нашими новими послугами: допомога.