Перейти к содержанию

Техника 5.3: Разработка стандарта контента

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

За годы использования KCS в различных компаниях мы собрали статистику, что в 70–80 % организаций используется ""единый"", похожий шаблон, и в 20–30 % стандарты контента адаптированы к конкретной области знаний, подразделению или организации.

Стандарт контента должен охватывать широкий набор элементов, таких как:

  • Структура статьи KCS, определение для каждого поля — список полей статьи с определениями для каждого. Включая симптомы, окружение, решение, причину и метаданные.

  • Примеры хороших и плохих статей — контраст между плохими и хорошими статьями усиливает понимание стандарта.

  • Определения метаданных — список атрибутов статьи, а также значение и значение каждого из них, а также способ установки каждого элемента метаданных (автоматизированный или ручной).
  • Статус статьи — как определено в Атрибутах статьи KCS.
  • Аудитория статьи — кто что видит, как определено в Атрибутах статьи KCS.
  • Источник статьи — механизм для статей на основе соответствия, определенный в Атрибутах статьи KCS.
  • Шаблоны — если мы используем более одного шаблона, список доступных шаблонов и критерии использования каждого из них, а также инструкции по заполнению полей в каждом шаблоне.
  • Руководство по стилю — описывает предпочтительный стиль написания статей.
  • Вспомогательный материал — формат и критерии для внешних ссылок.
  • Лексика — предпочтительные термины, соответствующие контексту и уровню знаний аудитории, платформы, названия продуктов, выпуски и версии, товарные знаки и т.д.
  • Политика мультиязычности - написание руководств, правила перевода на другие языки.
  • Использование мультимедийного контента — критерии принятия решения о том, какой тип мультимедиа контента подходит для какой аудитории.
  • Краткое справочное руководство — одностраничное справочное руководство с советами и советами о том, как писать хорошие статьи. См. пример в Приложении E.

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