Documentation
2026 (2)
Mar 10
An API is only as good as its documentation
Teams often treat documentation as an afterthought to be finished after the code is done. This leads to docs that explain what the code does …
Mar 9
An API portal should be a tool, not a brochure
Many companies build expensive portals that are full of marketing text but lack basic search and testing tools. If a developer cannot find …
2025 (2)
2024 (4)
Apr 25
I’m writing a piece about how documentation can also be a source of friction. Documentation has its undeniable value, especially when it …
Jan 5
Found at “Concrete vs. Abstract API Examples - by Bruno Pedro” on 2024-01-05 15:45:07 +01:00. Some people prefer examples that are concrete …
Jan 5
Found at “diataxis-documentation-frameworkreference.rst at 61f9129ca8789f4bab65993fc4c092fa55e2bdf9 · …
Jan 5
Found at “matheusfelipeogbeautiful-docs: Pointers to useful, well-written, and otherwise beautiful documentation.” on 2024-01-05 14:45:59 …
2023 (3)
Dec 9
Found at “Five Elements of Good API Documentation - by Bruno Pedro” on 2023-12-09 23:20:50 +01:00. Writing good API documentation can be …
May 19
Found at “What’s Next for API Portals? | Postman Blog” on 2023-05-19 09:55:14 +02:00. Establishing a single portal for API discovery is a …
Jan 27
Found at “Data Flow Diagram” on 2023-01-27 11:01:05. The tighter fit between modeling language and problem domain creates better …