mcicolella / The-Standard

This is The Standard. A collection of decades of experience in the engineering industry. I authored it to help you navigate the vast ocean of knowledge. The Standard is not perfect and never will be, and it reflects the ongoing evolution of the engineering industry. While one person may write it, it is the collection of thoughts from hundreds of engineers I've had the honor to interact with and learn from throughout my life.

The Standard (v 1444.06.14)

Chat with us here on Discord:

• 0 Introduction
  • 0.0 The Theory
    • 0.0.0 Introduction
    • 0.0.1 Finding Answers
    • 0.0.2 Tri-Nature
      • 0.0.2.0 Purpose
      • 0.0.2.1 Dependency
      • 0.0.2.2 Exposure
    • 0.0.3 Everything is Connected
    • 0.0.4 Fractal Pattern
    • 0.0.5 Systems Design & Architecture
    • 0.0.6 Conclusion
  • 0.1 Purposing, Modeling & Simulation
    • 0.1.0 Introduction
    • 0.1.1 Purposing
      • 0.1.1.0 Observation
      • 0.1.1.1 Articulation
      • 0.1.1.2 Solutioning
    • 0.1.2 Modeling
      • 0.1.2.0 Model Types
        • 0.1.2.0.0 Data-Carrier Models
          • 0.1.2.0.0.0 Primary Models
          • 0.1.2.0.0.1 Secondary Models
          • 0.1.2.0.0.2 Relational Models
          • 0.1.2.0.0.3 Hybrid Models
        • 0.1.2.0.1 Operational Models
          • 0.1.2.0.1.0 Integration Models
          • 0.1.2.0.1.1 Processing Models
          • 0.1.2.0.1.2 Exposure Models
        • 0.1.2.0.2 Configuration Models
    • 0.1.3 Simulation
    • 0.1.4 Summary
  • 0.2 Principles
    • 0.2.0 People First
      • 0.2.0.0 Simplicity
        • 0.2.0.0.0 Excessive Inheritance
        • 0.2.0.0.1 Entanglement
        • 0.2.0.0.2 Autonomous Components
          • 0.2.0.0.2.0 No Magic
    • 0.2.1 Rewritability
    • 0.2.2 Mono-Micro
    • 0.2.3 Level 0
    • 0.2.4 Open Code
    • 0.2.5 Airplane Mode (Cloud-Foreign)
    • 0.2.6 No Toasters
    • 0.2.7 Pass Forward
    • 0.2.8 All-In/All-Out
  • 0.3 Testimonials
• 1 Brokers
  • 1.0 Introduction
  • 1.1 On The Map
  • 1.2 Characteristics
    • 1.2.0 Implements a Local Interface
    • 1.2.1 No Flow Control
    • 1.2.2 No Exception Handling
    • 1.2.3 Own Their Configurations
    • 1.2.4 Natives from Primitives
    • 1.2.5 Naming Conventions
    • 1.2.6 Language
    • 1.2.7 Up & Sideways
  • 1.3 Organization
  • 1.4 Broker Types
    • 1.4.0 Entity Brokers
    • 1.4.1 Support Brokers
  • 1.5 Implementation
  • 1.6 Summary
  • 1.7 FAQs
  • 1.8 Standardized Provider Abstraction Libraries (SPAL)
    • 1.8.0 Extensibility
      • 1.8.0.0 Configurability
    • 1.8.1 Distributability
    • 1.8.2 External Mockability
    • 1.8.3 Local to Global
• 2 Services
  • 2.0 Introduction
    • 2.0.0 Services Operations
      • 2.0.0.0 Validations
      • 2.0.0.1 Processing
      • 2.0.0.2 Integration
    • 2.0.1 Services Types
      • 2.0.1.0 Validators
      • 2.0.1.1 Orchestrators
      • 2.0.1.2 Aggregators
    • 2.0.2 Overall Rules
      • 2.0.2.0 Do or Delegate
      • 2.0.2.1 Two-Three (Florance Pattern)
      • 2.0.2.2 Single Exposure Point
      • 2.0.2.3 Same or primitives I/O Model
      • 2.0.2.4 Every Service for Itself
      • 2.0.2.5 Flow Forward
        • 2.0.2.6 For APIs
  • 2.1 Foundation Services
    • 2.1.0 Introduction
    • 2.1.1 On The Map
    • 2.1.2 Characteristics
      • 2.1.2.0 Pure Primitive
      • 2.1.2.1 Single Entity Integration
      • 2.1.2.2 Business Language
    • 2.1.3 Responsibilities
      • 2.1.3.0 Abstraction
        • 2.1.3.0.1 Implementation
      • 2.1.3.1 Validation
        • 2.1.3.1.0 Circuit-Breaking Validations
        • 2.1.3.1.1 Continuous Validations
          • 2.1.3.1.1.0 Upsertable Exceptions
          • 2.1.3.1.1.1 Dynamic Rules
          • 2.1.3.1.1.2 Rules & Validations Collector
          • 2.1.3.1.1.3 Hybrid Continuous Validations
        • 2.1.3.1.2 Structural Validations
          • 2.1.3.1.2.0 Testing Structural Validations
          • 2.1.3.1.2.1 Implementing Structural Validations
        • 2.1.3.1.3 Logical Validations
          • 2.1.3.1.3.0 Testing Logical Validations
          • 2.1.3.1.3.1 Implementing Logical Validations
        • 2.1.3.1.4 External Validations
          • 2.1.3.1.4.0 Testing External Validations
          • 2.1.3.1.4.1 Implementing External Validations
        • 2.1.3.1.5 Dependency Validations
          • 2.1.3.1.5.0 Testing Dependency Validations
          • 2.1.3.1.5.1 Implementing Dependency Validations
      • 2.1.3.2 Mapping
        • 2.1.3.2.0 Non-Local Models
        • 2.1.3.2.1 Exceptions Mappings
  • 2.2 Processing Services
    • 2.2.0 Introduction
    • 2.2.1 On The Map
    • 2.2.2 Characteristics
      • 2.2.2.0 Language
        • 2.2.2.0.0 Functions Language
        • 2.2.2.0.1 Pass-Through
        • 2.2.2.0.2 Class-Level Language
      • 2.2.2.1 Dependencies
      • 2.2.2.2 One-Foundation
      • 2.2.2.3 Used-Data-Only Validations
    • 2.2.3 Responsibilities
      • 2.2.3.0 Higher-Order Logic
        • 2.2.3.0.0 Shifters
        • 2.2.3.0.1 Combinations
      • 2.2.3.1 Signature Mapping
        • 2.2.3.1.0 Non-Exception Local Models
        • 2.2.3.1.1 Exception Models
  • 2.3 Orchestration Services
    • 2.3.0 Introduction
    • 2.3.1 On The Map
    • 2.3.2 Characteristics
      • 2.3.2.0 Language
        • 2.3.2.0.0 Functions Language
        • 2.3.2.0.1 Pass-Through
        • 2.3.2.0.2 Class-Level Language
      • 2.3.2.1 Dependencies
        • 2.3.2.1.0 Dependency Balance (Florance Pattern)
        • 2.3.2.1.1 Two-Three
          • 2.3.2.1.1.0 Full-Normalization
          • 2.3.2.1.1.1 Semi-Normalization
          • 2.3.2.1.1.2 No-Normalization
          • 2.3.2.1.1.3 Meaningful Breakdown
      • 2.3.2.1 Contracts
        • 2.3.2.1.0 Physical Contracts
        • 2.3.2.1.1 Virtual Contracts
      • 2.3.2.2 Cul-De-Sac
    • 2.3.3 Responsibilities
      • 2.3.3.0 Advanced Logic
        • 2.3.3.0.0 Flow Combination
        • 2.3.3.0.1 Call Order
          • 2.3.3.0.1.0 Natural Order
          • 2.3.3.0.1.1 Enforced Order
        • 2.3.3.0.2 Exceptions Mapping (Wrapping & Unwrapping)
    • 2.3.4 Variations
      • 2.3.4.0 Variants Levels
      • 2.3.4.1 Unit of Work
  • 2.4 Aggregation Services
    • 2.4.0 Introduction
    • 2.4.1 On The Map
    • 2.4.2 Characteristics
      • 2.4.2.0 No Dependency Limitation
      • 2.4.2.1 No Order Validation
      • 2.4.2.2 Basic Validations
      • 2.4.2.3 Pass-Through
      • 2.4.2.4 Optionality
      • 2.4.2.5 Routine-Level Aggregation
      • 2.4.2.6 Pure Dependency Contracts
    • 2.4.3 Responsibilities
      • 2.4.3.0 Abstraction
      • 2.4.3.1 Exceptions Aggregation
• 3. Exposers
  • 3.0 Introduction
    • 3.0.0 Purpose
      • 3.0.0.0 Pure Mapping
    • 3.0.1 Types of Exposure Components
      • 3.0.1.0 Communication Protocols
      • 3.0.1.1 User Interfaces
      • 3.0.1.2 I/O Components
    • 3.0.2 Single Point of Contact
    • 3.0.3 Examples
    • 3.0.4 Summary
  • 3.1 Communication Protocols
    • 3.1.0 Introduction
      • 3.1.0.0 Principles & Rules
        • 3.1.0.0.0 Results Communication
        • 3.1.0.0.1 Error Reports
      • 3.1.0.1 Common Types
        • 3.1.0.1.0 REST
        • 3.1.0.1.1 Libraries
        • 3.1.0.1.2 Other Types
    • 3.1.1 RESTful APIs
      • 3.1.1.0 Introduction
      • 3.1.1.1 On the Map
      • 3.1.1.2 Characteristics
        • 3.1.1.2.0 Language
          • 3.1.1.2.0.0 Beyond CRUD Routines
          • 3.1.1.2.0.1 Similar Verbs
          • 3.1.1.2.0.2 Routes Conventions
            • 3.1.1.2.0.2.0 Controller Routes
            • 3.1.1.2.0.2.1 Routine Routes
            • 3.1.1.2.0.2.2 Plural Singular Plural
            • 3.1.1.2.0.2.3 Query Parameters & OData
        • 3.1.1.2.1 Codes & Responses
          • 3.1.1.2.1.0 Success Codes (2xx)
          • 3.1.1.2.1.1 User Error Codes (4xx)
          • 3.1.1.2.1.2 System Error Codes (5xx)
          • 3.1.1.2.1.3 All Codes
        • 3.1.1.2.2 Single Dependency
        • 3.1.1.2.3 Single Contract
      • 3.1.1.3 Organization
      • 3.1.1.4 Home Controller
      • 3.1.1.5 Tests
  • 3.2 User Interfaces
    • 3.2.0 Introduction
      • 3.2.0.0 Principles & Rules
        • 3.2.0.0.0 Progress (Loading)
          • 3.2.0.0.0.0 Basic Progress
          • 3.2.0.0.0.1 Remaining Progress
          • 3.2.0.0.0.2 Detailed Progress
        • 3.2.0.0.1 Results
          • 3.2.0.0.1.0 Simple
          • 3.2.0.0.1.1 Partial Details
          • 3.2.0.0.1.2 Full Details
        • 3.2.0.0.2 Error Reports
          • 3.2.0.0.2.0 Informational
          • 3.2.0.0.2.1 Referential/Implicit Actions
          • 3.2.0.0.2.2 Actionable
        • 3.2.0.0.3 Single Dependency
        • 3.2.0.0.4 Anatomy
          • 3.2.0.0.4.0 Bases
          • 3.2.0.0.4.1 Components
          • 3.2.0.0.4.2 Containers
        • 3.2.0.0.5 UI Components Types
          • 3.2.0.0.5.0 Web Applications
          • 3.2.0.0.4.1 Mobile Applications
          • 3.2.0.0.4.2 Other Types
    • 3.2.1 Web Applications
      • 3.2.1.0 Introduction
      • 3.2.1.1 On the Map
      • 3.2.1.2 Characteristics
        • 3.2.1.2.0 Anatomy
          • 3.2.1.2.0.0 Base Components
            • 3.2.1.2.0.0.0 Implementation
            • 3.2.1.2.0.0.1 Utilization
            • 3.2.1.2.0.0.2 Restrictions
          • 3.2.1.2.0.1 Core Components
            • 3.2.1.2.0.1.0 Implementation & Tests
            • 3.2.1.2.0.1.1 Restrictions
          • 3.2.1.2.0.2 Pages
          • 3.2.1.2.0.3 Unobtrusiveness
          • 3.2.1.2.0.4 Organization

Other Resources

• The Standard YouTube Playlist
• Guidelines for C# Coding Standards
• The Team Standard is the engineering Standard for team culture, practices and code of conduct.
• The Standard for System Design & Architecture
• The Standard Codex - It's not enough to know the truth, you must have the courage to wield it into existence.

Translations

• The Standard in Arabic
• The Standard in Ukrainian
• The Standard in French
• The Standard in Italian
• The Standard in Malaysian
• The Standard in Uzbek
• The Standard in German
• The Standard in Spanish
• The Standard in Turkish
• The Standard in Greek
• The Standard in Albanian
• The Standard in Portuguese
• The Standard in Sinhala
• The Standard in Hindi
• The Standard in Bulgarian
• The Standard in Polish
• The Standard in Urdu

The Standard in Different Programming Languages

• The Standard in Go
• The Standard in Scala
• The Standard in R
• The Standard in Kotlin
• The Standard in Java
• The Standard in Python