systembrief

Strategy-first architecture briefs as one light HTML file.

First calls fail when the slide, the diagram, and the ownership story disagree. systembrief locks them into one file you can email and open offline for icons: what the system does, how it is built, and who owns what, using your strategy labels, not a fixed Own / OSS / AWS template.

grammar + strategy frames + Mermaid rules
        -> intake YAML
        -> locked build
        -> lint_brief + verify

Open the gallery: examples/index.html

---

Two flagship briefs

Clearrail is the fintech first-call. Wellscribe is the AI action-rights first-call. Both have Business | Technical | Both tabs (?view=technical). Optional sittings from the same Clearrail intake (chrome names the sitting, not the room):

Sitting	File	Command
First call	clearrail-business-built.html	--use first-call
Decision sitting	clearrail-decision-built.html	--use decision
Working brief	clearrail-technical-built.html	--use working
Mixed room	clearrail-embedded-payouts.html	dual tabs

python scripts/build_brief.py intakes/clearrail.yaml --use first-call
python scripts/build_brief.py intakes/clearrail.yaml --use decision
python scripts/build_brief.py intakes/clearrail.yaml --use working
python scripts/build_brief.py intakes/clearrail.yaml --audience business

Side, depth, and circulation stay overridable (--audience, --depth, --circulation). Map: docs/BRIEF-USES.md.

Clearrail Ledger / Rails / Risk	Wellscribe Human / Assist / Automate

Who pays whom (Clearrail business view)	Who may sign (Wellscribe technical view)

---

Eight frames, eight samples

A public sample exists only when it teaches a new strategy frame. No domain twins for variety. Catalog: scripts/frames.py.

Northline Build / Buy / Partner	GrainLedger Core / Shared / Edge
Field service. Build dispatch IP. Buy maps. Partner ERP.	Co-op settlement. Core owns the math. Edge keeps scales and banks.

Harborlane Control / Data / Experience	Wardpath Run / Change / Prove
Port platform. Experience is a skin. Control is the wall.	Hospital ops. Prove cannot lock the shift board.

Docklink In-house / Vendor / Customer	Parcelore Source / Transform / Serve
EDI hub. Customer ERP stays customer-owned.	Property intel. One transform. A brief is the product.

Every sample now has a trust section: what the product must not take over (ERP, sign authority, license vault, shift board, bank rails).

---

What it is (and is not)

This	Not this
One shareable brief + ownership strategy	A website builder
Grammar + lint + verify	Pretty HTML with no gate
Your strategy labels	Own / OSS / AWS by default
Fictional public samples	Customer or internal brands
diagram-design discipline	diagram-design's job (one editorial SVG)

Quality model

Layer	Where
Brief grammar	docs/BRIEF-GRAMMAR.md
Strategy frames	docs/STRATEGY-FRAMES.md
Diagram rules	docs/MERMAID-RULES.md
Lint	python scripts/lint_brief.py --all
Product gate	python scripts/verify.py
Agent skill	skills/systembrief/SKILL.md
Partner report	skills/partner-report/SKILL.md
Short prompts	prompts/QUICK.md

Icons are Feather (MIT), vendored under assets/feather/ and inlined. No icon CDN. Mermaid still loads from CDN.

---

Quick start

python -m pip install -r requirements.txt

python scripts/build_brief.py intakes/northline.yaml -o examples/northline-built.html
python scripts/lint_brief.py --all
python scripts/verify.py

Then open examples/northline-built.html or the gallery.

New brief

1. Copy intakes/northline.yaml (simple) or intakes/clearrail.yaml (dual audience).
2. Set strategy.frame and the three class labels. Edit diagrams and flows (schema).
3. Build, lint, verify.

Do not invent CSS or JS. Chrome is locked in scripts/runtime.py.

Add a public sample only when it teaches a new frame.

Internal brief (real product)

Keep customer and internal brands out of examples/. In the product tree:

python /path/to/systembrief/scripts/build_brief.py path/to/intake.yaml --lint

Set visibility: internal. Custom strategy frames are allowed. Default HTML is written next to the YAML.

---

Docs

Topic	Doc
Architecture	docs/ARCHITECTURE.md
Decisions	docs/DECISIONS.md
History	docs/HISTORY.md
Learnings	docs/LEARNINGS.md
Intake schema	docs/INTAKE-SCHEMA.md
Docs index	docs/README.md
Contributing	CONTRIBUTING.md
Changelog	CHANGELOG.md

License

MIT. See LICENSE.