Stop abbreviating in your APIs
A small plea: stop abbreviating field and method names in your APIsAPI A set of rules and protocols that allows different software applications to communicate with each other. APIs define the methods and data formats that applications can use to request and exchange information., SDKsSDK A collection of software development tools, libraries, documentation, code samples, and guides that help developers create applications for a specific platform or framework., and config.
The names you're shortening are usually already jargonjargon Technical jargon is a type of language that is used to describe technical concepts in a precise and concise manner. It is often used in scientific, engineering, and technical fields.. They're internal terms, half of them cryptic to anyone outside the team that coined them. Abbreviating them takes something that was merely obscure and makes it unreadable.
org instead of organization, acct, qty, usr, addr, txn, cfg. Each one saves you a few keystrokes once, at write time. It costs every reader a tiny guess, every time, forever. And the people reading your APIAPI A set of rules and protocols that allows different software applications to communicate with each other. APIs define the methods and data formats that applications can use to request and exchange information. don't share your context, so the guess is harder for them than it is for you.
Autocomplete fills in the long name for free. Search finds it. A new hire can read it without a glossary. The full word is the cheap option for everyone except the person typing it the first time, and that person has a tab key.
Write the whole word.