Simplicity means exposing the functionality users want in the most straightforward way possible—not merely minimizing RPCs, resources, or methods. A single ExecuteAction() call can hide complexity inside configuration, while a focused DetectLanguage() method makes its purpose clear. section 1.4.3
Design for simplicity by following these rules:
- Make the common case awesome and the advanced case possible: keep advanced options available without burdening typical users. section 1.4.3
- Prefer dedicated methods over unrelated functionality hidden inside another operation. section 1.4.3
- Balance simplicity against excessive choice; highly granular versioning can overwhelm users and force unwanted historical changes into each selection. section 24.4.1
Listing 1.3 Translating text to a target language (the common case)
function translateText(inputText: string,
targetLanguage: string,
modelId?: string): string {
return TranslateApi.TranslateText({
text: inputText,
targetLanguage: targetLanguage,
modelId: modelId,
});
}
A translation helper keeps targetLanguage as the common-case input while making modelId optional for advanced control. section 1.4.3
