liveBook · Manning

Guideline

A guideline is a recommendation or principle that directs how an activity is performed or decisions are made, without necessarily imposing an absolute requirement.

How 3 Manning books explain it

The Design of Web APIs, Second Edition

An API design guideline is a documented recommendation for making consistent and effective API design decisions.

How it is used
Guides recurring API design decisions while keeping attention on consumer needs and consistency.
How deep it goes
Develops rules, task-based recipes, iterative construction, and change management; defers uncommon design cases until needed.
Examples
Uses transaction search, bank-account identifiers, HTTP status choices, and create/read/search/update/delete recipes to illustrate guideline content.
What you can do after
Build it from scratch as a small set of justified recipes, then apply and evolve it without casually disrupting existing consumers.

Read how The Design of Web APIs, Second Edition explains guideline →

Fundamentals of Cybersecurity

A guideline is a recommended practice that directs decisions or behavior without imposing an absolute requirement.

How it is used
Guides security decisions, procedure development, and technical implementation within a broader security governance framework.
How deep it goes
Defines flexibility, origins, functions, and maturity implications, but stops short of prescribing mandatory steps or penalties.
Examples
Names NIST SP 800-53, ISO/IEC 27002, OWASP Top 10, and CIS Benchmarks as external cybersecurity references.
What you can do after
Apply it via named security references to inform decisions and adapt recommended practices to organizational conditions.

Read how Fundamentals of Cybersecurity explains guideline →

"Looks Good to Me"

A guideline is a recommended rule or principle that directs how code reviews should be conducted and how unclear situations should be handled.

How it is used
Directs code review behavior, resolves ambiguity, and establishes a shared path for consistent, maintainable, and effective reviews.
How deep it goes
Defines purpose, documentation, adaptation, participation, and conduct, while deferring detailed policy contents to team decisions.
Examples
Uses open editable documents, respectful-comment rules, explicit consequences, and collaboratively defined review practices as concrete artifacts.
What you can do after
Apply it via a shared, revisable set of code review rules that supports decisions and makes interpersonal expectations actionable.

Read how "Looks Good to Me" explains guideline →

Also covered in

What to know first

Related concepts

Questions about guideline

What is guideline?

A guideline is a recommendation or principle that directs how an activity is performed or decisions are made, without necessarily imposing an absolute requirement.

Which Manning books explain guideline?

The Design of Web APIs, Second Edition, Fundamentals of Cybersecurity and "Looks Good to Me".

What should I know before learning guideline?

Manning books that teach guideline usually introduce visualization first.

What is the difference between guideline and architecture decision record?

A guideline is a recommendation or principle that directs how an activity is performed or decisions are made, without necessarily imposing an absolute requirement. An architecture decision record is a durable document that captures a significant architectural decision, its context, rationale, and consequences.

What are the parts of guideline?

Guideline includes design rule.

These guides are generated from the text of Manning books by Manning's knowledge graph and link to the sections they draw on. The full books are available on liveBook and at manning.com.