7.8 C
New York
Monday, December 4, 2023

Upcoming webinar: Let’s discuss API docs: a dialogue about points impacting documentation for APIs


by Tom Johnson on Dec 3, 2023

classes:
api-doc

I am taking part in a webinar known as Let’s Discuss API Docs with Scott Abel, Mark Wentowski, and Kartik Balasubramanian on December 13 at 8am PST. The panel dialogue will cowl a big selection of matters, similar to limitations of autogenerated API documentation, safety in API docs, tailoring documentation to person wants. We additionally would possibly focus on challenges like standardizing API documentation in addition to alternatives for enhancing the developer expertise.

Let's talk API docs webinar

Right here’s the outline:

Let’s Discuss API Docs

Be part of us for “Let’s Discuss API Docs,” a dynamic discuss present devoted to the intricacies and greatest practices of documenting Software Programming Interfaces (APIs). Whether or not you’re a developer, technical author, or API fanatic, this present provides precious insights and discussions on a variety of important matters.

Panelists for this present embody: Tom Johnson (Senior Technical Author at Google), Mark Wentowski (an veteran technical writing marketing consultant with expertise creating developer docs), and Kartik Balasubramanian (a London, England-based Director of Technical Documentation at monetary expertise agency, Beacon Platform).

“Let’s Discuss API Docs” is a must-watch for builders, technical writers, and API lovers, providing insights on essential matters like:

  • Assessing autogenerated API documentation and its limits.
  • Tackling safety in API docs, specializing in entry management and privateness.
  • Tailoring API Docs to satisfy person wants.

Challenges we’ll discover embody:

  • Standardizing API documentation.
  • Refining content material fashions and search options.
  • Aligning docs with developer duties.
  • Weighing design-first vs code-first approaches.
  • Implementing search engine optimisation in API documentation.

Alternatives we’ll focus on:

  • Innovating for higher person experiences in documentation.
  • search engine optimisation methods to make APIs extra discoverable.
  • Creating developer-friendly documentation.
  • Utilizing cognitive neuroscience for higher design.

Plus, we’ll share high sources like lessons, books, blogs, and insights from API Docs consultants.

Register for the webinar right here

About Tom Johnson

Tom Johnson

I am an API technical author based mostly within the Seattle space. On this weblog, I write about matters associated to technical writing and communication — similar to software program documentation, API documentation, AI, data structure, content material technique, writing processes, plain language, tech comm careers, and extra. Take a look at my API documentation course should you’re on the lookout for extra information about documenting APIs. Or see my posts on AI and AI course part for extra on the newest in AI and tech comm.

Should you’re a technical author and need to carry on high of the newest tendencies within the tech comm, remember to subscribe to e mail updates beneath. You too can be taught extra about me or contact me. Lastly, word that the opinions I specific on my weblog are my very own factors of view, not that of my employer.



Supply hyperlink

Related Articles

LEAVE A REPLY

Please enter your comment!
Please enter your name here

Latest Articles