Maintain consistent, precise terminology throughout API documentation and interfaces. Avoid ambiguous or misleading terms that could confuse developers about the API's behavior, and use professional language that clearly communicates the intended functionality.
Maintain consistent, precise terminology throughout API documentation and interfaces. Avoid ambiguous or misleading terms that could confuse developers about the API’s behavior, and use professional language that clearly communicates the intended functionality.
Key practices:
Example of improved terminology:
// Instead of: "Managing async signals with Resources API"
// Use: "Managing async data with Resources API"
// Instead of: "battle-tested libraries like Zod"
// Use: "popular open-source libraries like Zod"
// Instead of: "You can define an http resource"
// Use: "You can define an HTTP resource"
This ensures developers have a clear, unambiguous understanding of API capabilities and constraints, reducing integration errors and improving the overall developer experience.
Enter the URL of a public GitHub repository