#API #APIDocumentation #APIProductManagement #ProductManagement: "An engineering team member can perform a limited form of product management on a microservice. However, in all but the most minor or most trivial cases, the product management work requires a dedicated professional.

However, the rub is that not all product managers are created equal. When companies embark on an API transformation, they may reassign whatever product managers they already have employed. Or they post job hiring using whatever product management boilerplate lies within their HR systems, not thinking to customize for specific technical considerations. "They can learn the API bit on the job," the thinking goes, "others will do the technical stuff".

There are product virtuosos equally adept at creating great mobile apps, internal platforms, desktop experiences, or APIs. And there are many similarities between software product management and API product management. Several key differences also exist due to the nature of the products and the customers they serve. Individuals who can "do it all" equally effectively are few and far between.

These following subtle but significant differences can trip up otherwise competent product managers."

https://netapinotes.substack.com/p/why-are-api-product-managers-hard

#AI #GenerativeAI #Programming #Coding #ChatBots #SoftwareDevelopment #TechnicalWriting #APIDocumentation: "As if documenting code for one project weren’t enough, API technical writers must also support multiple projects simultaneously, often with different types of code. You might document a Java API for one project, a REST API for another project, some Go code for an SDK, some C++ code for another project, and so on. It can be nearly impossible to be fluent in all of these languages. Even keeping the terminology straight (a “function” in one language, a “class” is another, etc.) can be challenging.

Fortunately, you can use AI tools to learn code. AI tools can act like a friendly programming buddy who is sitting next to you, ready to explain anything you want, at whatever technical level you need. You can zero in on a specific question or broaden it out to increase your understanding from ground zero."

https://idratherbewriting.com/learnapidoc/docapis_ai_learn_coding.html

#AI #TechnicalWriting #SoftwareDocumentation #APIdocumentation #ShellScripting: "AI tools empower technical writers with scripting capabilities, whether it be shell scripts, Python scripts, CLIs available at your work, or more. In particular, shell scripting can help you automate parts of your build process that are tedious, making it easier to push docs through advanced build and publish processes. In a world of doc ops, where continuous builds and publishing are becoming the norm, tech writers need as much automation as possible with these processes."

https://idratherbewriting.com/learnapidoc/ai-tools-build-publish-api-docs.html

API Design Patterns: Best Practices for Building Resilient APIs - Introduction
API design patterns are essential for creating reliable, scalable, an... - https://readwrite.com/api-design-patterns-best-practices-for-building-resilient-apis/ #apidesignpatterns #apidocumentation #developerportal #apimarketplace #apigateways #restfulapis #apigateway #developer #apidesign #digital #tech #rest #api

It's a pleasure for us to help Canopy publish their API docs as a single source of truth, and generate "Aha!" moments for their users. #OpenAPI #APIDocumentation https://bump.sh/customers/canopy?utm_source=mastodon&utm_medium=social&utm_campaign=marketing

Intro to #API documentation - Tom Johnson (Idratherbewriting, Recording from API documentation workshop given in Los Angeles on Jan 23, 2020) #APIs #APIDocumentation #TechnicalWriting #SoftwareDocumentation https://www.youtube.com/watch?v=Ew3_sdRcEA0&t=1105s

#API #Documentation #APIDocumentation #TechnicalWriting: "For new users, two of the most important topics in API docs are the product overview and getting started tutorial. These two topics combine conceptual understanding with hands-on exploration. Together, these topics can ground users in a good understanding of your product and the confidence to implement it.

However, both of these topics are challenging. The product overview requires solid understanding of the whole product, described succinctly and clearly. Its content can overlap with marketing content and often has both engineering and business executive audiences. The getting started tutorial requires writers to handle an intricate balance of information — keeping the instructions brief enough to fit the end-to-end scope but also detailed enough for the user to be successful. The getting started tutorial needs to give the user success in working the product; this confidence will inspire the user to more advanced levels."

https://www.youtube.com/watch?v=6Reo17LxaS4

#APIs #APIDocumentation #Documentation #TechnicalWriting #APIs: "Can an API even be used without good documentation? While technically possible, it’s through API documentation best practices that developers first experience an API and get to know its functionality.

Whether your API is meant for internal use, exposed to partners, or fully public, developers will need both complete and accurate REST and OpenAPI documentation examples to best complete their integrations.

In this API documentation guide, we’ll cover the basics of how to document APIs and different types of documentation. We will also cover the basics of the commonly asked question ‘what is API documentation?’ in detail with examples.

This guide will also include exploring what you will need in your API documentation template and how this translates into creating your first API documentation sample. We’ll also cover and look into API description documents examples."

https://stoplight.io/api-documentation-guide

#APIs #APIDesign #APIDocumentation #TechnicalWriting #UX: "The programmatic equivalent of UX Writing is API Design. The words that you use to describe your API enable conversations between software and people - it’s just a bit more structured and mechanical. That’s why technical writers are uniquely suited to assist technical teams in doing API design, especially when an API First design approach is being followed.

The above is the abstract from my talk When documenting is designing: How to assist API design as a technical writer from Write the Docs Prague."

https://passo.uno/posts/how-to-assist-api-design-as-a-technical-writer/

Bump.sh plays a key role in helping us publish always up-to-date API documentation says @memobank https://bump.sh/customers/memobank?utm_source=mastodon&utm_medium=social&utm_campaign=memobank_casestudy #apidocumentation #RESTAPI

#OpenAPI 3.0 lets us automate nearly everything and benefit from all that is developed around this standard, says Memo Bank https://bump.sh/customers/memobank?utm_source=mastodon&utm_medium=social&utm_campaign=memobank_casestudy
#apidocumentation

#TechnicalWriting #API #APIDocumentation #SoftwareDocumentation #TechnicalWriter: "As you know from our other videos on technical documentation, writing docs is an extremely important part of creating software that users will love. But what if developers are the users? Let’s talk about API documentation and why it matters"

https://www.youtube.com/watch?v=39Tt1IkLiQQ&t=223s