Briefle words · Code & architecture
Naming convention
An agreed, team-wide pattern for how things are named, so names are predictable and the code reads as one consistent whole.
Say it to an AI
JS API client workoutApi wrapping our http helper, one method per endpoint for users, workouts, plans, stats and goals. Keep a strict naming convention: get<Resource> for every read and create<Resource> for every POST, no fetch/load/retrieve/add synonyms, so methods are discoverable from autocomplete.
How an expert would brief the stronger version of “Workout API client”.
See it
Try it as a puzzle →Front-end API client for a fitness app, with the editor's autocomplete open on the dashboard screen.
Why: B follows 'get' for reads and 'create' for writes; A has no pattern, so each name has to be looked up.
More ways experts use it
JSON response for GET /members/:id with a consistent naming convention: camelCase for every key, acronyms written as words (teamId, not TeamID), booleans prefixed with is/has, and timestamps ending in At. Map from the snake_case database columns in one serializer.
Member API response · Code & architecture
Related words
Room 2 · Naming
Learn “Naming convention” in a five-minute lesson