|
1 | 1 | schema: spec-driven |
2 | 2 |
|
3 | | -# Project context (optional) |
4 | | -# This is shown to AI when creating artifacts. |
5 | | -# Add your tech stack, conventions, style guides, domain knowledge, etc. |
6 | | -# Example: |
7 | | -# context: | |
8 | | -# Tech stack: TypeScript, React, Node.js |
9 | | -# We use conventional commits |
10 | | -# Domain: e-commerce platform |
| 3 | +context: | |
| 4 | + Writing style (all artifacts): plain, direct English. |
| 5 | + Use semantic line breaks. |
| 6 | + Clear, complete sentences. Prefer concise, but never at the cost of ambiguity. |
| 7 | + Bullets for lists of items; short paragraphs for explanations and context. |
| 8 | + No hedging or filler. |
| 9 | + Avoid restating well known MQTT and thin-edge concepts. |
| 10 | + State each decision and its reason. Skip elaboration unless a reader would |
| 11 | + need to infer a non-obvious connection. |
| 12 | + Never let terseness introduce ambiguity about scope — if a phrase could be |
| 13 | + read two ways, spell out which reading is meant. |
11 | 14 |
|
12 | | -# Per-artifact rules (optional) |
13 | | -# Add custom rules for specific artifacts. |
14 | | -# Example: |
15 | | -# rules: |
16 | | -# proposal: |
17 | | -# - Keep proposals under 500 words |
18 | | -# - Always include a "Non-goals" section |
19 | | -# tasks: |
20 | | -# - Break tasks into chunks of max 2 hours |
| 15 | +rules: |
| 16 | + proposal: |
| 17 | + - After "Why", add a "Proposed solution" section that introduces the feature from the |
| 18 | + user's point of view with short usage examples —before any internal mechanism. |
| 19 | + - In "What Changes", lead with what the feature introduces — |
| 20 | + what a user or consumer would interact with — |
| 21 | + before stating its properties or constraints (opt-in, security model, |
| 22 | + correctness guarantees). |
| 23 | + Don't qualify something the reader hasn't met yet. |
| 24 | + design: |
| 25 | + - Do not restate the problem or motivation — that lives in the proposal. Link the |
| 26 | + proposal instead of repeating its "Why". |
| 27 | + - "Open with a brief Context: name the problem being solved (one sentence, link the |
| 28 | + proposal for detail) and the constraints that shape the design decisions." |
| 29 | + - Assume a reader who already knows the problem and the user-facing surface. |
| 30 | + Spend the words on how it is built and why this design over the alternatives. |
0 commit comments