Lukas R.Mar 4, 2024

One month to go ... looking forward to the "AI The Docs" conference from the #APItheDocs series about intersection of #APIs and #GenAI.

Some talk titles that stood out to me were "Writing for robots", "CLIs and LLMs", and "Supercharging customer integrations". I also expect something exciting behind the talk "Helping AI hallucinate".

Check out the conference website for more: https://apithedocs.org/ai-2024

AI The Docs | API the Docs

Let’s discover what AI trends are shaping in API documentation through practical examples and explore how organizations can adapt to stay at the forefront of innovation.

API the Docs
Lukas R.Feb 19, 2024
Generative #AI has the potential to change everything ... and #APIDocumentation is no exception! To talk about this, #Pronovix is running a special virtual conference on 3rd April as part of their #APItheDocs series to talk about this intersection: https://apithedocs.org/ai-2024
AI The Docs | API the Docs

Let’s discover what AI trends are shaping in API documentation through practical examples and explore how organizations can adapt to stay at the forefront of innovation.

API the Docs
lornajaneJun 7, 2023
What a treat, at #APItheDocs we’re getting the intro to open spaces from @kvantomme . It’s a great format and we’re in good hands today!
LanaJun 7, 2023
A great takeaway from Kristof Van Tomme’s talk - we aim for reusable things that become better from reuse - I think this is fair both for APIs and documentation #apithedocs
lornajaneJun 7, 2023
Great opening keynote at #APItheDocs this morning from Kristof Van Tomme. He’s bringing some great API economy philosophy, but this in particular struck me “APIs are essential for AI readiness”
LanaJun 6, 2023
Many developers didn't have prior experience of dealing with a tech writer so they are asking "Who are you?" - "A tech writer" - "Ok, so what do you do exacly?"
Great talk by Lisa about technical writer role in a startup. Spoiler: it is important! #apithedocs
LanaJun 6, 2023
Sidney Maestre’s great advice of how to understand which code examples to put into your documentation when you can't do everything everywhere all at once #apithedocs
lornajaneJun 6, 2023

Today's talk is "OpenAPI for Documentarians" at #APItheDocs in Amsterdam. I show the OpenAPI document structure as a block representation, and give some tips on tools that can help writers to wrangle the API descriptions.

Slides are available: https://noti.st/lornajane/4Ojem2
Feedback is gratefully received!

OpenAPI for Documentarians by Lorna Jane Mitchell

OpenAPI descriptions are an excellent way of having all information about an API in one place, and making that available to many different tools. As a standard, it can be difficult to get started with, and the resulting files are often large and unwieldy. In this session, you’ll get an overview of the structure of OpenAPI descriptions, details on taking advantage of OpenAPI features to create documentation, and some tips on working around common problems. We’ll look at some of the tools available to help you through various stages of the API lifecycle, and how these fit into your documentation workflow. This session is recommended for technical writers, engineers, technical leaders and anyone else wanting to make their APIs a better place for developers.

LanaJun 6, 2023
Lorna @lornajane gave a perfect dive into the openAPI spec structure, this should be studied at junior tech writers schools #apithedocs
LanaJun 6, 2023
Sort of cunning idea from @chrischinchilla Why not include components from frontend to a documentation, so there is no need to make screenshots anymore? #apithedocs #dynamicdocumentation