Всё для технического документирования
+7 (495) 001-00-42
Разработка технической документации
Курсы для технических писателей
Программное обеспечение

Как написать техническую базу знаний для вашего сайта

08.07.2015

00Размышляете о создании базы знаний для вашего бизнеса? Эта статья рассказывает об основах того, как обеспечить хороший уровень технического документирования вашего сайта.


 

Что такое техническая база знаний и зачем она вам нужна?

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

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

  • Она предоставляет собой хранилище информации по проблемам, вопросам и их решениям. Это означает, что когда проблема решена, решение будет записано, что сэкономит время в будущем.
  • Технические возможности и проблемы объяснены в терминах для дилетантов — таким образом представляя собой удобную отправную точку, с которой можно начать и сотрудникам, и клиентам.
  • Она помогает клиентам решать проблемы и находить ответы на запросы без необходимости обращения в техническую поддержку.
  • Она также может помочь сотрудникам вашей поддержки отвечать на вопросы быстрее, если клиенты всё-таки в неё обратились.

Последующие пункты посвящены тому, как вам следует структурировать вашу базу знаний и как описывать технические детали, с удачными практическими примерами из опыта.

Как структурировать вашу техническую базу знаний

Ваша база знаний будет менее эффективна, если люди не смогут найти то, что ищут, так что очень важен способ, с помощью которого вы структурируете свой контент.

Разметка

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

Пример: База знаний Groove имеет прозрачную разметку и хорошо заметное окно поиска, помогающее пользователям найти именно то, что им необходимо.

 

01

Заголовки

Хорошо составленные заголовки помогают людям находить, ссылаться и распространять статьи из вашей базы знаний. Всегда используйте понятный, прямой язык и пытайтесь включить ключевые слова, по которым пользователи могут совершать поиск. Применяйте индивидуальный подход, чтобы пользователи понимали, что они нашли правильную статью, начиная с её заголовка.

Пример: Заголовки у Evernote понятны, направлены на действие и написаны на языке пользователя.

 

02

Evernote также добавляет к статьям тэги, которые могут оказать помощь в поиске правильной информации.

Форматирование

Создайте стандартный формат, обеспечивающий последовательность и простоту чтения. Используйте, где это возможно, обычно используемые правила. Например, вы можете установить, что пути (которые даются пользователям для ссылки) должны всегда быть написаны следующим образом:

Файл > Сохранить как… > Сохранить как jpg

Как писать содержимое базы знаний

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

1. Детали проблемы или вопроса.

Это очень важно для проблем. Убедитесь, что вы включили следующую информацию:

а) В чём заключается проблема? Убедитесь, что включили достаточно деталей в части описания проблемы, чтобы люди знали, что нашли именно ту проблему, с которой столкнулись.

б) Почему это происходит? Объясните, чем вызвана ошибка, и предоставьте шаги, которые вы предпримите для её решения.

в) Как я узнаю, что у меня такая же проблема? Некоторая информация, которую вы можете захотеть включить в этом месте — сообщения об ошибках или точные известные обстоятельства, приводящие к проблеме.

2. Отклик — ответ или решение.

Далее обрисуйте ответ на вопрос или решение проблемы. Если решение сложное, разбейте его на легко осуществимые шаги, объясняя каждый технический термин.

Если скриншоты или видео помогут иллюстрировать решение, включите их в ваш отклик.

Пример: Wistia включает в своей справке скриншоты.

 

03

3. Последующие шаги.

Есть надежда, что большинство читателей найдут информацию, которую ищут, или решат проблему, но тем, у кого это не получится, необходимо предложить выход. Куда они могут обратиться за получением помощи, если решение не работает? Если людям необходимо связаться с вами, сделайте эту возможность очевидной. Также хорошей идеей будет размещение ссылок на похожие или связанные проблемы, т.к. это может помочь решить проблему до звонка в службу поддержки.

Пример: В справке Scout имеется ссылка с контактом плюс связанный контент в конце каждой статьи.

 

04

Подсказки по техническому писательству

Пишите понятно

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

Исследование показывает, что даже специалисты предпочитают читать простой язык, а не сложный, 80% юристов заявляют, что они бы читали лучше общеупотребимый язык, чем юридические термины. На самом деле, чем более образован человек и чем более специальные у него знания, тем больше он предпочитает обычный язык.

Пишите для чтения с экрана

Согласно следующим советам по написанию ЧаВО, вы должны писать контент базы знаний для облегчения чтения с экрана. Не пишите одним большим блоком, разбивайте контент на части для лёгкого сканирующего чтения.

Пример: Basecamp разбивает свои статьи на лёгкие для сканирования шаги.

 

05

Вычитка и тестирование решений

Перед публикацией статей дважды проверьте, что они работают, и по ним могут действовать другие люди. Вы можете сделать это внутри компании, а также дополнительно можете привлечь обратную связь через комментарии с целью улучшить свои советы.

Вывод — держите свою базу знаний в тонусе

Надеемся, что эта статья дала вам хорошее представление о том, как писать техническую базу знаний для вашего сайта. Один заключительный важный совет — ваша база знаний хороша только тогда, когда актуальна. Воспринимайте её как живой ресурс и старайтесь проверять, что все записи проходят ревизию на постоянной основе и обновляются, когда вопросы, ответы и решения претерпевают изменения.

Источник: How to write a technical knowledge base for your website

Тэги: , , , ,

< Вернуться к списку публикаций

Облако тегов