@ericrisco/rsc 0.1.44 → 0.1.46
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/manifest.json +110 -86
- package/package.json +1 -1
- package/scripts/lib/domains.js +1 -1
- package/scripts/skill-migration-brief.md +192 -0
- package/skills/ab-testing/SKILL.md +9 -41
- package/skills/accessibility/SKILL.md +5 -7
- package/skills/ads/SKILL.md +9 -24
- package/skills/agent-eval/SKILL.md +7 -33
- package/skills/agent-safety/SKILL.md +7 -14
- package/skills/ai-media/SKILL.md +4 -20
- package/skills/analytics/SKILL.md +8 -30
- package/skills/analyze/SKILL.md +24 -59
- package/skills/angular/SKILL.md +12 -25
- package/skills/api-connector-builder/SKILL.md +10 -27
- package/skills/api-design/SKILL.md +7 -14
- package/skills/article-writing/SKILL.md +1 -18
- package/skills/astro/SKILL.md +36 -54
- package/skills/author-skill/SKILL.md +41 -74
- package/skills/author-skill/evals/README.md +5 -5
- package/skills/author-skill/evals/cases.yaml +8 -8
- package/skills/author-skill/references/description-recipe.md +25 -26
- package/skills/author-skill/references/eval-authoring.md +1 -1
- package/skills/author-skill/references/rsc-conventions.md +1 -1
- package/skills/automation-flows/SKILL.md +6 -16
- package/skills/automation-strategy/SKILL.md +1 -9
- package/skills/aws-essentials/SKILL.md +6 -23
- package/skills/backups/SKILL.md +1 -7
- package/skills/bash-scripting/SKILL.md +5 -9
- package/skills/bookkeeping/SKILL.md +2 -10
- package/skills/brand-identity/SKILL.md +18 -44
- package/skills/brand-voice/SKILL.md +4 -31
- package/skills/building-agents/SKILL.md +20 -103
- package/skills/business-intelligence/SKILL.md +9 -23
- package/skills/calendar-scheduling/SKILL.md +11 -27
- package/skills/case-studies/SKILL.md +3 -8
- package/skills/chatbot/SKILL.md +6 -23
- package/skills/chrome-extension/SKILL.md +2 -2
- package/skills/clarify/SKILL.md +31 -72
- package/skills/clickhouse-analytics/SKILL.md +2 -8
- package/skills/client-onboarding/SKILL.md +17 -19
- package/skills/cloudflare/SKILL.md +3 -8
- package/skills/code-review/SKILL.md +10 -23
- package/skills/codebase-onboarding/SKILL.md +2 -7
- package/skills/cold-outreach/SKILL.md +9 -30
- package/skills/community/SKILL.md +4 -31
- package/skills/competitor-watch/SKILL.md +20 -35
- package/skills/compliance/SKILL.md +10 -37
- package/skills/compose-multiplatform/SKILL.md +1 -1
- package/skills/constitution/SKILL.md +8 -35
- package/skills/content-engine/SKILL.md +4 -16
- package/skills/context-budget/SKILL.md +3 -21
- package/skills/continuous-learning/SKILL.md +10 -40
- package/skills/contracts/SKILL.md +6 -17
- package/skills/coolify/SKILL.md +8 -14
- package/skills/cost-tracking/SKILL.md +3 -11
- package/skills/course-builder/SKILL.md +17 -45
- package/skills/course-storytelling/SKILL.md +26 -94
- package/skills/cpp/SKILL.md +26 -71
- package/skills/csharp-dotnet/SKILL.md +19 -38
- package/skills/customer-support/SKILL.md +14 -37
- package/skills/dashboard/SKILL.md +6 -26
- package/skills/data-cleaning/SKILL.md +37 -63
- package/skills/data-policy/SKILL.md +8 -21
- package/skills/data-scraper/SKILL.md +1 -7
- package/skills/debug/SKILL.md +10 -49
- package/skills/deployment/SKILL.md +38 -101
- package/skills/design/SKILL.md +34 -116
- package/skills/fable-operator/SKILL.md +1 -4
- package/skills/fastapi/SKILL.md +50 -82
- package/skills/flutter/SKILL.md +41 -89
- package/skills/go/SKILL.md +57 -105
- package/skills/harness/SKILL.md +52 -68
- package/skills/implement/SKILL.md +1 -1
- package/skills/init/SKILL.md +152 -168
- package/skills/marketing/SKILL.md +30 -80
- package/skills/nextjs/SKILL.md +42 -116
- package/skills/orient/SKILL.md +25 -20
- package/skills/parallel/SKILL.md +9 -75
- package/skills/plan/SKILL.md +92 -165
- package/skills/postgresdb/SKILL.md +52 -72
- package/skills/presentations/SKILL.md +49 -87
- package/skills/python/SKILL.md +23 -72
- package/skills/react/SKILL.md +19 -67
- package/skills/review/SKILL.md +22 -52
- package/skills/rust/SKILL.md +40 -115
- package/skills/sdd-init/SKILL.md +9 -14
- package/skills/secure-coding/SKILL.md +80 -109
- package/skills/ship/SKILL.md +25 -55
- package/skills/tasks/SKILL.md +37 -61
- package/skills/typescript/SKILL.md +22 -55
- package/skills/verify/SKILL.md +8 -32
- package/skills/viral-score/SKILL.md +122 -0
- package/skills/viral-score/evals/README.md +16 -0
- package/skills/viral-score/evals/cases.yaml +50 -0
- package/skills/vue-nuxt/SKILL.md +45 -106
- package/skills/worktrees/SKILL.md +24 -69
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: cost-tracking
|
|
3
|
-
description: "Use when
|
|
3
|
+
description: "Use when metering and capping AI or cloud app spend — tokens read from the response `usage` object, priced off a dated rate table, ledgered per user/tenant/feature, with alerts and a hard cap before the bill. NOT cash runway (that is `finance-ops`), NOT cost-per-unit margin (that is `unit-economics`), NOT booking the spend (that is `bookkeeping`)."
|
|
4
4
|
tags: ["cost-tracking", "token-accounting", "llm-spend", "budgets", "alerts", "prompt-caching", "billing-guardrails", "finops"]
|
|
5
5
|
recommends: ["finance-ops", "unit-economics", "analytics", "stripe", "aws-essentials", "gcp-essentials"]
|
|
6
6
|
origin: risco
|
|
@@ -110,7 +110,7 @@ CREATE TABLE llm_cost_ledger (
|
|
|
110
110
|
);
|
|
111
111
|
```
|
|
112
112
|
|
|
113
|
-
This is an *operational* ledger, not the accounting record — categorizing the spend into the books is `bookkeeping`.
|
|
113
|
+
This is an *operational* ledger, not the accounting record — categorizing the spend into the books is `bookkeeping`, and the same rows feed the cost numerator in `unit-economics` and one input line in `finance-ops`. "Cost per active user" on the behavior side is `analytics`; charging customers for metered usage is `stripe`.
|
|
114
114
|
|
|
115
115
|
## Budgets, alerts, caps
|
|
116
116
|
|
|
@@ -144,7 +144,7 @@ App-level metering is your real-time guard. Cloud billing alerts are a **delayed
|
|
|
144
144
|
- **AWS** Cost Anomaly Detection is ML-based, runs ~3x/day with up to 24h data delay → SNS → Lambda. AWS Budgets adds threshold alerts on the same pipe.
|
|
145
145
|
- **GCP/Azure** are threshold-only. GCP's budget → Pub/Sub → Cloud Function is the one that can actually *pause or throttle* a workload programmatically.
|
|
146
146
|
|
|
147
|
-
Route every cloud alert into the **same alert pipe** as your app-level budget alerts so there's one place to look. The 24h delay is exactly why the in-app cap exists: by the time AWS notices the anomaly, the loop already spent the money. Recipes and the alert-routing pattern are in `references/cloud-caps.md`.
|
|
147
|
+
Route every cloud alert into the **same alert pipe** as your app-level budget alerts so there's one place to look. The 24h delay is exactly why the in-app cap exists: by the time AWS notices the anomaly, the loop already spent the money. Recipes and the alert-routing pattern are in `references/cloud-caps.md`; the cap plumbing in depth is `aws-essentials` / `gcp-essentials`.
|
|
148
148
|
|
|
149
149
|
## Build vs buy
|
|
150
150
|
|
|
@@ -173,11 +173,3 @@ Route every cloud alert into the **same alert pipe** as your app-level budget al
|
|
|
173
173
|
## Verify the artifact
|
|
174
174
|
|
|
175
175
|
`scripts/verify.sh [path]` lints a candidate cost config/ledger (yaml/json/ts) and fails if: a pricing entry lacks `effective_date` or `source`; a model referenced in logic is missing from the table; the ledger schema lacks an idempotency/request key or any attribution key; the budget declares no soft+hard pair; or cost looks derived from a `len()`/char estimate instead of a `usage` field. It is read-only and exits 0 on a clean config and on no config found — no false failure.
|
|
176
|
-
|
|
177
|
-
## Where this hands off
|
|
178
|
-
|
|
179
|
-
- Company cash runway / burn / forecast → `finance-ops` (cost-tracking is one input line).
|
|
180
|
-
- Cost-per-unit margin, contribution, CAC:LTV → `unit-economics` (this produces the cost numerator).
|
|
181
|
-
- "Cost per active user" behavior side / product telemetry → `analytics`.
|
|
182
|
-
- Billing customers, metered usage charges → `stripe`.
|
|
183
|
-
- The AWS/GCP cap plumbing in depth → `aws-essentials` / `gcp-essentials`.
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: course-builder
|
|
3
|
-
description: "Use when
|
|
3
|
+
description: "Use when turning \"I want to teach X\" into a defensible course skeleton — measurable outcomes (Bloom + ABCD), assessment that proves each one, sequenced modules, and an outcome×module×assessment matrix — for a workshop, bootcamp, cohort or onboarding track. NOT making one concept land emotionally with story or analogy (that is course-storytelling)."
|
|
4
4
|
tags: [course, curriculum, instructional-design, learning-outcomes, assessment]
|
|
5
5
|
recommends: [course-storytelling, presentations, sop-builder]
|
|
6
6
|
origin: risco
|
|
@@ -12,21 +12,10 @@ origin: risco
|
|
|
12
12
|
|
|
13
13
|
This skill owns the **skeleton**: the measurable outcomes, the assessment that certifies each one, the module sequence that builds toward them, and the alignment matrix tying it all together. It does not own the *teaching* of any one concept.
|
|
14
14
|
|
|
15
|
-
## What this skill owns / does NOT own
|
|
16
|
-
|
|
17
|
-
**Owns:** desired results (outcomes), acceptable evidence (assessment), build order (module sequence), and the outcome×module×assessment matrix that proves nothing is orphaned or unproven.
|
|
18
|
-
|
|
19
|
-
**Does NOT own:**
|
|
20
|
-
|
|
21
|
-
- Making a single concept *click and stick* emotionally — epiphany, sticky names, grounded analogies. That is `../course-storytelling/SKILL.md`. Build the skeleton HERE first, then hand each module there to make it land.
|
|
22
|
-
- Auditing a *finished* course for gaps, redundancy, anachronisms with a written report → `../review/SKILL.md`.
|
|
23
|
-
- Turning a designed module into slides/decks → `../presentations/SKILL.md` (+ `../design/SKILL.md` for the visual system).
|
|
24
|
-
- Sales/landing copy and launch emails → `../marketing/SKILL.md`. You design the learning contract, never the pitch.
|
|
25
|
-
- Fact-checking or sourcing the subject matter → `../research-ops/SKILL.md`. You structure what the user already knows.
|
|
26
|
-
- A repeatable internal procedure with steps but no outcomes/assessment → `../sop-builder/SKILL.md`. An SOP tells someone the steps; a course changes what they can DO and proves it.
|
|
27
|
-
|
|
28
15
|
**The litmus.** If the question is *"what must the learner be able to DO, how do we prove it, and in what order do we build it?"* → here. If it's *"how do I make THIS concept click and stick?"* → `../course-storytelling/SKILL.md`.
|
|
29
16
|
|
|
17
|
+
Route elsewhere when: auditing a *finished* course for gaps, redundancy, anachronisms with a written report → `../review/SKILL.md`; turning a designed module into slides/decks → `../presentations/SKILL.md` (+ `../design/SKILL.md` for the visual system); sales/landing copy and launch emails → `../marketing/SKILL.md` (you design the learning contract, never the pitch); fact-checking or sourcing the subject matter → `../research-ops/SKILL.md` (you structure what the user already knows); a repeatable internal procedure with steps but no outcomes/assessment → `../sop-builder/SKILL.md` (an SOP tells someone the steps; a course changes what they can DO and proves it).
|
|
18
|
+
|
|
30
19
|
## The grounding gate (read first — STOP if unmet)
|
|
31
20
|
|
|
32
21
|
You cannot design a course backward without knowing the destination. Do not write a single outcome until you have all three. Why: an outcome scoped for a senior engineer in a 90-minute workshop is wrong for a beginner in a 12-week cohort — same topic, different contract.
|
|
@@ -37,24 +26,9 @@ You cannot design a course backward without knowing the destination. Do not writ
|
|
|
37
26
|
|
|
38
27
|
If a `02-DOCS/wiki/teaching/` profile exists (the convention shared with `../course-storytelling/SKILL.md`), read it first and reuse it. Otherwise interview in ONE batch — ask all three at once, do not dribble questions. **Incomplete grounding = STOP and ask.** Depth, the interview script, and scope right-sizing by format → `references/grounding-and-scoping.md`.
|
|
39
28
|
|
|
40
|
-
## The non-negotiables
|
|
41
|
-
|
|
42
|
-
Each rule carries its one-line reason. Break one and the skeleton is not defensible.
|
|
43
|
-
|
|
44
|
-
1. **Design backward: outcomes first, then assessment, then content.** UbD has exactly three stages in order — desired results → acceptable evidence → learning experiences (Wiggins & McTighe, *Understanding by Design*). Content designed first is a dump with no destination.
|
|
45
|
-
2. **Every outcome uses a measurable Bloom verb.** The revised taxonomy (Anderson & Krathwohl, 2001) is six ascending levels of *verbs* — Remember → Understand → Apply → Analyze → Evaluate → Create — each supplying observable action verbs. A verb you can't observe, you can't assess.
|
|
46
|
-
3. **Banlist: never "understand", "know", "learn about", "appreciate", "be aware", "be familiar".** They name a private mental state, not an observable behavior. Replace with what the learner *does*: list, explain, build, debug, evaluate, design.
|
|
47
|
-
4. **Each outcome is ABCD-complete.** Audience + Behavior (verb + object) + Condition (situation/tools) + Degree (success criterion). A bare verb without a condition and a degree is not yet assessable — "write code" vs "given a failing test, write code that makes it pass".
|
|
48
|
-
5. **Every outcome is proven by ≥1 assessment.** No unproven outcomes. An outcome with no evidence is a promise you never keep.
|
|
49
|
-
6. **Every module ties to ≥1 outcome.** No orphan modules. If a module maps to no outcome, it's content the contract never asked for — cut it or write the outcome it serves.
|
|
50
|
-
7. **The verb in the outcome = the verb activated in teaching = the verb verified in assessment** (constructive alignment, Biggs). If the outcome says "design" and the quiz tests "recall", the assessment proves the wrong thing.
|
|
51
|
-
8. **Place BOTH formative and summative assessment.** Formative runs *during* learning (low/no stakes — quizzes, checklists, drafts) to give feedback; summative runs *at the end* (the project, the exam) to certify mastery. A course with only the final exam gives the learner no feedback loop.
|
|
52
|
-
9. **No content-first design.** "I already have these slides, build a course around them" inverts the contract. Outcomes decide what content survives.
|
|
53
|
-
10. **Right-size scope to format.** A 90-minute workshop earns ~1–2 outcomes; a 12-week cohort earns 5–8. Cramming a bootcamp's outcomes into a workshop guarantees none are actually achieved.
|
|
54
|
-
|
|
55
29
|
## The build workflow (one backward pass)
|
|
56
30
|
|
|
57
|
-
Run it in order. Do not jump to modules.
|
|
31
|
+
Run it in order. Do not jump to modules. UbD has exactly three stages in order — desired results → acceptable evidence → learning experiences (Wiggins & McTighe, *Understanding by Design*). Content designed first is a dump with no destination, and "I already have these slides, build a course around them" inverts the contract: outcomes decide what content survives.
|
|
58
32
|
|
|
59
33
|
```text
|
|
60
34
|
Stage 0 Grounding gate WHO + WHAT transformation + FORMAT. Incomplete → STOP.
|
|
@@ -70,9 +44,9 @@ Stage 5 QA gate Run scripts/verify.sh over the curriculum doc. F
|
|
|
70
44
|
or justify them. Then hand modules to course-storytelling.
|
|
71
45
|
```
|
|
72
46
|
|
|
73
|
-
## Writing measurable outcomes
|
|
47
|
+
## Stage 1 — Writing measurable outcomes
|
|
74
48
|
|
|
75
|
-
Pick the verb at the level the learner must actually operate. Recall ≠ build.
|
|
49
|
+
Pick the verb at the level the learner must actually operate. Recall ≠ build. The revised taxonomy (Anderson & Krathwohl, 2001) is six ascending levels of *verbs*, each supplying observable action verbs — a verb you can't observe, you can't assess.
|
|
76
50
|
|
|
77
51
|
```text
|
|
78
52
|
Level What the learner does Sample verbs
|
|
@@ -84,7 +58,9 @@ Evaluate judge against criteria evaluate, critique, justify, priori
|
|
|
84
58
|
Create produce something new design, build, compose, construct, ship
|
|
85
59
|
```
|
|
86
60
|
|
|
87
|
-
|
|
61
|
+
**Banlist — never "understand", "know", "learn about", "appreciate", "be aware", "be familiar".** They name a private mental state, not an observable behavior. Replace with what the learner *does*: list, explain, build, debug, evaluate, design.
|
|
62
|
+
|
|
63
|
+
Every outcome is **ABCD-complete** — a bare verb without a condition and a degree is not yet assessable ("write code" vs "given a failing test, write code that makes it pass"):
|
|
88
64
|
|
|
89
65
|
```text
|
|
90
66
|
[Audience] the learner
|
|
@@ -111,9 +87,9 @@ Good: Given a 20-line module, the learner writes 3 tests that cover the happy pa
|
|
|
111
87
|
|
|
112
88
|
Full per-level verb tables, the banlist, more worked ABCD examples, and course-level vs module-level granularity → `references/outcomes-and-blooms.md`.
|
|
113
89
|
|
|
114
|
-
## Designing aligned assessment
|
|
90
|
+
## Stage 2 — Designing aligned assessment
|
|
115
91
|
|
|
116
|
-
Assessment is the proof, not an afterthought. For every outcome, ask: *what would I have to SEE the learner do to believe they achieved it?* — and make that the assessment.
|
|
92
|
+
Assessment is the proof, not an afterthought. For every outcome, ask: *what would I have to SEE the learner do to believe they achieved it?* — and make that the assessment. Place **both** kinds: an outcome with no evidence is a promise you never keep, and a course with only the final exam gives the learner no feedback loop.
|
|
117
93
|
|
|
118
94
|
```text
|
|
119
95
|
Formative (during) Summative (at the end)
|
|
@@ -127,12 +103,12 @@ Bloom fit Remember/Understand/Apply Apply/Analyze/Evaluate/Create
|
|
|
127
103
|
|
|
128
104
|
Two hard checks:
|
|
129
105
|
|
|
130
|
-
- **Verb match
|
|
106
|
+
- **Verb match** (constructive alignment, Biggs). The assessment must require the *same* verb as the outcome. Outcome "build" → assessment is a build, not a multiple-choice quiz. Outcome "evaluate" → assessment asks for a judgement with justification, not recall. If the outcome says "design" and the quiz tests "recall", the assessment proves the wrong thing.
|
|
131
107
|
- **Content validity.** The set of assessments must cover the *breadth* of the outcomes — every outcome touched, none over-weighted into a vanity exam. Competency-based design maps this via the matrix and certifies demonstrated mastery, not seat time.
|
|
132
108
|
|
|
133
109
|
The full formative↔summative menu mapped to Bloom levels, the content-validity / blueprint checklist, and the verb-match rule worked end-to-end → `references/assessment-design.md`.
|
|
134
110
|
|
|
135
|
-
## Sequencing modules + the alignment matrix
|
|
111
|
+
## Stages 3–4 — Sequencing modules + the alignment matrix
|
|
136
112
|
|
|
137
113
|
Order modules by **prerequisite** (you can't build before you can run), give each **one focus**, and map each to ≥1 outcome. Then emit the matrix — this is the artifact `scripts/verify.sh` checks.
|
|
138
114
|
|
|
@@ -144,7 +120,7 @@ Order modules by **prerequisite** (you can't build before you can run), give eac
|
|
|
144
120
|
| O3 evaluate an API's error model | M5 | F: M5 peer review · S: capstone rubric|
|
|
145
121
|
```
|
|
146
122
|
|
|
147
|
-
Read the matrix two ways: down a column finds **orphan modules** (a module in no row → cut or
|
|
123
|
+
Read the matrix two ways: down a column finds **orphan modules** (a module in no row → content the contract never asked for, so cut it or write the outcome it serves); across the outcome list finds **unproven outcomes** (an outcome with an empty assessment cell → design evidence). A complete matrix has no empty cells.
|
|
148
124
|
|
|
149
125
|
## Decision table (branch only where the flow actually splits)
|
|
150
126
|
|
|
@@ -175,12 +151,8 @@ Attitude/disposition outcome Assess with reflection + observed behavior; ha
|
|
|
175
151
|
| Summative-only: just a final exam | No feedback loop during learning | Place formative checkpoints throughout |
|
|
176
152
|
| Scope creep: bootcamp outcomes in a workshop | None are actually achievable in the time | Right-size outcome count to the format |
|
|
177
153
|
|
|
178
|
-
##
|
|
179
|
-
|
|
180
|
-
The skeleton is the start, not the finish.
|
|
154
|
+
## Stage 5 — QA gate and hand-off
|
|
181
155
|
|
|
182
|
-
|
|
183
|
-
- Need decks → `../presentations/SKILL.md` for slides, `../design/SKILL.md` for the visual system.
|
|
184
|
-
- A repeatable team procedure surfaced that isn't a course → `../sop-builder/SKILL.md`.
|
|
156
|
+
`scripts/verify.sh` checks your curriculum's STRUCTURE and ALIGNMENT (measurable verbs, the matrix, proven outcomes, formative + summative). Fix its warnings or justify them.
|
|
185
157
|
|
|
186
|
-
|
|
158
|
+
Then hand **each module** to `../course-storytelling/SKILL.md` to make the teaching land (epiphany, named models, grounded analogies). You built *what* and *in what order*; that skill makes it stick. The boundary is executable: this skill's verify.sh does not judge whether the teaching lands, and `course-storytelling`'s checks narrative, not structure.
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: course-storytelling
|
|
3
|
-
description: "Use when
|
|
3
|
+
description: "Use when lesson or course content is correct but forgettable and a concept has to LAND: profiles the learner, breaks the blocking false belief, then rebuilds it as epiphany story → named model → grounded analogy → proof → so-what. NOT outcomes, assessment or module order (that is `course-builder`), NOT slide visuals (that is `presentations`)."
|
|
4
4
|
tags: [course, teaching, storytelling, content]
|
|
5
5
|
recommends: [presentations]
|
|
6
6
|
origin: risco
|
|
@@ -10,75 +10,38 @@ origin: risco
|
|
|
10
10
|
|
|
11
11
|
*Take a concept the student would forget and turn it into one they can't unhear. Profile the learner first, then run every concept through the Expert Secrets machine: epiphany story → named model → grounded analogy → proof → do-this-now → the so-what.*
|
|
12
12
|
|
|
13
|
-
This skill owns **the teaching narrative**: extracting what a course actually teaches, finding where it stays abstract, and rebuilding each concept so the realization happens *in the student*, emotionally, not just on the slide. It borrows Russell Brunson's *Expert Secrets* frameworks as a **teaching methodology** (this is method, not text reproduction).
|
|
13
|
+
This skill owns **the teaching narrative**: extracting what a course actually teaches, finding where it stays abstract, and rebuilding each concept so the realization happens *in the student*, emotionally, not just on the slide. It borrows Russell Brunson's *Expert Secrets* frameworks as a **teaching methodology** (this is method, not text reproduction).
|
|
14
14
|
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
Use when:
|
|
18
|
-
|
|
19
|
-
- You have lesson/module/course material (slides, transcript, notes, outline) and the teaching feels flat, abstract, or forgettable.
|
|
20
|
-
- A concept is technically correct but "doesn't click" — students nod and forget.
|
|
21
|
-
- You want a sticky, ownable name + a grounded analogy + a story for an idea.
|
|
22
|
-
- You're sequencing a course and need a belief-building narrative spine, not just a topic list.
|
|
23
|
-
- You want the student to *feel* the epiphany the expert felt, so they trust the teacher.
|
|
24
|
-
|
|
25
|
-
Do NOT use when (delegate or decline):
|
|
26
|
-
|
|
27
|
-
- Designing the slide visuals, layout, or exporting a deck → `presentations` (+ `design` for the visual system).
|
|
28
|
-
- Writing sales/landing copy for the course → `marketing`.
|
|
29
|
-
- Auditing an existing lesson for gaps/redundancy/anachronisms with a written report → a content-audit/review-content pass (run it first; bring its findings here).
|
|
30
|
-
- Pure fact-checking or research of the subject matter → `deep-research`.
|
|
15
|
+
Boundaries: `course-builder` decides what the course must prove — outcomes, assessment, module order — and hands you the skeleton; this skill makes each concept inside it land. `presentations` turns the landed lesson into a deck, `design` owns the pixels, `marketing` owns the words that sell the course, and a content-audit/review-content pass diagnoses an existing lesson (run it first, bring its findings here — that pass audits, this one rebuilds).
|
|
31
16
|
|
|
32
17
|
**Teaching ≠ selling.** Brunson's frameworks here serve comprehension and retention. The "sale" you're closing is *belief in the idea and trust in the teacher* — never bolt a pitch onto a lesson.
|
|
33
18
|
|
|
34
|
-
## Learner grounding (read this first)
|
|
35
|
-
|
|
36
|
-
**Hard rule: never reframe or rewrite teaching without a complete learner + audience profile.** Teaching into a void defaults to your AI-median explainer voice — abstract, jargon-true, emotionally dead. The cure is grounding every concept in a real, persisted profile of *who is learning and what must change in them*. An incomplete profile is a hard STOP, not a warning.
|
|
37
|
-
|
|
38
|
-
Run this gate before reframing a single concept:
|
|
39
|
-
|
|
40
|
-
1. **Locate the teaching profile.** Read the project's root `CLAUDE.md` and follow its short `## Knowledge map` pointer to the full index at `02-DOCS/wiki/index.md`, looking for the entry into `02-DOCS/wiki/teaching/` (the `harness` Karpathy-wiki convention: compiled profile articles live under `02-DOCS/wiki/teaching/`, raw inputs the user pastes live under `02-DOCS/raw/teaching/`). If `CLAUDE.md` is absent, the index entry is missing, or it points nowhere, treat the profile as ABSENT.
|
|
41
|
-
|
|
42
|
-
2. **Check completeness** against the checklist in `references/learner-grounding.md`. The profile is complete only when every dimension is filled: the LEARNER (level, prior knowledge, pains, desires, current false beliefs, what they want to DO after); the AUDIENCE (same as the buyer or not? live vs recorded? size? context?); the target TRANSFORMATION (the one result, before→after); and constraints/format. **Any empty dimension = INCOMPLETE.**
|
|
43
|
-
|
|
44
|
-
3. **If ABSENT or INCOMPLETE, STOP and interview the user.** Ask the question script from `references/learner-grounding.md`, **one focused batch at a time** (do not dump all questions at once; ask, wait, persist, then continue). Then:
|
|
45
|
-
- **a.** Write/update the profile into `02-DOCS/wiki/teaching/` as wiki articles (`learner.md`, `audience.md`, `transformation.md`, `false-beliefs.md`, `constraints.md`, plus an `index.md`), following the article format in `references/learner-grounding.md`. Save any raw material the user pastes (transcripts, outlines, existing slides) verbatim into `02-DOCS/raw/teaching/` and link it from the article's `> Raw:` line. Create the directories if they do not exist.
|
|
46
|
-
- **b.** Index the teaching profile in `02-DOCS/wiki/index.md` (the Knowledge map; root `CLAUDE.md` keeps only a short pointer). Ensure root `CLAUDE.md` carries that short pointer to the index, creating `CLAUDE.md` if absent (additive only — never delete existing sections). The exact snippet is in `references/learner-grounding.md`.
|
|
47
|
-
|
|
48
|
-
4. **Only once the profile exists and is complete, proceed.** Cite which articles you used (e.g. "grounded in `02-DOCS/wiki/teaching/learner.md` and `false-beliefs.md`") so every reframing is traceable to a real learner, not an imagined one.
|
|
19
|
+
## Learner grounding (hard gate — read this first)
|
|
49
20
|
|
|
50
|
-
|
|
21
|
+
**Never reframe teaching without a complete learner + audience profile.** Teaching into a void defaults to your AI-median explainer voice — abstract, jargon-true, emotionally dead. An incomplete profile is a hard STOP, not a warning, because everything downstream (which false belief to break, which analogy lands) is derived from it.
|
|
51
22
|
|
|
52
|
-
|
|
23
|
+
1. **Locate the profile.** Read the root `CLAUDE.md`, follow its `## Knowledge map` pointer to `02-DOCS/wiki/index.md`, and look for the entry into `02-DOCS/wiki/teaching/` (the `harness` Karpathy-wiki convention: compiled articles in `02-DOCS/wiki/teaching/`, raw user-pasted material in `02-DOCS/raw/teaching/`). No `CLAUDE.md`, no index entry, or a pointer that goes nowhere = ABSENT.
|
|
24
|
+
2. **Check completeness** against the checklist in `references/learner-grounding.md`: the LEARNER (level, prior knowledge, pains, desires, current false beliefs, what they DO after), the AUDIENCE (same as the buyer? live vs recorded? size? context?), the target TRANSFORMATION (one result, before→after), and constraints/format. **Any empty dimension = INCOMPLETE.**
|
|
25
|
+
3. **If ABSENT or INCOMPLETE, STOP and interview** with the batched question script in `references/learner-grounding.md` — one focused batch at a time, wait, persist, continue. Then write the profile as wiki articles under `02-DOCS/wiki/teaching/` (`learner.md`, `audience.md`, `transformation.md`, `false-beliefs.md`, `constraints.md`, `index.md`), save pasted transcripts/outlines/slides verbatim under `02-DOCS/raw/teaching/` and link them from each article's `> Raw:` line, index the profile in `02-DOCS/wiki/index.md`, and ensure root `CLAUDE.md` carries the short pointer to that index (create it if absent; additive only). Article format and the exact `CLAUDE.md` snippet → `references/learner-grounding.md`.
|
|
26
|
+
4. **Only then proceed**, citing which articles you used ("grounded in `02-DOCS/wiki/teaching/learner.md` and `false-beliefs.md`") so every reframing is traceable to a real learner, not an imagined one.
|
|
53
27
|
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
These are constraints, not preferences. Violating any one is a defect.
|
|
57
|
-
|
|
58
|
-
1. **Learner profile first.** No reframing before the grounding gate passes (above). Cite the articles you used.
|
|
59
|
-
2. **Every concept gets a story.** A concept taught without a story is a fact the student will forget. Each concept carries at least one Epiphany Bridge beat. (→ `references/brunson-frameworks.md`)
|
|
60
|
-
3. **Every concept gets a name.** An unnamed idea can't be repeated, so it can't be retained. Give each concept a short, ownable, sticky label the student can say out loud. (→ `references/mental-models.md`)
|
|
61
|
-
4. **Every abstraction gets grounded.** No abstract claim ships without a concrete analogy from the learner's own world. "Abstract with no analogy" is a defect. (→ `references/mental-models.md`)
|
|
62
|
-
5. **Break the false belief before installing the new one.** Find the learner's current false belief (vehicle / internal / external), shatter it with a story, *then* teach. Teaching on top of an unbroken false belief bounces off. (→ `references/brunson-frameworks.md`)
|
|
63
|
-
6. **The realization happens in the student.** Tell the epiphany as a journey, don't state the conclusion. The student should *arrive* at the insight, feeling it, not be handed it.
|
|
64
|
-
7. **One Big Domino per module.** Name the single belief that, once believed, makes the rest fall. Build the module to knock it over. (→ `references/brunson-frameworks.md`)
|
|
65
|
-
8. **End every concept on the so-what.** The payoff the student future-paces: what's now possible, what they can do tomorrow. A concept with no so-what is trivia.
|
|
66
|
-
9. **Ground in the learner, not in the expert.** Explain it in the student's world and vocabulary, not the discipline's. Jargon density is a flagged defect. (→ `references/mental-models.md`)
|
|
67
|
-
10. **No fabricated proof or invented credentials.** Stories must be true. If you need a demo/result/proof the user hasn't supplied, mark `[[NEEDS PROOF]]` and ask — never invent a case study or a metric.
|
|
28
|
+
Sole exception: if the user explicitly says "skip the profile, just rough one concept", produce a clearly-labelled `DRAFT (ungrounded — not learner-checked)` and still recommend running the gate before anything ships.
|
|
68
29
|
|
|
69
30
|
## The teaching workflow (one pass)
|
|
70
31
|
|
|
71
32
|
Run in order. Each step feeds the next; skipping one shows up as a flat lesson downstream.
|
|
72
33
|
|
|
73
|
-
1. **Ground.** Pass the
|
|
74
|
-
2. **Analyze the content.** Ingest the material; extract the concept list AND the *existing* narrative spine; map ungrounded / jargon-heavy / story-less gaps. → `references/course-analysis.md`.
|
|
75
|
-
3. **Set the Big Domino.**
|
|
76
|
-
4. **Per concept, find the false belief** the learner holds (vehicle / internal / external) and the epiphany that breaks it. → `references/brunson-frameworks.md`.
|
|
77
|
-
5. **Run the landing recipe** for each concept: hook → epiphany-bridge story → named mental model → grounded analogy → proof/demo → application (do-this-now) → so-what. → `references/concept-landing-recipe.md`.
|
|
78
|
-
6. **Name the models.** Engineer a sticky, ownable name + a concrete analogy for each. → `references/mental-models.md`.
|
|
34
|
+
1. **Ground.** Pass the gate above. Load learner, audience, transformation, false beliefs, constraints from `02-DOCS/wiki/teaching/` and cite them.
|
|
35
|
+
2. **Analyze the content.** Ingest the material; extract the concept list AND the *existing* narrative spine; map the ungrounded / jargon-heavy / story-less gaps. → `references/course-analysis.md`.
|
|
36
|
+
3. **Set the Big Domino.** Name the one belief per module that makes everything else fall, and sequence concepts to build toward it — not every lesson is equally important. → `references/brunson-frameworks.md`, `references/course-analysis.md`.
|
|
37
|
+
4. **Per concept, find the false belief** the learner holds (vehicle / internal / external) and the epiphany that breaks it. Break it *before* teaching: a lesson landing on an unbroken false belief bounces off. → `references/brunson-frameworks.md`.
|
|
38
|
+
5. **Run the landing recipe** for each concept: hook → epiphany-bridge story → named mental model → grounded analogy → proof/demo → application (do-this-now) → so-what. Every concept gets all seven; a concept with no story is forgotten by tomorrow, and one with no so-what is trivia. → `references/concept-landing-recipe.md`.
|
|
39
|
+
6. **Name the models.** Engineer a sticky, ownable name + a concrete analogy for each — an unnamed idea can't be repeated, so it can't be retained, and an abstraction with no analogy from the learner's own world is a defect. → `references/mental-models.md`.
|
|
79
40
|
7. **Rewrite the narrative spine.** Resequence the whole module/course as a belief-building arc (the Hero's Two Journeys), not a topic dump. → `references/brunson-frameworks.md`, `references/course-analysis.md`.
|
|
80
41
|
8. **Run the QA gate** (below) and `scripts/verify.sh`. Fix every flag or justify it.
|
|
81
42
|
|
|
43
|
+
Throughout: tell the epiphany as a journey so the student *arrives* at the insight rather than being handed the conclusion, explain it in the student's vocabulary instead of the discipline's, and **never invent proof** — if a demo, result, metric or credential wasn't supplied by the user, mark it `[[NEEDS PROOF]]` and ask.
|
|
44
|
+
|
|
82
45
|
## The Expert Secrets toolkit (applied to teaching)
|
|
83
46
|
|
|
84
47
|
These are the frameworks you run each concept through. Full templates, scripts, and worked teaching examples → `references/brunson-frameworks.md`. Source-confirmed sequence and naming via Brunson's *Expert Secrets* (see citations in that reference).
|
|
@@ -96,11 +59,11 @@ These are the frameworks you run each concept through. Full templates, scripts,
|
|
|
96
59
|
|
|
97
60
|
## Analyze the course content
|
|
98
61
|
|
|
99
|
-
Before reframing
|
|
62
|
+
Before reframing you must *see* what's there. Ingest the material and produce three artifacts — full method, extraction prompts and the gap-map template → `references/course-analysis.md`:
|
|
100
63
|
|
|
101
64
|
1. **Concept inventory** — every distinct idea the material teaches, in teaching order, with a one-line "what the student should be able to DO after this".
|
|
102
|
-
2. **Existing narrative spine** — the
|
|
103
|
-
3. **Gap map** — per concept, flag
|
|
65
|
+
2. **Existing narrative spine** — the throughline already present (if any): where it hooks, where it goes flat, whether it builds belief or just stacks topics.
|
|
66
|
+
3. **Gap map** — per concept, flag `no-story`, `unnamed`, `no-analogy`, `jargon-dense`, `no-application`, `no-so-what`, `belief-not-broken`. These flags drive the rework and mirror exactly what `scripts/verify.sh` greps for.
|
|
104
67
|
|
|
105
68
|
```text
|
|
106
69
|
GAP MAP (one row per concept)
|
|
@@ -137,9 +100,9 @@ Good (landed) — HOOK: "Ever double-clicked 'Pay' and panicked you'd be charg
|
|
|
137
100
|
SO-WHAT: you can now retry fearlessly — failures stop being scary."
|
|
138
101
|
```
|
|
139
102
|
|
|
140
|
-
## Anti-patterns
|
|
103
|
+
## Anti-patterns
|
|
141
104
|
|
|
142
|
-
|
|
|
105
|
+
| Anti-pattern | Reality / fix |
|
|
143
106
|
| --- | --- |
|
|
144
107
|
| "The concept is clear, it doesn't need a story" | Clear ≠ memorable. No story = forgotten by tomorrow. Add an Epiphany Bridge beat. |
|
|
145
108
|
| "Naming it is cutesy / unnecessary" | Unnamed ideas can't be repeated, so they aren't retained. Give it a sticky, ownable name. |
|
|
@@ -152,24 +115,9 @@ Good (landed) — HOOK: "Ever double-clicked 'Pay' and panicked you'd be charg
|
|
|
152
115
|
| "I'll invent a quick case study to prove it" | Never. Stories must be true. Mark `[[NEEDS PROOF]]` and ask the user. |
|
|
153
116
|
| "Just teach the skill (outer journey)" | The inner journey (identity shift) is why they love the teacher. Teach both. |
|
|
154
117
|
|
|
155
|
-
## Quick reference
|
|
156
|
-
|
|
157
|
-
| Lever | Default | Where |
|
|
158
|
-
| --- | --- | --- |
|
|
159
|
-
| Story per concept | mandatory — ≥1 Epiphany Bridge beat | `references/brunson-frameworks.md` |
|
|
160
|
-
| Epiphany beats | backstory → desire → wall → epiphany → new opportunity → result | `references/brunson-frameworks.md` |
|
|
161
|
-
| False beliefs | break vehicle + internal + external before teaching | `references/brunson-frameworks.md` |
|
|
162
|
-
| Big Domino | one per module; aim the arc at it | `references/brunson-frameworks.md` |
|
|
163
|
-
| Named model | short, ownable, repeatable; one per concept | `references/mental-models.md` |
|
|
164
|
-
| Analogy | concrete, from the learner's world | `references/mental-models.md` |
|
|
165
|
-
| Recipe beats | hook → story → model → analogy → proof → application → so-what | `references/concept-landing-recipe.md` |
|
|
166
|
-
| Jargon | flagged when dense / unglossed | `scripts/verify.sh` |
|
|
167
|
-
| End on | the so-what (future-paced payoff) | `references/concept-landing-recipe.md` |
|
|
168
|
-
| Profile | hard gate before any rework | `references/learner-grounding.md` |
|
|
169
|
-
|
|
170
118
|
## Teaching QA gate ("did it land?")
|
|
171
119
|
|
|
172
|
-
Run before claiming done. `scripts/verify.sh` automates the greppable subset.
|
|
120
|
+
Run before claiming done. `scripts/verify.sh` automates the greppable subset (read-only; warns by default, `--strict` to gate CI).
|
|
173
121
|
|
|
174
122
|
- [ ] Learner + audience profile located, complete, and cited (which articles grounded this).
|
|
175
123
|
- [ ] Big Domino named for the module; the arc is sequenced to knock it over.
|
|
@@ -184,22 +132,6 @@ Run before claiming done. `scripts/verify.sh` automates the greppable subset.
|
|
|
184
132
|
- [ ] No fabricated stories, proof, metrics, or credentials; gaps marked `[[NEEDS PROOF]]`.
|
|
185
133
|
- [ ] The reworked narrative spine builds belief, it doesn't just stack topics.
|
|
186
134
|
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
## Project grounding (02-DOCS + CLAUDE.md)
|
|
190
|
-
|
|
191
|
-
This skill's 02-DOCS record has two parts, both indexed in `02-DOCS/wiki/index.md` (the Knowledge map; root `CLAUDE.md` keeps only a short pointer):
|
|
192
|
-
|
|
193
|
-
- The **learner + audience profile** at `02-DOCS/wiki/teaching/` — a hard gate (see "Learner grounding" above): if the index lacks the entry or any dimension is empty (learner, audience, transformation, false beliefs, constraints), ask until complete, persist it (raw inputs to `02-DOCS/raw/teaching/`), index it in `02-DOCS/wiki/index.md` and ensure root `CLAUDE.md` carries the short pointer to that index (create `CLAUDE.md` if absent), and only then teach.
|
|
194
|
-
- The **course teaching conventions** at `02-DOCS/wiki/stack/course-storytelling.md` (or alongside the profile under `02-DOCS/wiki/teaching/`) — the established narrative spine, the named mental models already coined, the Big Dominoes per module, and the teacher's Attractive Character. Recorded, not gated.
|
|
195
|
-
|
|
196
|
-
Create/update both as decisions are made and keep their entries current in `02-DOCS/wiki/index.md` (root `CLAUDE.md` keeps only a short pointer to it). Read them first on every use and keep every reframing consistent with them. If the project has no `02-DOCS` layer at all, skip this section silently and proceed with the in-session profile.
|
|
197
|
-
|
|
198
|
-
## See Also
|
|
135
|
+
## Project grounding (02-DOCS)
|
|
199
136
|
|
|
200
|
-
-
|
|
201
|
-
- `../presentations/SKILL.md` — turn the landed lesson into a deck (Marp/Slidev/PPTX, speaker notes).
|
|
202
|
-
- `../design/SKILL.md` — the visual system and pixels behind the slides/diagrams.
|
|
203
|
-
- A content-audit / review-content pass — audit an existing lesson/module/notebook for gaps, redundancy, anachronisms, and storytelling problems (run it first; bring its report here). This skill rebuilds; that pass diagnoses.
|
|
204
|
-
- `../harness/SKILL.md` — the `02-DOCS` Karpathy-wiki convention this skill persists the teaching profile into.
|
|
205
|
-
- References: `references/brunson-frameworks.md`, `references/learner-grounding.md`, `references/mental-models.md`, `references/course-analysis.md`, `references/concept-landing-recipe.md`.
|
|
137
|
+
Beyond the gated learner profile, record the **course teaching conventions** at `02-DOCS/wiki/stack/course-storytelling.md` (or alongside the profile under `02-DOCS/wiki/teaching/`): the established narrative spine, the named mental models already coined, the Big Dominoes per module, and the teacher's Attractive Character. Recorded, not gated — update it as decisions are made, keep its entry current in `02-DOCS/wiki/index.md`, read it first on every use, and keep every reframing consistent with it. The wiki convention itself belongs to `../harness/SKILL.md`. If the project has no `02-DOCS` layer, skip this silently and proceed with the in-session profile.
|
package/skills/cpp/SKILL.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: cpp
|
|
3
|
-
description: "Use when writing, reviewing, modernizing, building, or debugging C++ - RAII and resource lifetime, smart-pointer ownership
|
|
3
|
+
description: "Use when writing, reviewing, modernizing, building, or debugging C++ - RAII and resource lifetime, smart-pointer ownership, move semantics and the Rule of Zero/Five, target-based CMake with FetchContent, and killing undefined behavior with ASan/UBSan/TSan plus clang-tidy. NOT borrow-checker / Result-Option / cargo memory safety (that is rust)."
|
|
4
4
|
tags: [cpp, c++, modern-cpp, raii, cmake]
|
|
5
5
|
recommends: [rust, secure-coding, deployment]
|
|
6
6
|
origin: risco
|
|
@@ -23,30 +23,13 @@ behind confirmed compiler support. Compiler matrix:
|
|
|
23
23
|
| Clang | 13–18 progressively | in progress (Clang 23 dev) | `-std=c++23` / `-std=c++2c` |
|
|
24
24
|
| MSVC | latest | partial | `/std:c++23` / `/std:c++latest` |
|
|
25
25
|
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
- Writing or fixing a **CMake** build (target-based, `FetchContent`, presets).
|
|
34
|
-
- Hunting UB: enabling ASan/UBSan/TSan, reading the report, applying the lifetime/bounds/overflow/race fix.
|
|
35
|
-
- Move semantics / Rule of Zero/Five / value-category and `noexcept` questions.
|
|
36
|
-
|
|
37
|
-
**When NOT to use (delegate):**
|
|
38
|
-
|
|
39
|
-
- Rust borrow-checker, `Result`/`Option`, cargo, ownership-via-compiler -> [`rust`](../rust/SKILL.md).
|
|
40
|
-
C++ buys safety with discipline (RAII + smart pointers + sanitizers); do not conflate the mechanisms.
|
|
41
|
-
- Language-agnostic threat modeling, authz, OWASP-class review -> [`secure-coding`](../secure-coding/SKILL.md)
|
|
42
|
-
(this skill keeps the C++-specific controls: bounds, lifetime, integer overflow, format-string, sanitizers).
|
|
43
|
-
- Containerizing/shipping the binary (Dockerfile, GitHub Actions) -> [`deployment`](../deployment/SKILL.md)
|
|
44
|
-
(this skill stops at the CMake build + a sanitizer-CI note).
|
|
45
|
-
- Recording per-project C++ conventions in a workspace wiki -> [`harness`](../harness/SKILL.md)
|
|
46
|
-
(see "Project grounding" below).
|
|
47
|
-
|
|
48
|
-
The C++-specific memory/UB controls — sanitizers, bounds, lifetime, signed overflow — live
|
|
49
|
-
**here**, not in `secure-coding`.
|
|
26
|
+
Delegate: borrow-checker, `Result`/`Option`, cargo, ownership-via-compiler ->
|
|
27
|
+
[`rust`](../rust/SKILL.md) — C++ buys safety with discipline (RAII + smart pointers +
|
|
28
|
+
sanitizers); do not conflate the mechanisms. Language-agnostic threat modeling, authz,
|
|
29
|
+
OWASP-class review -> [`secure-coding`](../secure-coding/SKILL.md); the C++-specific
|
|
30
|
+
memory/UB controls (bounds, lifetime, integer overflow, format-string, sanitizers) stay
|
|
31
|
+
**here**. Containerizing and shipping the binary -> [`deployment`](../deployment/SKILL.md);
|
|
32
|
+
this skill stops at the CMake build + a sanitizer-CI note.
|
|
50
33
|
|
|
51
34
|
## Decision rules
|
|
52
35
|
|
|
@@ -59,20 +42,19 @@ Apply these on every C++ edit:
|
|
|
59
42
|
only when you need polymorphism, shared lifetime, or a large/stable address. Why: values can't dangle.
|
|
60
43
|
3. **Name the owner.** Exactly one type owns each resource; everyone else borrows. Why: ambiguous
|
|
61
44
|
ownership is how use-after-free is born.
|
|
62
|
-
4. **`make_unique`/`make_shared`, never `new`.**
|
|
63
|
-
|
|
64
|
-
5. **Never an owning raw pointer.** Raw pointers/references are non-owning borrows only. Why: a raw
|
|
65
|
-
pointer that owns is a leak or a double-free waiting on the next early `return`/throw.
|
|
45
|
+
4. **`make_unique`/`make_shared`, never `new`.** So no naked owning pointer ever exists.
|
|
46
|
+
5. **Never an owning raw pointer.** Raw pointers/references are non-owning borrows only.
|
|
66
47
|
6. **Borrow with `span` / `string_view` / `const T&`.** Pass a view, not a copy or an owner, for
|
|
67
|
-
read access. Why: zero-copy and the callee provably can't free what it doesn't own.
|
|
68
|
-
7. **`const` and `constexpr` by default.**
|
|
69
|
-
|
|
48
|
+
read access. Why: zero-copy, and the callee provably can't free what it doesn't own.
|
|
49
|
+
7. **`const` and `constexpr` by default.** Why: the compiler enforces what you don't mutate and
|
|
50
|
+
moves work off the hot path.
|
|
70
51
|
8. **No UB by construction.** No use-after-move, OOB index, signed overflow, uninitialized read, or
|
|
71
|
-
data race.
|
|
52
|
+
data race.
|
|
72
53
|
9. **Sanitizers + warnings-as-errors in CI.** Build and test under `-fsanitize=address,undefined`
|
|
73
|
-
with `-Werror`.
|
|
54
|
+
with `-Werror`.
|
|
74
55
|
10. **Target-based CMake only.** `target_link_libraries` / `target_compile_features`, never
|
|
75
|
-
directory-level `include_directories`/`link_libraries`. Why: directory commands leak flags
|
|
56
|
+
directory-level `include_directories`/`link_libraries`. Why: directory commands leak flags
|
|
57
|
+
globally and break composition.
|
|
76
58
|
|
|
77
59
|
## Ownership & smart pointers
|
|
78
60
|
|
|
@@ -277,7 +259,7 @@ bad index is UB, not an exception.
|
|
|
277
259
|
- **Local gate:** `./scripts/verify.sh` from the project root runs format + an ASan/UBSan,
|
|
278
260
|
warnings-as-errors build + `ctest` + optional tidy/cppcheck. Missing tools are skipped, not failed.
|
|
279
261
|
|
|
280
|
-
## Anti-patterns
|
|
262
|
+
## Anti-patterns
|
|
281
263
|
|
|
282
264
|
| Rationalization | Reality / Do instead |
|
|
283
265
|
| --- | --- |
|
|
@@ -307,41 +289,14 @@ bad index is UB, not an exception.
|
|
|
307
289
|
| Format | `clang-format -i src/*.cpp` |
|
|
308
290
|
| Static analysis | `clang-tidy -p build src/*.cpp` · `cppcheck --enable=warning src/` |
|
|
309
291
|
| Std flag | GCC/Clang `-std=c++23` (C++26: GCC `-std=c++26`, Clang `-std=c++2c`), MSVC `/std:c++23` |
|
|
310
|
-
| Own a resource | `auto p = std::make_unique<T>(...);` |
|
|
311
|
-
| Borrow a range | `std::span<const T>` / `std::string_view` |
|
|
312
292
|
| Local gate | `./scripts/verify.sh` (run in your project root) |
|
|
313
293
|
|
|
314
|
-
## Project grounding (02-DOCS
|
|
315
|
-
|
|
316
|
-
When this skill runs in a project with a `02-DOCS/` layer (the [`harness`](../harness/SKILL.md)
|
|
317
|
-
Karpathy wiki), record this project's C++ decisions there and index them in `02-DOCS/wiki/index.md`,
|
|
318
|
-
so the next agent inherits them instead of re-deriving them.
|
|
319
|
-
|
|
320
|
-
1. **Find the article** `02-DOCS/wiki/stack/cpp.md`, indexed in `02-DOCS/wiki/index.md` (the Knowledge map index; root `CLAUDE.md` points to it).
|
|
321
|
-
2. **If missing or stale**, create/update it with the project's real choices — std version and
|
|
322
|
-
compiler matrix, CMake layout and presets, the sanitizer/warning policy, and the ownership/error
|
|
323
|
-
conventions — then index it in `02-DOCS/wiki/index.md` (the Knowledge map; root `CLAUDE.md` keeps only a short pointer to it).
|
|
324
|
-
3. **Read it first on every use** and stay consistent; when a convention changes, update the article
|
|
325
|
-
(bump its `Updated` date) in the same change.
|
|
326
|
-
|
|
327
|
-
No `02-DOCS/` layer? Skip silently (optionally suggest `harness`). Technical conventions are
|
|
328
|
-
*recorded, not gated* — never block the task on this.
|
|
329
|
-
|
|
330
|
-
## See Also
|
|
331
|
-
|
|
332
|
-
Sibling skills (all resolve under `skills/`):
|
|
333
|
-
|
|
334
|
-
- [`rust`](../rust/SKILL.md) - the other systems language; compiler-enforced ownership instead of
|
|
335
|
-
RAII discipline. Any borrow-checker / `Result`-`Option` / cargo question goes there.
|
|
336
|
-
- [`secure-coding`](../secure-coding/SKILL.md) - language-agnostic threat modeling and authz/abuse
|
|
337
|
-
review (this skill keeps the C++-specific memory/UB controls).
|
|
338
|
-
- [`deployment`](../deployment/SKILL.md) - containerizing and shipping the built binary (this skill
|
|
339
|
-
stops at the CMake build + a sanitizer-CI note).
|
|
340
|
-
- [`harness`](../harness/SKILL.md) - the `02-DOCS/` workspace wiki where per-project C++ conventions
|
|
341
|
-
are recorded (see "Project grounding").
|
|
342
|
-
|
|
343
|
-
Local references (read when):
|
|
294
|
+
## Project grounding (02-DOCS)
|
|
344
295
|
|
|
345
|
-
|
|
346
|
-
-
|
|
347
|
-
|
|
296
|
+
In a project with a `02-DOCS/` layer (the [`harness`](../harness/SKILL.md) Karpathy wiki), read
|
|
297
|
+
`02-DOCS/wiki/stack/cpp.md` first and stay consistent with it. If it is missing or stale, write
|
|
298
|
+
this project's real choices there — std version and compiler matrix, CMake layout and presets, the
|
|
299
|
+
sanitizer/warning policy, the ownership/error conventions — index it in `02-DOCS/wiki/index.md`
|
|
300
|
+
(the Knowledge map; root `CLAUDE.md` keeps only a pointer to it), and bump its `Updated` date in
|
|
301
|
+
the same change as any convention change. No `02-DOCS/` layer? Skip silently (optionally suggest
|
|
302
|
+
`harness`). Conventions are *recorded, not gated* — never block the task on this.
|