{
  "code": null,
  "collection": "architecture",
  "href": "https://banes-lab.com/ontology#architecture-principle-of-least-surprise",
  "id": "principle-of-least-surprise",
  "kind": "principle",
  "layer": {
    "href": "https://banes-lab.com/ontology/schema#layer-contracts-core",
    "json": "https://banes-lab.com/json/records/layer/contracts-core",
    "label": "Contracts Core",
    "markdown": "https://banes-lab.com/records/layer/contracts-core.md",
    "ref": "layer:contracts-core"
  },
  "name": "Principle of Least Surprise",
  "ref": "architecture:principle-of-least-surprise",
  "relations": [
    {
      "links": [
        {
          "href": "https://banes-lab.com/ontology#architecture-predictability",
          "json": "https://banes-lab.com/json/records/architecture/predictability",
          "label": "Predictability",
          "markdown": "https://banes-lab.com/records/architecture/predictability.md",
          "ref": "architecture:predictability"
        },
        {
          "href": "https://banes-lab.com/ontology/lexicon#lexicon-convention",
          "json": "https://banes-lab.com/json/records/lexicon/convention",
          "label": "Convention",
          "markdown": "https://banes-lab.com/records/lexicon/convention.md",
          "ref": "lexicon:convention"
        }
      ],
      "relation": "requires"
    },
    {
      "links": [
        {
          "href": "https://banes-lab.com/ontology#architecture-stable-interfaces",
          "json": "https://banes-lab.com/json/records/architecture/stable-interfaces",
          "label": "Stable Interfaces",
          "markdown": "https://banes-lab.com/records/architecture/stable-interfaces.md",
          "ref": "architecture:stable-interfaces"
        },
        {
          "href": "https://banes-lab.com/ontology#architecture-intent-revealing-interface",
          "json": "https://banes-lab.com/json/records/architecture/intent-revealing-interface",
          "label": "Intent-Revealing Interface",
          "markdown": "https://banes-lab.com/records/architecture/intent-revealing-interface.md",
          "ref": "architecture:intent-revealing-interface"
        }
      ],
      "relation": "reinforces"
    },
    {
      "links": [
        {
          "href": "https://banes-lab.com/ontology/lexicon#lexicon-safe-use",
          "json": "https://banes-lab.com/json/records/lexicon/safe-use",
          "label": "Safe Use",
          "markdown": "https://banes-lab.com/records/lexicon/safe-use.md",
          "ref": "lexicon:safe-use"
        }
      ],
      "relation": "enables"
    },
    {
      "links": [
        {
          "href": "https://banes-lab.com/ontology#architecture-hidden-side-effect",
          "json": "https://banes-lab.com/json/records/architecture/hidden-side-effect",
          "label": "Hidden Side Effect",
          "markdown": "https://banes-lab.com/records/architecture/hidden-side-effect.md",
          "ref": "architecture:hidden-side-effect"
        }
      ],
      "relation": "conflicts-with"
    },
    {
      "links": [
        {
          "href": "https://banes-lab.com/ontology/lexicon#lexicon-clever-abstractions",
          "json": "https://banes-lab.com/json/records/lexicon/clever-abstractions",
          "label": "Clever Abstractions",
          "markdown": "https://banes-lab.com/records/lexicon/clever-abstractions.md",
          "ref": "lexicon:clever-abstractions"
        }
      ],
      "relation": "tensions-with"
    },
    {
      "links": [
        {
          "href": "https://banes-lab.com/ontology/schema#tension-clever-abstractions-principle-of-least-surprise",
          "json": "https://banes-lab.com/json/records/tension/clever-abstractions-principle-of-least-surprise",
          "label": "Principle of Least Surprise / Clever Abstractions",
          "markdown": "https://banes-lab.com/records/tension/clever-abstractions-principle-of-least-surprise.md",
          "ref": "tension:clever-abstractions-principle-of-least-surprise"
        }
      ],
      "relation": "tensions"
    },
    {
      "links": [
        {
          "href": "https://banes-lab.com/ontology/algorithms#algorithms-human-factors",
          "json": "https://banes-lab.com/json/records/algorithms/human-factors",
          "label": "Human Factors",
          "markdown": "https://banes-lab.com/records/algorithms/human-factors.md",
          "ref": "algorithms:human-factors"
        }
      ],
      "relation": "contracts"
    },
    {
      "links": [
        {
          "href": "https://banes-lab.com/ontology#architecture-hidden-side-effect",
          "json": "https://banes-lab.com/json/records/architecture/hidden-side-effect",
          "label": "Hidden Side Effect",
          "markdown": "https://banes-lab.com/records/architecture/hidden-side-effect.md",
          "ref": "architecture:hidden-side-effect"
        }
      ],
      "relation": "violated-by"
    },
    {
      "links": [
        {
          "href": "https://banes-lab.com/ontology/lexicon#lexicon-name-the-concept",
          "json": "https://banes-lab.com/json/records/lexicon/name-the-concept",
          "label": "Name the Concept",
          "markdown": "https://banes-lab.com/records/lexicon/name-the-concept.md",
          "ref": "lexicon:name-the-concept"
        },
        {
          "href": "https://banes-lab.com/ontology/lexicon#lexicon-make-effects-explicit",
          "json": "https://banes-lab.com/json/records/lexicon/make-effects-explicit",
          "label": "Make Effects Explicit",
          "markdown": "https://banes-lab.com/records/lexicon/make-effects-explicit.md",
          "ref": "lexicon:make-effects-explicit"
        },
        {
          "href": "https://banes-lab.com/ontology/lexicon#lexicon-standardize-the-interface",
          "json": "https://banes-lab.com/json/records/lexicon/standardize-the-interface",
          "label": "Standardize the Interface",
          "markdown": "https://banes-lab.com/records/lexicon/standardize-the-interface.md",
          "ref": "lexicon:standardize-the-interface"
        }
      ],
      "relation": "refactored-by"
    },
    {
      "links": [
        {
          "href": "https://banes-lab.com/ontology/schema#vocabulary-severity-recommended",
          "json": "https://banes-lab.com/json/records/vocabulary/severity-recommended",
          "label": "recommended",
          "markdown": "https://banes-lab.com/records/vocabulary/severity-recommended.md",
          "ref": "vocabulary:severity-recommended"
        }
      ],
      "relation": "severity"
    },
    {
      "links": [
        {
          "href": "https://banes-lab.com/ontology#architecture-category-schema-canonical-data-semantics",
          "json": "https://banes-lab.com/json/records/architecture-category/schema-canonical-data-semantics",
          "label": "Schema / Canonical Data / Semantics",
          "markdown": "https://banes-lab.com/records/architecture-category/schema-canonical-data-semantics.md",
          "ref": "architecture-category:schema-canonical-data-semantics"
        }
      ],
      "relation": "category"
    },
    {
      "links": [
        {
          "href": "https://banes-lab.com/anatomy/governance#file-governance-rules-eslint-closure-show-flag-polarity-eslint-rule-ts",
          "json": "https://banes-lab.com/json/source/governance/rules/eslint/closure-show-flag-polarity.eslint.rule.ts",
          "label": "rules/eslint/closure-show-flag-polarity.eslint.rule.ts",
          "markdown": "https://banes-lab.com/source/governance/rules/eslint/closure-show-flag-polarity.eslint.rule.ts.md",
          "ref": "anatomy:file-governance-rules-eslint-closure-show-flag-polarity-eslint-rule-ts"
        }
      ],
      "relation": "enforced-by"
    },
    {
      "links": [
        {
          "href": "https://banes-lab.com/ontology#architecture-uniform-interface",
          "json": "https://banes-lab.com/json/records/architecture/uniform-interface",
          "label": "Uniform Interface",
          "markdown": "https://banes-lab.com/records/architecture/uniform-interface.md",
          "ref": "architecture:uniform-interface"
        }
      ],
      "relation": "reinforced-by"
    },
    {
      "links": [
        {
          "href": "https://banes-lab.com/ontology#architecture-category-anti-patterns",
          "json": "https://banes-lab.com/json/ontology/principles/architecture-category-anti-patterns",
          "label": "Anti-patterns",
          "markdown": "https://banes-lab.com/ontology/principles/architecture-category-anti-patterns.md",
          "ref": "chapter:/ontology#architecture-category-anti-patterns"
        },
        {
          "href": "https://banes-lab.com/ontology#architecture-category-contracts-interfaces-compatibility",
          "json": "https://banes-lab.com/json/ontology/principles/architecture-category-contracts-interfaces-compatibility",
          "label": "Contracts / Interfaces / Compatibility",
          "markdown": "https://banes-lab.com/ontology/principles/architecture-category-contracts-interfaces-compatibility.md",
          "ref": "chapter:/ontology#architecture-category-contracts-interfaces-compatibility"
        },
        {
          "href": "https://banes-lab.com/ontology#architecture-category-correctness-determinism-verification",
          "json": "https://banes-lab.com/json/ontology/principles/architecture-category-correctness-determinism-verification",
          "label": "Correctness / Determinism / Verification",
          "markdown": "https://banes-lab.com/ontology/principles/architecture-category-correctness-determinism-verification.md",
          "ref": "chapter:/ontology#architecture-category-correctness-determinism-verification"
        },
        {
          "href": "https://banes-lab.com/ontology#architecture-category-schema-canonical-data-semantics",
          "json": "https://banes-lab.com/json/ontology/principles/architecture-category-schema-canonical-data-semantics",
          "label": "Schema / Canonical Data / Semantics",
          "markdown": "https://banes-lab.com/ontology/principles/architecture-category-schema-canonical-data-semantics.md",
          "ref": "chapter:/ontology#architecture-category-schema-canonical-data-semantics"
        },
        {
          "href": "https://banes-lab.com/ontology/lexicon#lexicon-category-contracts-interfaces-compatibility",
          "json": "https://banes-lab.com/json/ontology/lexicon/lexicon-category-contracts-interfaces-compatibility",
          "label": "Contracts / Interfaces / Compatibility",
          "markdown": "https://banes-lab.com/ontology/lexicon/lexicon-category-contracts-interfaces-compatibility.md",
          "ref": "chapter:/ontology/lexicon#lexicon-category-contracts-interfaces-compatibility"
        },
        {
          "href": "https://banes-lab.com/ontology/lexicon#lexicon-category-core-vocabulary",
          "json": "https://banes-lab.com/json/ontology/lexicon/lexicon-category-core-vocabulary",
          "label": "Core Vocabulary",
          "markdown": "https://banes-lab.com/ontology/lexicon/lexicon-category-core-vocabulary.md",
          "ref": "chapter:/ontology/lexicon#lexicon-category-core-vocabulary"
        },
        {
          "href": "https://banes-lab.com/ontology/lexicon#lexicon-category-correctness-determinism-verification",
          "json": "https://banes-lab.com/json/ontology/lexicon/lexicon-category-correctness-determinism-verification",
          "label": "Correctness / Determinism / Verification",
          "markdown": "https://banes-lab.com/ontology/lexicon/lexicon-category-correctness-determinism-verification.md",
          "ref": "chapter:/ontology/lexicon#lexicon-category-correctness-determinism-verification"
        },
        {
          "href": "https://banes-lab.com/ontology/lexicon#lexicon-category-schema-canonical-data-semantics",
          "json": "https://banes-lab.com/json/ontology/lexicon/lexicon-category-schema-canonical-data-semantics",
          "label": "Schema / Canonical Data / Semantics",
          "markdown": "https://banes-lab.com/ontology/lexicon/lexicon-category-schema-canonical-data-semantics.md",
          "ref": "chapter:/ontology/lexicon#lexicon-category-schema-canonical-data-semantics"
        },
        {
          "href": "https://banes-lab.com/ontology/algorithms#algorithms-domain-architectural-clusters",
          "json": "https://banes-lab.com/json/ontology/algorithms/algorithms-domain-architectural-clusters",
          "label": "Architectural Clusters",
          "markdown": "https://banes-lab.com/ontology/algorithms/algorithms-domain-architectural-clusters.md",
          "ref": "chapter:/ontology/algorithms#algorithms-domain-architectural-clusters"
        },
        {
          "href": "https://banes-lab.com/ontology/schema#the-vocabulary-severity",
          "json": "https://banes-lab.com/json/ontology/schema/the-vocabulary-severity",
          "label": "Severity levels",
          "markdown": "https://banes-lab.com/ontology/schema/the-vocabulary-severity.md",
          "ref": "chapter:/ontology/schema#the-vocabulary-severity"
        },
        {
          "href": "https://banes-lab.com/ontology/schema#the-resolutions",
          "json": "https://banes-lab.com/json/ontology/schema/the-resolutions",
          "label": "The resolutions",
          "markdown": "https://banes-lab.com/ontology/schema/the-resolutions.md",
          "ref": "chapter:/ontology/schema#the-resolutions"
        }
      ],
      "relation": "linked-from"
    }
  ],
  "summary": "A design rule that an operation behaves the way its name and its conventions lead a caller to expect.",
  "siblings": {
    "next": {
      "href": "https://banes-lab.com/ontology#architecture-database-normalization",
      "json": "https://banes-lab.com/json/records/architecture/database-normalization",
      "label": "Database Normalization",
      "markdown": "https://banes-lab.com/records/architecture/database-normalization.md",
      "ref": "architecture:database-normalization"
    },
    "previous": {
      "href": "https://banes-lab.com/ontology#architecture-intent-revealing-interface",
      "json": "https://banes-lab.com/json/records/architecture/intent-revealing-interface",
      "label": "Intent-Revealing Interface",
      "markdown": "https://banes-lab.com/records/architecture/intent-revealing-interface.md",
      "ref": "architecture:intent-revealing-interface"
    }
  },
  "up": {
    "href": null,
    "json": "https://banes-lab.com/json/api/records/architecture",
    "label": "Architecture principles",
    "markdown": "https://banes-lab.com/api/records/architecture.md",
    "ref": "api:records/architecture"
  },
  "aliases": [
    "Principle of Least Astonishment",
    "POLA"
  ],
  "exemplar": {
    "after": "function getFoo(id: FooId) { return fooStore.find(id); }\nfunction deleteFoo(id: FooId) { return fooStore.delete(id); }",
    "before": "function getFoo(id: FooId) {\n  fooStore.delete(id);\n  return undefined;\n}",
    "lang": "ts",
    "medium": "code"
  },
  "formedBy": null,
  "scope": [
    "API",
    "UX",
    "module behavior"
  ],
  "severity": "recommended"
}