“#APIs can boost business because it prepares you for digital ecosystems” - @KoenAdolfs. If you would like to know… https://t.co/Y9l5IGI37w
This talk was presented at API The Docs Virtual 2022 event series on 9 November. We are glad to present the video recording, slide deck and talk summary below. Enjoy!
Visit the talk listing page for an overview of all presentations!
DevX at Phyllo
In the case of web APIs, a plethora of frameworks and tools are available that can help you write, test, and render the API specifications. But how can you build documentation around non-REST APIs? How to structure such content? How to design it in a better way? Technical writers face such problems and dilemmas daily, but designers and developers are also involved in the issue.
Creating useful documentation is hard, because it should provide all the necessary information, and it also has to be:
Creating useful documentation for Frontend SDKs or UI features is even harder. Especially, if you have to offer version-controlled and searchable docs for multiple such SDKs, based on different frameworks, under rapid, uncoordinated development with enhancements and breaking changes.
Information architecture and good writing are equally important.
Show, don’t tell. Design for developers!
“#APIs can boost business because it prepares you for digital ecosystems” - @KoenAdolfs. If you would like to know… https://t.co/Y9l5IGI37w
What should be the purpose of your #APIprogram? When does it become successful? Stay tuned because the new podcast… https://t.co/Z1GmsLUnA5
RT @APItheDocs: 🥁 Early-bird tickets are available for #APItheDocs #Amsterdam🥁 Save your spot and register for the 2-day conferenc… https://t.co/rFieLnreop
🥁We're launching a new #podcast series🥁 @kvantomme interviews guests from leading #API teams to explore a more hol… https://t.co/CT7UUXAxFc
They airdropped me $GPT WTH @wild_trent @SADA @Bitathon1 @SolarBrad14 @sainathyarra @pronovix @LFlecchia @luqmaansu… https://t.co/R5TSa9RGf2