DX Heroes logo
#ai
#technical-writing

Pojďme mluvit o AI #3: AI řešení reálných problémů

Délka: 

8 min

Publikováno: 

5. října 2023

Pojďme mluvit o AI #3: AI řešení reálných problémů

Tohle je poslední článek série a odpovídá na praktickou otázku: kde vám AI reálně ušetří čas? Podíváme se na technickou dokumentaci, marketing, organizaci práce, tvorbu grafiky a pár dalších úkolů. Aby to bylo konkrétní, projdeme si reálný projekt místo výčtu obecných výhod.

Reálný příklad: stavíme developer portál

Stavba a provoz developer portálů je velká část toho, co v DX Heroes děláme. Každý projekt má vlastní nároky, protože každý klient chce něco trochu jiného. Někdo chce mít nejdřív hotovou vizuální část. Jiný se nejvíc soustředí na hloubku a přesnost technické dokumentace. Obě cesty zaberou podobně práce a obě jsou nakonec stejně důležité.

Práce zpravidla stojí na třech lidech: technickém analytikovi, technickém spisovateli a programátorovi. Kde do toho zapadá AI? Pojďme se podívat.

Jak stavíme developer portál s AI

Každý developer portál stojí na specifikaci API. Ta umožňuje komukoli se správným oprávněním používat služby firmy. Kolem ní stavíte dokumentaci a návody, aby koncový uživatel věděl, jak služby volat. Z praxe už víme, co vytvořit, aby to bylo pro čtenáře co nejjednodušší.

Představte si typický výchozí stav: klient provozuje zastaralou specifikaci API s tenkou dokumentací a slabou grafikou portálu. Tady začíná naše práce a dělíme ji na fáze.

Modernizujeme

Prvním krokem je převést stávající specifikaci do formátu OpenAPI 3.0 Specification (OAS), pokud se to ještě nestalo. Má to několik důvodů.

Zaprvé, technologie se hýbou rychle. Starší formát Blueprint už nestíhá držet krok se současnými standardy, kdežto OAS vám umožní přidávat nové funkce snáz. Zadruhé, OAS je oborový standard. Zaručuje kompatibilitu, plynulou spolupráci a přináší velkou sadu osvědčených postupů. Zatřetí, OAS vám dá silnější rámec pro popis API, díky čemuž rychleji integrujete, máte méně chyb a přitáhnete víc pozornosti koncových uživatelů.

Tip: Můj oblíbený nástroj na převod jakékoli specifikace API je APIMatic: https://www.apimatic.io/solution/transformer

Opravujeme

Další krok je opravit chyby, které se objeví. Jako u všeho, automatická migrace málokdy proběhne bez problému. Chyby se vloudí a výsledek pořád musíte zkontrolovat ručně. Pomůže vám několik nástrojů, můj oblíbený je Spectral. Spectral načte celou specifikaci a označí každou chybu i varování. Vaše OAS je zrcadlem služeb, které nabízíte, takže se postarejte, aby bez vad odráželo reálný stav vašeho produktu.

Tip: Spectral vřele doporučuju na průběžnou kontrolu vaší OAS: https://github.com/stoplightio/spectral

Vysvětlujeme

Tady přichází AI. V téhle části se postaráte, aby zákazníci rozuměli všemu kolem služeb, které nabízíte: popisům, příkladům, návodům, vysvětlením na vyšší úrovni a spoustě dalšího. Napsat to vám pomůžou jazykové modely jako Jasper nebo ChatGPT. Trik je v tom, že model nejdřív naučíte na vašem projektu a teprve pak ho požádáte o technickou dokumentaci.

Dělám to v několika krocích a stejné doporučuju vám:

  1. Popište projekt, na kterém pracujete, a váš konkrétní cíl.
  2. Vysvětlete jazyk a formát, který chcete použít.
  3. Dejte příklad, jak má vypadat popis parametru.
  4. Určete, co od výstupu očekáváte.

Když si těmito kroky projdete, snadno se dostanete do bodu, kdy vám ChatGPT vygeneruje čistý popis pro zadané parametry. Ušetří to spoustu času a u toho nemusíte skončit.

Slyšeli jsme hodně pozitivní zpětné vazby na audiovizuální prvky, které uživatelům pomáhají pochopit produkt a způsob jeho použití. Nejlíp fungují doprovodná grafika nebo krátká videa. A tady je další bod pro AI. Videonávody dnes vytvoříte pomocí botů, kteří mluví víc než 30 jazyky a dialekty, což odbourá skoro všechny technické i jazykové bariéry. Bonus: znalosti o produktu už máte z dřívější konverzace s natrénovaným GPT, takže je rovnou využijete k napsání komentáře.

Tip: ChatGPT je samozřejmost, ale mrkněte i na Jasper a Synthesia, oba jsou pro tenhle krok hodně užitečné.

Publikujeme

Poslední krok je zveřejnit vaši práci. Marketing má svou váhu, takže se postarejte, aby se zákazníci o novinkách dozvěděli. I tady pomůže AI. Vyzkoušejte Rapide.ly, šikovný nástroj na marketing obecně i na plánování, jak novinky vytvořit a oznámit.

Tip: Posilněte svůj marketing dalším AI nástrojem: rapide.ly

Doufám, že teď máte jasnější představu, jak AI zapadá do světa OAS a technické dokumentace. Znáte nástroj, který jsme nezmínili? Dejte nám vědět.


Související čtení

Mohlo by vás zajímat:

Chcete být o krok napřed?

Nenechte si utéct naše nejlepší postřehy. Žádný spam, jen praktické analýzy, pozvánky na exkluzivní eventy a shrnutí podcastů přímo do vaší schránky.