liveBook · Manning

Surface area

As explained in Build High Value Software Systems

The set of interfaces, behaviors, integration points, and change obligations exposed by a software component or dependency.

A dependency can save implementation time while adding interfaces, behaviors, and integration points that your system must accommodate. Its surface area includes ongoing obligations such as security patches, breaking changes, deprecation, and debugging code you may not call directly. section 4.3.1 section 4.3.2

When weighing a dependency, ask:

  • Does it deliver real business or technical value, or mainly move code out of your repository? section 4.3.1
  • Is its convenience worth the likely maintenance and debugging burden? A small, simple function may not justify a broad dependency; complex work such as cryptography or parsing may. section 4.3.1 section 4.3.2
  • Does a change combine multiple concerns? Separate refactoring from feature work when possible; large batches multiply review surface area and rework. section 6.2
Figure 4.5 Importing an entire library with multiple capabilities to service one business need.

Shows how an entire library may be imported to meet a single business need. section 4.3.2

Listing 4.7 A simple validate email function
function validateEmail(email: string): boolean {
  const regex = /^[^\s@]+@[^\s@]+\.[^\s@]+$/;
  return regex.test(email);
}
 

A short email validator illustrates when a small requirement may need only a few lines of auditable code. section 4.3.2

How Build High Value Software Systems covers it

How deep it goes
Explains maintenance and debugging consequences through examples, without defining a quantitative measure of surface area.
Examples
Uses dependency lifecycle changes, email validation, complex libraries, and multi-concern pull requests as examples.
What you can do after
Evaluate whether a dependency’s value justifies its ongoing maintenance and debugging obligations.
How it connects
Connects dependencies with technical value, maintenance burden, debugging, and pull-request batch size.

Related concepts

This explainer was generated by Manning's knowledge graph from the text of Build High Value Software Systems. The section links point to the parts of the book it draws on.