Technical Writing Portfolio

Paulo Duarte

Senior Technical Writer · API Documentation & Developer Experience

API docs developer experience documentation-as-code Python IELTS 8.5 Porto Alegre, Brazil
About
About this portfolio
Three production-grade API documentation samples, each written to the standard I apply at work: conceptual overview, guidance on when not to use the feature, a complete runnable example, a full reference section, and practical troubleshooting.
Background
I lead a team of technical writers at a fitness-tech SaaS, driving a Doc-as-Code migration and an AI-assisted documentation quality system. My background includes 11 years of technical translation and 7 years of English teaching.
Documentation samples
01
Anthropic API  ·  2023-06-01  ·  claude-sonnet-4-6
Implementing Streaming Responses with the Claude API
Covers the SSE model, when not to stream, synchronous and async Python with the Anthropic SDK, a complete runnable example, SSE event-type reference, SDK helper methods, and 9 troubleshooting scenarios.
SSE / streaming Python SDK asyncio curl
→ 02
GitHub REST API  ·  v2022-11-28
Personal Access Tokens vs GitHub Apps
Decision guide for GitHub API authentication. Covers fine-grained PATs, classic PATs, GitHub App JWT generation and installation token exchange, rate-limit comparison, governance trade-offs, and two complete runnable scripts.
authentication JWT OAuth rate limits
→ 03
Stripe API  ·  2024-06-20
Stripe Webhooks: From Setup to Production
End-to-end guide covering signature verification, idempotency via thread-safe per-request connections, per-type event dispatch, --backfill reconciliation mode, production checklist, and 7 troubleshooting scenarios.
webhooks idempotency Flask SQLite / PostgreSQL
→
Writing principles
01 —
Decide first, describe second
Every doc includes a "when not to use" section. A developer who picks the wrong tool because the docs never warned them will not come back.
02 —
Code that runs
Every complete example is a script you can copy, set an env var, and run. No placeholders that silently break, no imports that don't resolve.
03 —
Troubleshooting as first-class
If a developer hits an error at 11 pm, the troubleshooting section is the most-read part of the doc. It gets the same attention as the happy path.
04 —
Prose over bullets
Lists are for reference. Explanations are for prose. The gap between a parameter table and an explanation of what those parameters mean together is where most docs fail.