Jak postavit developerský portál, který budou vývojáři milovat

Prokop Simek
DX Heroes CZ
Published in
4 min readApr 23, 2021

Developerský portál je místo, kde vývojáři najdou všechny potřebné informace pro implementaci daného produktu či služby. Pokud je správně vytvořený, usnadní jim jejich práci, stejně jako ji ten špatný může pěkně zkomplikovat. Zároveň platí, že čím srozumitelnější, a tím pádem oblíbenější váš dev portál je, tím lépe pro váš business. Uspokojit tuto náročnou skupinu uživatelů není lehké, ale díky přívětivému produktu se vám to může podařit.

Developer Portal

Jak poznat dobrý developerský portál

Nejste si jistí, jak by měl vypadat váš plánovaný dev portál? Nebo jak je na tom ten stávající? Podívejte se na něj jako jeho uživatel a upřímně si zhodnoťte důležité ukazatele. Nebo si přizvěte samotné vývojáře a zeptejte se jich, jak se jim s portálem pracuje. Co sledovat? Business value, UX či informační strukturu. S přesným hodnocením vám pomohou následující otázky.

  • Jsou na portále vysvětleny benefity, které řešení přináší?
  • Jak rychlý je onboarding? Je nutná registrace pro nastudování materiálů?
  • Jak portál vypadá a funguje? Je přehledný? Ví uživatel, kde začít a jak splnit svůj cíl?
  • Existuje testovací prostředí? Jsou na něm data koncepčně podobná těm produkčním?
  • Je orientace v rámci portálu snadná, má logickou strukturu?
  • Dozví se uživatel informace (úskalí a specifika) ve správný čas na správném místě?

Jak postavit dobrý developerský portál od nuly

V DX Heroes jsme si všichni prošli vývojem, a proto z vlastní zkušenosti víme, jak by měl developerský portál vypadat a jaké atributy by měl mít, aby se s ním vývojářům dobře pracovalo. A jak při jeho tvorbě postupujeme? Položíme si následující otázky a odpovědi na ně nám pomohou při postupu vytváření.

1. Stanovení business cíle portálu

  • Má kromě informační hodnoty sloužit i jako businessový (lead) kanál?

2. Definice koncového uživatele

  • Kdo je typickým uživatelem? Je to pouze vývojář? Nebo i jiné role, jako například analytik nebo produktový manažer? Jaká je nejméně technická role?

3. Business web vs. dev portál

  • Jak jsou tyto dva kanály propojeny?
  • Kde končí business web a začíná dev portál?

4. Určení rozpočtu

  • Jak velký či malý rozpočet bude? Jeho výše ovlivňuje scope a funkce portálu (např. malý budget nedává prostor pro sandbox).

Důležité informace máme, jak dál?

1. Definice tech stacku

  • Jedná se zpravidla o React nebo Next.js + integrace na backend klienta.

2. Analýza a vytvoření struktury

  • Navrhneme portál tak, aby na sebe stránky a informace navazovaly.

3. Vydefinování a napsání návodů

  • Identifikujeme a připravíme návody s ohledem na to, že je potřeba, aby se uživatel dozvídal info včas.

4. Sepsání copy pro landing page

  • Texty musí být srozumitelné a rezonovat s cílovou skupinou.

5. Vyladění API reference

  • Jasné vysvětlení parametrů a atributů komunikace.
  • Pokud je to žádoucí, dát rovnou možnost si API vyzkoušet (např. cURL)

6. Vytvoření UI

  • Prototypizace na základě vytvořených materiálů se všemi elementy.

Jak upravit stávající developerský portál

Dev portál už máte, ale nevyhovuje nárokům a požadavkům vývojářů i vás? Stačí upravit ten stávající. Jak to děláme?

1. Stanovení business cíle portálu

  • Má kromě informační hodnoty sloužit i jako businessový (lead) kanál?

2. Definice koncového uživatele

  • Kdo je typickým uživatelem? Je to pouze vývojář? Nebo i jiné roli, jako například analytik nebo produktový manažer? Jaká je nejméně technická role?

3. Určení rozpočtu

  • Jak velký či malý rozpočet bude? Jeho výše ovlivňuje scope a funkce portálu (např. malý budget nedává prostor pro sandbox).

A co dál?

1. Definice tech stacku

  • S klientem zvážíme, zda použít existující texty v novém řešení, nebo jestli rozvíjet existující tech stack.

2. Analýza a úprava struktury

  • Zjistíme, zda na sebe stránky a informace navazují, případně upravíme strukturu.

3. Vydefinování a dopsání návodů

  • Identifikujeme a sepíšeme dodatečné návody a aktualizujeme ty původní tak, aby se uživatel dozvídal info včas.

4. Úprava copy pro landing page (pokud existuje)

  • Texty musí být srozumitelné a rezonovat s cílovou skupinou.

5. Vyladění api reference

  • Jasné vysvětlení parametrů a atributů komunikace.
  • Pokud je to žádoucí, dát rovnou možnost si API vyzkoušet (např. cURL)

6. Vytvoření UI

  • Prototypizace na základě vytvořených materiálů se všemi elementy.

Chcete zjistit, jak je na tom váš developerský portál, nebo se poradit, jak postavit úplně nový na zelené louce? Ozvěte se nám a společně se domluvíme, jak bychom vám mohli pomoci. Doporučíme vám, jak by měl portál vypadat a fungovat, a pomůžeme s jeho tvorbou.

API portal

--

--