Multi-language examples where applicable
Why it matters
REST APIs and multi-language SDKs with examples in only one language silently exclude entire developer audiences. A Python backend engineer evaluating your API should not have to mentally port JavaScript examples; a mobile developer working in Swift should not need to read curl to figure out a request shape. The cost is measurable in rejected integrations, drive-by support tickets ("how do I do this in Go?"), and underperforming SDKs whose docs languish behind the flagship language.
Severity rationale
Low because missing language coverage is a discoverability friction, not a broken integration.
Remediation
Add at least two language examples to every API reference page — typically curl plus the primary SDK language. Use a tabbed code block component or sequential fenced blocks in docs/api/*.md. Example:
curl -X POST https://api.example.com/users \
-H "Authorization: Bearer $TOKEN" \
-d '{"name":"Jane"}'
user = client.users.create(name="Jane")
For SDK docs, each published SDK gets its own example section.
DetectionPro
The detection method for this pattern is part of AuditBuffet Pro.
The full method (what to look for, pass and fail conditions, and how results get reported) ships inside the Developer Documentation Audit. The pattern definition, severity rationale, and remediation remain openly licensed under CC-BY-4.0.
Taxons
History
- 2026-04-18·v1.0.0·Initial import from developer-documentation·automated