Knowspread dokumentace

Tato dokumentace slouží k pochopení toho, jak se Knowspread používá, konfiguruje, integruje a udržuje. Stejné produktové koncepty jsou popsané v různé hloubce pro různá publika:

• klienty a potenciální klienty, kteří potřebují praktické návody,
• vlastníky projektu, kteří řeší rollout, QA a provozní kontrolu,
• integrátory, kteří potřebují API kontrakty a synchronizační pravidla,
• interní tým, který potřebuje architekturu, hraniční případy a zdroj pravdy.

Pokud se stránka opírá o kód nebo generované artefakty, má uvádět zdroj a podle možností i commit nebo prostředí, proti kterému byl text ověřen.

Začněte tady

Role nebo potřeba	Kam jít	Co tím získáte
Klientský stakeholder	Klientská dokumentace	Produktové pojmy, průběh nasazení, správa uživatelů, reporting.
Vlastník projektu	Owner runbook	Launch checklist, rutinní kontroly, riziková místa, podklady pro eskalaci.
Administrátor	Uživatelé a skupiny	Role, stavy, skupiny, přiřazení a obvyklé hraniční případy.
Integrátor	API a integrace	Oblasti REST API, identifikátory, webhooky, ošetření chyb.
Vývojář nebo insider	Přehled architektury	Hlavní aplikační povrchy, doménové toky a vstupy do kódu.
Reviewer	QA a akceptace	Testovací scénáře z pohledu uživatele a akceptační kritéria.

Základní mapa produktu

flowchart LR
  CompanySpace[Company Space] --> Users[Uživatelé]
  CompanySpace --> Groups[Skupiny]
  CompanySpace --> CICS[Obsah v prostoru]
  Groups --> Assignments[Přiřazení obsahu]
  Users --> Assignments
  CICS --> Assignments
  Assignments --> Participation[Studium uživatele]
  Participation --> Reporting[Reporting a certifikáty]
  CICS --> Marketplace[Marketplace a licence]

Vyspělost dokumentace

Každá důležitá oblast produktu by měla postupně mít čtyři vrstvy:

Vrstva	Účel
Uživatelský návod	Co klient nebo student dělá v UI.
Owner guide	Jak vlastník nastavuje, kontroluje a řídí danou oblast.
QA guide	Jak chování ověřit před rolloutem nebo po změně.
Interní poznámky	Architektura, invarianty, zdrojové soubory a známé hraniční případy.

Do tohoto repozitáře nepatří produkční aplikační kód, migrace ani krátkodobé pracovní poznámky bez vztahu k dlouhodobé dokumentaci.