Skip to content

Repository files navigation

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

Eight teaching samples

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).

Clearrail Ledger / Rails / RiskWellscribe Human / Assist / Automate
Clearrail chromeWellscribe chrome
Who pays whom (Clearrail business view)Who may sign (Wellscribe technical view)
Clearrail value chainWellscribe action rights

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 / PartnerGrainLedger Core / Shared / Edge
Field service. Build dispatch IP. Buy maps. Partner ERP.Co-op settlement. Core owns the math. Edge keeps scales and banks.
Northline contextGrainLedger system
Harborlane Control / Data / ExperienceWardpath Run / Change / Prove
Port platform. Experience is a skin. Control is the wall.Hospital ops. Prove cannot lock the shift board.
Harborlane planesWardpath three ways
Docklink In-house / Vendor / CustomerParcelore Source / Transform / Serve
EDI hub. Customer ERP stays customer-owned.Property intel. One transform. A brief is the product.
Docklink ownershipParcelore serve

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)

ThisNot this
One shareable brief + ownership strategyA website builder
Grammar + lint + verifyPretty HTML with no gate
Your strategy labelsOwn / OSS / AWS by default
Fictional public samplesCustomer or internal brands
diagram-design disciplinediagram-design's job (one editorial SVG)

Quality model

LayerWhere
Brief grammardocs/BRIEF-GRAMMAR.md
Strategy framesdocs/STRATEGY-FRAMES.md
Diagram rulesdocs/MERMAID-RULES.md
Lintpython scripts/lint_brief.py --all
Product gatepython scripts/verify.py
Agent skillskills/systembrief/SKILL.md
Short promptsprompts/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.


Docs

TopicDoc
Architecturedocs/ARCHITECTURE.md
Decisionsdocs/DECISIONS.md
Historydocs/HISTORY.md
Learningsdocs/LEARNINGS.md
Intake schemadocs/INTAKE-SCHEMA.md
Docs indexdocs/README.md
ContributingCONTRIBUTING.md
ChangelogCHANGELOG.md

License

MIT. See LICENSE.

About

Strategy-first architecture briefs as one self-contained light HTML file

Resources

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages