Začínáme s dokumentací

Vítejte v naší centrální znalostní bázi. Tento dokument vám poskytne kompletní přehled o tom, jak efektivně pracovat s naším systémem. Najdete zde návody, ukázky kódu a doporučené postupy.

Co je Knowledge Base?

Knowledge Base je centralizovaný systém pro správu a sdílení znalostí v rámci organizace. Umožňuje strukturovanou organizaci dokumentace, rychlé vyhledávání v obsahu a verzování změn.

Pro rychlé vyhledávání použijte klávesovou zkratku Ctrl + K.

První kroky

Než začnete pracovat se systémem, ujistěte se, že máte splněny následující předpoklady:

Systémové požadavky

Pro běh aplikace potřebujete:

  1. Operační systém: Windows 10+, macOS 10.15+, nebo Linux
  2. Node.js verze 18.0 nebo vyšší
  3. Minimálně 4GB RAM (doporučeno 8GB)
  4. 1GB volného místa na disku

Instalace

Instalaci provedete pomocí následujícího příkazu:

# Instalace pomocí npm
npm install @knowledge/base

# nebo pomocí yarn
yarn add @knowledge/base

Ověření instalace

Po instalaci můžete ověřit správnost nastavení:

# Zobrazení verze
kb --version

# Spuštění diagnostiky
kb doctor

Konfigurace

Základní konfigurace se provádí v souboru kb.config.js:

// kb.config.js
module.exports = {
  name: 'Moje dokumentace',
  baseUrl: 'https://docs.example.com',
  language: 'cs',
  
  search: {
    enabled: true,
    indexOnBuild: true
  }
};

Proměnné prostředí

Proměnná Popis Výchozí hodnota
KB_PORT Port aplikace 3000
KB_HOST Hostname localhost
KB_API_KEY API klíč —

Práce s obsahem

Obsah dokumentace je strukturován do témat a podtémat. Každé téma může obsahovat:

Nadpisy
Strukturované pomocí H1-H6 pro hierarchickou organizaci
Odstavce
Základní textový obsah s podporou formátování
Kód
Inline kód a bloky kódu se zvýrazněním syntaxe

Ukládání a verzování

Všechny změny v dokumentaci jsou automaticky verzovány:

Zobrazit historii změn
  • - Přidána sekce o konfiguraci
  • - Aktualizace instalace
  • - První verze dokumentu

Další kroky

Po úspěšné instalaci můžete pokračovat:

  1. Vytvořením prvního dokumentu v sekci Tvorba obsahu
  2. Nastavením týmových oprávnění v Správa uživatelů
  3. Integrací s externími nástroji v sekci Integrace

Glosář termínů

API
Application Programming Interface - rozhraní pro komunikaci mezi aplikacemi
Endpoint
Koncový bod API, URL adresa pro přístup ke konkrétní funkci
Webhook
Mechanismus pro asynchronní notifikace mezi systémy