Dokumentacja API - trendy
API nAPIera 馃槈 Czego si臋 spodziewa膰 i na czym wzorowa膰 tworz膮c tego typu dokumentacj臋? Wygrzebali艣my dla Was troch臋 przydatnych informacji.
Je艣li nie zetkn臋li艣cie si臋 jeszcze z tematyk膮 - nieskromnie polecamy nasze wprowadzenie.
B臋dziemy o tym pisa膰 coraz cz臋艣ciej. Dlaczego? Dlatego, 偶e Application Programming Interfaces to w tej chwili jeden z najbardziej gor膮cych trend贸w w 艣wiecie technologii.
Three-quarters of organizations are developing both internal and public-facing APIs
To cytat z bardzo ciekawego raportu "The State of API 2019", publikowanego przez firm臋 SmartBear. Podobnie jak ten:
More investment in API documentation can help API providers offer a great developer experience
Polecamy ten dokument Waszej uwadze, a w szczeg贸lno艣ci strony 39-43, czyli podrozdzia艂 "API Documentation and Usability"!
Ca艂o艣膰 raportu jest dost臋pna ca艂kowicie za darmo tutaj.
Znaj膮c Wasze lenistwo wklejamy kilka najciekawszych wykres贸w 馃槈
Jak wida膰 warto si臋 zainteresowa膰 tematem.
W艣r贸d techwriterskiej braci niekwestionowanym liderem, prekursorem i ekspertem w dokumentowaniu API jest Tom Johnson, prowadz膮cy stron臋 I'd Rather Be Writing, niejednokrotnie ju偶 wspominany na naszych 艂amach.
Tom przeprowadza swoj膮 ankiet臋 w艣r贸d os贸b zajmuj膮cych si臋 dokumentowaniem API i na bie偶膮co publikuje jej rezultaty:
Trends in developer documentation 2020
Przyk艂adowe rezultaty dotycz膮ce narz臋dzi wykorzystywanych podczas tworzenia dokumentacji dla programist贸w:
Ale偶 Przydatne Informacje (API) chcia艂oby si臋 krzykn膮膰! 馃槉
Przy okazji - je偶eli tworzycie tre艣ci dla programist贸w, albo znacie kogo艣 kto si臋 tym zajmuje - pom贸偶cie zebra膰 wi臋cej danych do tego raportu. Wystarczy kilka minut aby wype艂ni膰 ankiet臋 - pode艣lij kole偶ance/koledze!
Na koniec 艂apcie kilka fajnych przyk艂ad贸w dokumentacji API wraz z uzasadnieniem specjalisty:
https://nordicapis.com/5-examples-of-excellent-api-documentation/
Nie s膮 mo偶e naj艣wie偶sze, ale wci膮偶 prezentuj膮 pewien (ponadprzeci臋tny) poziom, do kt贸rego wi臋kszo艣膰 firm stara si臋 dopiero doj艣膰. Czego i Wam 偶yczymy 馃槉
P.S. Zapraszamy na nasz profil na LinkedIn!