Go to main content

Dokumentační portál pro Kontent.ai

Dokumentační portál pro Kontent.ai

Kontent.ai je nástroj pro správu obsahu využívaný mimo jiné vývojáři. Ti pro efektivní práci potřebují kvalitní dokumentaci. Dosavadní technické řešení dokumentace bylo postavené na službě třetí strany, která přestala být dostačující potřebám specialistů, kteří Kontent.ai dokumentují. Kontent.ai se rozhodlo vytvořit vlastní dokumentační portál tak, aby vyhovoval 100% jejich potřebám. Mě oslovili jako vývojáře pro tento projekt.

Projekt měl několik milestonů a výzev, kterými jsme si s klientem prošli:

  • Vytvořit část webu zprostředkovávající vývojářům tutoriály.
  • Zajistit integraci nástrojů pro generování a zobrazování API referencí.
  • Zaimplementovat přihlašování, e-learningový systém a další integrace.
  • Optimalizovat výkon webu.

  • Tutoriálová část

    V rámci této části bylo třeba vytvořit:

    • Základ webu, který bude rozšiřitelný o libovolný obsah nebo integraci služby třetí strany. To se povedlo s užitím platformy Node.js a serveru Express.js.
    • Sekci, která prostřednictvím tutoriálů provede čtenáře důležitými scénáři v rámci Kontent.ai. Díky jasné představě klienta o výsledku a kvalitnímu namodelování obsahu se toto také podařilo.

  • Integrace nástrojů pro generování a zobrazování API referencí

    Interní vývojáři na straně klienta vyvinuli službu, která doručuje API reference podle OpenAPI specifikace. Mým úkolem bylo za využití této služby integrovat do webu nástroj Redocly a modifikovat ho dle přání klienta. Výsledkem je komplexní uživatelské rozhraní zprostředkovávající API reference v designovém jazyku Kontent.ai.

  • Integrace dalších služeb třetích stran

    • Auth0 pro přihlašování uživatelů do e-learningové části webu.
    • Talent LMS pro zprostředkování obsahu e-learningové části webu.
    • Jira pro sbírání zpětné vazby.
    • Algolia pro vyhledávání obsahu.

  • Optimalizace výkonu webu

    Jedním z cílů bylo zajistit co nejrychlejší odezvu webu vůči uživatelům. Proto jsme věnovali velké úsilí optimalizaci webu prostřednictvím CDN, cachování na straně serveru a optimalizacemi ve front-endové čáti.

Jan Cerman
Senior Content Developer v Kontent.ai

Milan nám v průběhu dvou let pomohl vybudovat dokumentační portál k SaaS produktu. Díky integraci portálu se službami třetích stran a průběžné optimalizaci jsme byli schopni zlepšit zákaznickou zkušenost při řešení problémů a poskytnout vyšší hodnotu při vzdělávání. Pokud hledáte vývojáře, který splní vaše (jakkoliv divoké) požadavky a pomůže vám zrealizovat vaši vizi, Milan je ten pravý.