Skip to content

README.md

Latest commit

 

History

History
46 lines (35 loc) · 2.53 KB

README.md

File metadata and controls

46 lines (35 loc) · 2.53 KB
title Steering Files
folder docs/steering
description Entry point for persistent steering context loaded by agents on demand.
entry_point true

Steering Files

Persistent, scoped context loaded by agents on demand. Inspired by Kiro's .kiro/steering/ pattern.

These files are downstream project templates. They describe the context an adopter should fill in after using Specorator as a starter. They do not describe Specorator itself.

Specorator's own product steering lives in docs/specorator-product/. Use that folder when improving this repository, the workflow method, the product page, package distribution, adapters, hooks, or other template-owned surfaces.

File Loaded by When
product.md PM, UX, UI, Reviewer, Release Manager Product-shaped work
tech.md Architect, Dev, QA, SRE Technical work
ux.md UX, UI, PM Experience-shaped work
quality.md QA, Reviewer Test plans, reviews
operations.md SRE, Release Manager Release, deploy, incident

These files are templates. Replace the placeholders with your project's reality. Keep each file under ~200 lines. If you need more, split into multiple steering files (tool-neutral) — the @import directive used in CLAUDE.md is Claude-Code-specific and other tools (Codex / Cursor / Aider) will see the literal text.

Loading rules

  • Always-loaded: none, by default. Steering files are scoped on purpose.
  • Conditionally loaded: agents declare in their frontmatter which steering files they need.
  • Manually loaded: humans can @docs/steering/<file>.md in a prompt to inject context.

Which steering source to load

Work type Steering source
Improving Specorator itself docs/specorator-product/
Starting a new downstream product from the template docs/steering/
Editing these blank starter templates docs/steering/ plus docs/specorator-product/quality.md
Writing public positioning for Specorator docs/specorator-product/product.md and docs/specorator-product/ux.md
Changing verification, release, or package behavior docs/specorator-product/tech.md, quality.md, and operations.md

Style

  • Imperative mood. "Use TypeScript strict mode", not "We try to use TypeScript strict mode".
  • Specific over general. "Tailwind v4, no inline styles", not "Use a CSS framework".
  • Cite the source if non-obvious (a design doc, an ADR, a vendor constraint).
  • Update via PR — these files are part of the contract.