Будьте организованы! Как создать руководство по стилю базы знаний

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

Видите ли, помимо этих идей, вам нужно убедиться, что вы всегда:

• Использование правильного тона
• Последовательное форматирование все одно и то же

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

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

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

Во-первых, если вы являетесь частью команды, у вас могут быть разные люди, которые пишут документы для поддержки. Так что если:

• Джим пишет статью А
• Салли пишет статью B

Эти статьи, вероятно, будут иметь совершенно разные стили и форматирование… если только у вас нет заранее определенного руководства по стилю.

Теперь, если вы не являетесь частью команды, вы, вероятно, говорите: «Я волк-одиночка — я все пишу сам. Так что мне не нужно ничего записывать на бумаге — это все я!»

И это могло бы быть так… если бы вы написали все свои статьи базы знаний за один присест.

Но мы оба знаем, что обычно это не так, верно? Вероятно, вы написали кучу статей в базу знаний, когда впервые выпустили свой продукт.

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

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

Действительно ли компании делают это? Является ли руководство по стилю базы знаний реальной вещью?

Хорошо, сейчас я расскажу вам, как создать руководство по стилю. Но сначала я хочу привести несколько примеров компаний, которые действительно этим занимаются. Это решает две цели:

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

Давайте сначала посмотрим на Mozilla. У Mozilla есть целая запись в руководстве по стилю для их базы знаний. Поскольку Mozilla является открытым исходным кодом, для них особенно важно иметь руководство по стилю, чтобы, по их собственным словам, «сделать базу знаний поддержки Firefox согласованной, в результате чего база знаний будет легко читаться и в нее будет вноситься свой вклад». Легко читать? Звучит как хорошая цель для вашей базы знаний, верно?

Руководство идет глубоко, проводя вас через все: от заглавных букв до пробелов и последовательных запятых.

Далее стоит прочитать Voice & Tone от MailChimp. Хотя он не на 100% ориентирован на базы знаний, в нем есть несколько записей как для базы знаний, так и для учебного контента:

В то время как руководство по стилю Mozilla больше сосредоточено на стиле и форматировании, MailChimp предпочитает больше фокусироваться на голосе и тоне, чем на мельчайшем форматировании.

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

Я бросил вам пару примеров, но мне еще предстоит дать вам процесс создания собственного руководства по стилю базы знаний. Так давайте это исправим!

Используйте последовательного человека

Вы когда-нибудь читали статью, в которой автор переключался между «я» и «мы»? У меня есть, и мы можем сказать вам, что это чрезвычайно запутанно.

Итак, если вы собираетесь использовать первое лицо — выберите одно и будьте последовательны в этом. Даже если вы один, вы все равно можете использовать «мы». Вам решать! Просто используйте тот же.

Кроме того, вам даже не нужно использовать вид от первого лица. Вы можете вообще отказаться от «я» и «мы».

На самом деле здесь нет правильного ответа — это просто последовательность.

Стандартизируйте форматирование

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

Щелкните Файл .

Итак – это:

• Нажмите на файл
• Нажмите «Файл»
• Нажмите на файл

И когда вы на самом деле пишете свои списки, это:

• Шаг 1: Нажмите здесь
• Шаг 2: Нажмите на это

Или вот так:

• Нажмите это
• Щелкните это

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

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

• Заглавные буквы — вы будете использовать регистр предложений или заглавных букв?
• Числа – это 10 или десять?
• Аббревиатуры – не делайте или не делайте?
• Акронимы – CDN или сеть доставки контента?

Если вы используете одну из тем или плагинов WordPress из нашей базы знаний, наши встроенные шорткоды и параметры форматирования помогут вам оставаться последовательным, когда дело доходит до форматирования.

Получите правильный голос

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

Вы друг вашего клиента? Или вы Спок из «Звездного пути», бесстрастно раздающий холодную тяжелую мудрость?

В пределах разумного и то и другое нормально. Пока это последовательно.

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

Их совет таков:

• Всегда уделяйте первоочередное внимание ответам на вопросы и информированию читателей. Шутки иногда допустимы, но не в том случае, если они отвлекают от основной цели.
• Не говорите как маркетолог — вы просто пытаетесь помочь.

Где хранить руководство по стилю?

Вы не должны просто так принимать эти решения. Вы также должны на самом деле, вы знаете, записать их в надежном месте.

Лично большинство руководств по стилю, с которыми я работаю, — это документы Google Docs. Таким образом, вы можете легко поделиться своим руководством по стилю и получить к нему доступ с разных компьютеров.

Но если вы предпочитаете другой метод, используйте тот, с которым вы знакомы. Единственное, что действительно важно, это:

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

Итак, запишите это на бумаге и начните создавать более последовательные статьи базы знаний!