База знаний

Вводные данные

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

[spoiler]


Обновление поста. К нашему сожалению проект База Знаний "не выстрелил". Надежда на пополнение её со стороны сообщества провалилась, хотя именно наши пользователи просили о её создании. Своими силами мы не имеем возможности её поддерживать. Проект закрыт.

Обновление от 31.10.2018.





В частности у нас объём разного вида документации на данный момент:

• Контент-менеджер: 102 стр
  
• Админ Базовый: 140 стр
  
• Админ Модули: 258 стр
  
• Админ Бизнес: 120 стр
  
• Пользователь КП:  154 стр.
  
• Админ КП: 375 стр.
  
• Курс для хостеров: 82 стр.
  
• Разработчик Bitrix Framework: 234 стр.
  
• АПИ дока примерно 2500
  
• Пользовательская дока примерно 1100
  

Итого: 4965 стр.
Не считая океана форумов, блогов.

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

Цели создания Базы данных

• Снижение порога входа в Bitrix Framework для новичков
  
• Облегчение текущей работы разработчиков.
  

О Базе знаний
Идея создания Базы знаний - не наша идея, а исходила от сообщества. Поэтому мы и смеем надеяться на активную помощь сообщества в наполнении этого инструмента содержанием.

База знаний размещена в специальном одноименном разделе сайта для разработчиков. На странице есть: строка поиска, которая ищет только по Базе знаний, а не по всему сайту; Облако тегов, которое выводит теги только Базы знаний; и собственно рубрики и ссылки. Предусмотрен инструмент быстрого перехода на аналогичные разделы в других ролях (если есть аналоги разделов). Поиск и облако тегов работают только на текущий и вложенные разделы.



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

Принципы рубрикации Базы знаний
Ясно, что рубрикация интуитивно понятная для "юзверей" - это основа успеха для Базы знаний. Сложность этой работы (кажущейся элементарной) оказалась достаточно высокой. У нас было несколько вариантов рубрикации, обсуждали в компании, обсуждали с некоторыми из наших постоянных консультантов-партнёров. Пришли к такому итогу:

Рубрикация должна решать три задачи:

• Разводить пользователей по ролям, что бы не мешать в кучу задачи и приучать пользователей понимать свой статус и свои возможности;
  
• Разводить пользователей по строению Админки и модулям, так как каждый примерно понимает средствами каких модулей он хочет решить свою задачу.
  
• Разводить пользователей по видам (темам) задач.
  

Придерживаться строго этого принципа оказалось возможным только для роли Администратора. В роли Контент-менеджера второй уровень - сразу виды задач. У Разработчиков получилась "адская" смесь: и модули и виды задач.
Рубрикатор и наполнение разделов будут строиться так, чтобы пользователю приходилось прокручивать экран монитора по минимуму. То есть по мере наполнения экрана как разделами, так и ссылками будем создавать новую рубрику и переносить в неё часть рубрик (ссылок).

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

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



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

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

• Как создать физическую страницу
  
• Способ организации покупки без регистрации пользователя
  
• Решаем проблему такую-то через код в init.php
  
• И т.д.
  

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

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

Не будут публиковаться добавленные пользователями ссылки:

• не содержащие собственно контента, а только ссылки на другие источники. (Пример);
  
• на одну и ту же информацию, если она уже есть в БЗ;
  
• с однотипной информацией. То есть информация, отличающаяся незначительными деталями, не будет пропущена.
  
• из учебных курсов и документации.
  

Со временем и с накоплением опыта, возможно будет меняться подход к допуску ссылок. Рейтинг
Партнёрский отдел подумывает над системой учёта активностей пользователей нашего сообщества. Тема эта тоже не простая и когда будет (если будет) внедрена - не могу сказать (не знаю). Но в рамках этой системы обязательно будет учитываться активность пользователей в рамках Базы знаний (и, впоследствии, WikiBitrix). Для этого создан механизм рейтинга авторов. Рейтинг ведётся по двум номинациям: Автор контента и Автор ссылки.

• Автор контента - это тот, кто дал конкретный практический совет в сообщении форума или блога.
  
• Автор ссылки - это тот, кто добавил этот совет в нашу Базу знаний.
  

На данный момент выводится Топ20, впоследствии будет реализованы страницы с полным списком рейтинга.
Сотрудники компании 1С-Битрикс не участвуют ни в одной из номинаций.


Пример добавления ссылки

Вы читаете форум и находите в нём решение вашей проблемы. Скажем, такое сообщение:


Нажимаем Добавить в базу знаний, откроется форма добавления:



Адрес сообщения уже проставлен, осталось только добавить название, теги, выбрать раздел(ы), где показывать ссылку и, при необходимости, дать описание. Нажимаем Сохранить, и ссылка ушла на модерирование, а после него видна в выбранном вами разделе:



а в топе - новый участник: