База знаний Vibe

База знаний Vibe — это единое место для хранения информации о наших продуктах, процессах и внутренних регламентах.

База знаний ведется в Obsidian, а после публикации автоматически становится доступна на сайте https://kb.vibeapp.ru.

Что можно писать

В базе знаний можно создавать статьи практически на любые темы, связанные с работой компании, например:

• описание продуктов и сервисов;
• инструкции для сотрудников;
• описание бизнес-процессов;
• требования к новым функциям;
• регламенты;
• FAQ;
• инструкции для клиентов и партнеров;
• результаты исследований;
• техническую документацию.

Если вы несколько раз объяснили что-то коллегам в чате — скорее всего, это стоит оформить в виде статьи.

Требования для начала работы

Для работы потребуется:

1. Аккаунт на GitHub.
2. Установленный Git.
3. Установленный Obsidian.

Скачать Obsidian можно здесь: https://obsidian.md/download

Установка Git (разработчики могут пропустить)

Git используется для хранения истории изменений базы знаний и синхронизации ваших правок с остальной командой.

macOS

Если у вас установлен Homebrew:

brew install git

Windows

Скачайте установщик:

https://git-scm.com/download/win

Во время установки можно оставить все настройки по умолчанию.

Первоначальная настройка

1. Получите доступ

Убедитесь, что у вас есть доступ к репозиторию:

https://github.com/ticketscloud-open/vibe-kb

Если доступа нет — обратитесь к своему менеджеру.

2. Склонируйте репозиторий

Откройте Терминал (командную строку).

Перейдите в папку, где хотите хранить базу знаний. Например:

cd ~/Documents

Склонируйте репозиторий:

git clone https://github.com/ticketscloud-open/vibe-kb.git

Если при выполнении команд Git попросит авторизоваться, используйте свою учетную запись GitHub.

После завершения загрузки появится папка:

vibe-kb/

Именно её нужно будет открыть в Obsidian.

3. Откройте репозиторий в Obsidian

Откройте Obsidian.

Если окно выбора не появилось автоматически:

File → Open Vault

Выберите Open folder as vault и укажите папку скачанного репозитория.

После этого база знаний откроется в Obsidian.

Работа со статьями

На странице Obsidian есть базовый курс лекций как пользоваться программой.

Все статьи создаются и редактируются в папке content/. Изображения сохранять в папку content/assets. Obsidian использует Markdown синтаксис для редактирования текста.

Публикация изменений

Для синхронизации используется плагин Obsidian Git. После завершения работы:

1. Нажмите Cmd + P (на macOS) или Ctrl + P (на Windows).
2. Выполните команду: Git: Commit-and-sync

Для вызова командной панели (command pallete) можно также воспользоваться кнопкой >_ в панели слева

Obsidian автоматически:

• сохранит изменения;
• создаст Git-коммит;
• отправит изменения в репозиторий.

После этого GitHub автоматически соберет новую версию сайта.

Обычно публикация занимает несколько минут. Если спустя 5–10 минут изменения не появились на сайте, попробуйте обновить страницу браузера или очистить кэш.

Обновленная база знаний станет доступна по адресу: https://kb.vibeapp.ru

Советы

• Лучше написать небольшую статью сегодня, чем откладывать документацию “на потом”.
• Если информация изменилась — обновите существующую статью, а не создавайте новую.
• Если заметили устаревшую информацию — исправьте её или сообщите ответственному.
• Не бойтесь улучшать статьи других сотрудников: база знаний — общий инструмент всей команды.