База знаний для компании

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

Обновлено
В этой статье

Что положить в базу в первую очередь#

  • как устроена компания: команды, кто за что отвечает, к кому с каким вопросом;
  • регламенты и процессы: отпуск, закупки, доступы, выпуск релиза;
  • инструкции по продукту для поддержки и продаж;
  • технические решения и их причины;
  • ответы на частые вопросы новичков.

Начинай с того, о чём спрашивают чаще всего. Хорошая первая страница — та,
ссылку на которую ты уже трижды отправлял в чат.

Структура#

Раздел — папка, страница — markdown-файл. Удобно делить по потребителю:
«Для всех», «Разработка», «Поддержка», «Продажи». В корне — README с
оглавлением.

У каждой страницы — владелец#

Файл CODEOWNERS в репозитории назначает ответственных за разделы: изменение
в «Регламентах» не пройдёт мимо того, кто за них отвечает. Так у страницы
появляется хозяин, который следит, чтобы она не устарела.

Изменения — через согласование#

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

Доступ#

База — закрытый репозиторий организации. Доступ выдаётся командам с ролями:
просмотр, разбор задач, правка, сопровождение. Журнал действий организации
показывает, кто что делал.

Ограничения, о которых стоит знать#

Поиска по тексту всех страниц пока нет — навигация идёт через оглавления и
ссылки. Визуального редактора с макросами нет — страницы пишутся в markdown.
Совместной правки в реальном времени нет. Почтовых уведомлений нет —
уведомления приходят во входящие на сайте.

С чего начать#

Создай организацию, закрытый репозиторий «База знаний», README с
оглавлением и файл CODEOWNERS. Попроси каждую команду за неделю описать
три самых частых вопроса к ней — так база сразу начнёт отвечать на реальные
вопросы.

Попробовать на своей задаче

Создай репозиторий — история изменений, задачи и запросы на слияние будут с первого дня.

Создать репозиторий

Было полезно?

Ещё сценарии

База знаний для сотрудников База знаний для сотрудников решает одну задачу — чтобы новый человек нашёл ответ сам, не отвлекая коллег. Лучше всего с этим справляется не огромная энциклопедия, а понятный маршрут — что прочитать в первый день, что в первую неделю, как проверить, что всё понятно. Личная база знаний Личная база знаний — это не архив всего прочитанного, а набор твоих собственных записей, связанных между собой, к которым ты возвращаешься. Разберём, как её устроить, чтобы она работала, а не превратилась в свалку ссылок. Аналог GitLab Если GitLab нужен тебе ради репозиториев, задач и ревью кода, а поддерживать свой сервер не хочется, Skillok закрывает эту часть. Если же ты живёшь в GitLab CI и реестре пакетов — честно говоря, это пока не про нас. Разберём, что совпадает и что нет. Приложение для конспектов Хороший конспект нужно не только написать, но и перечитывать, дополнять и находить через год. Для этого подходят обычные markdown-файлы с формулами и схемами, разложенные по предметам и хранящие историю правок. Вот как вести конспекты у нас. Где вести заметки Место для заметок выбирают один раз, а живут с ним годами. Важно не количество функций, а три вещи — заметки легко найти, их не жалко потерять при смене сервиса, и видно, как они менялись. Разберём варианты и что предлагаем мы. LMS для небольшой команды Полноценная LMS — это десятки функций, большая часть которых небольшой команде не нужна. В Skillok учебная часть собрана из немногих вещей — курсы с автопроверкой, материалы с историей и задания с ревью. Ниже — что именно есть, чтобы ты решил, хватит ли этого.

Ещё темы

Дизайн и 3D Как изучить Blender с нуля Blender — бесплатная программа для трёхмерной графики, в которой есть моделирование, скульптинг, материалы, анимация и рендер. Новичков пугает интерфейс и обилие горячих клавиш, но за первые две-три недели он становится привычным. Эта статья — про саму программу: как в ней ориентироваться и в каком порядке проходить её разделы. Профессиональные навыки Как изучить Excel с нуля Excel осваивается быстрее всего на собственных данных: домашнем бюджете, списке задач, выгрузке с работы. За шесть недель по часу в день можно дойти от первых формул до сводных таблиц и диаграмм. Ниже порядок тем, упражнения и способы понять, что тема действительно усвоена. Музыка Как изучить сольфеджио самостоятельно Сольфеджио — это две вещи сразу: музыкальная грамота (как записана музыка) и слух (как узнавать и воспроизводить то, что записано). Грамоту взрослый осваивает за несколько недель, слух растёт медленнее, зато его можно тренировать по десять минут в день. Ниже план на полгода, порядок тем и задачи для самопроверки.