The API Changelog
Subscribe
Sign in
Home
News
Opinion
Documentation
iPaaS
Archive
About
Documentation
Documenting API Changes
Should you document all your API changes?
Apr 12
•
Bruno Pedro
Share this post
Documenting API Changes
apichangelog.substack.com
Copy link
Facebook
Email
Note
Other
Is AI the End of API Documentation?
How can you take advantage of AI to enhance your API documentation?
Mar 29
•
Bruno Pedro
3
Share this post
Is AI the End of API Documentation?
apichangelog.substack.com
Copy link
Facebook
Email
Note
Other
How Breaking Changes Affect API Documentation
API consumer experience is degraded whenever documentation diverges from reality
Mar 15
•
Bruno Pedro
Share this post
How Breaking Changes Affect API Documentation
apichangelog.substack.com
Copy link
Facebook
Email
Note
Other
1
Two Ways to Influence Business Growth with API Documentation
How can you drive business results with good API documentation?
Mar 1
•
Bruno Pedro
2
Share this post
Two Ways to Influence Business Growth with API Documentation
apichangelog.substack.com
Copy link
Facebook
Email
Note
Other
Is API Documentation Marketing?
The parallel between the 4Ps marketing framework and API documentation
Feb 16
•
Bruno Pedro
3
Share this post
Is API Documentation Marketing?
apichangelog.substack.com
Copy link
Facebook
Email
Note
Other
The Hard Things about Naming Things
Using familiarity, identity, and consistency to pick the right names for API operations
Feb 2
•
Bruno Pedro
2
Share this post
The Hard Things about Naming Things
apichangelog.substack.com
Copy link
Facebook
Email
Note
Other
Why API Tutorials Matter
Why should you offer an API tutorial if most developers are just looking for quick answers?
Jan 19
•
Bruno Pedro
7
Share this post
Why API Tutorials Matter
apichangelog.substack.com
Copy link
Facebook
Email
Note
Other
2
Concrete vs. Abstract API Examples
Both types of API examples have their utility and differences regarding their implementation
Jan 5
•
Bruno Pedro
3
Share this post
Concrete vs. Abstract API Examples
apichangelog.substack.com
Copy link
Facebook
Email
Note
Other
Three Open-Source API Reference Alternatives
It all comes down to what you want to achieve with your API reference
Dec 22, 2023
•
Bruno Pedro
2
Share this post
Three Open-Source API Reference Alternatives
apichangelog.substack.com
Copy link
Facebook
Email
Note
Other
Five Elements of Good API Documentation
Writing good API documentation can be harder than building the API itself. Let's look at the five elements that any good API documentation should have.
Dec 8, 2023
•
Bruno Pedro
7
Share this post
Five Elements of Good API Documentation
apichangelog.substack.com
Copy link
Facebook
Email
Note
Other
Share
Copy link
Facebook
Email
Note
Other
This site requires JavaScript to run correctly. Please
turn on JavaScript
or unblock scripts