Use Concrete Details

DOCS-USE-CONCRETE-DETAILS

Summary

Name real commands, paths, defaults, types, examples, and work areas when they clarify scope. Concrete detail removes guesswork without overloading prose with incidental facts.

Rule

Use concrete nouns and real paths, defaults, commands, and examples.

Why

Abstract nouns make readers infer the actual object. A sentence about "shared artifacts" is weaker than one naming issues, PRs, commit messages, docs, and handoffs when those are the surfaces at stake. Navigation phrases such as "recurring work area," "first decision," or "work being shaped" are weaker than labels such as "change scope," "Rust API review," or "agent instructions." Concrete paths, commands, defaults, types, and examples remove guesswork.

Helps

  • Makes guidance easier to apply, review, and encode for agents.

Limits

Do not overload prose with incidental detail. Use concrete examples that clarify scope, not examples that distract from the rule.

Agent Instruction

Use concrete nouns, real paths, defaults, commands, examples, and named work areas so readers do not
infer the actual object.

Mechanisms

Supported by terminology review, examples, path and command verification, and quality checks that flag abstract repeated rationale for deeper review.

References