Skip to content

Requirements: spec, not plan (abstraction level, no test info, bench sheets) - #94

Merged
arcadien merged 32 commits into
masterfrom
req/abstraction
Nov 20, 2026
Merged

arcadien merged 32 commits into
masterfrom
req/abstraction

Conversation

@arcadien

Copy link
Copy Markdown
Owner

Raises the requirements to spec level and moves test information out of them.

  • Rules (CLAUDE.md): 4 checks (observable, survives refactor, states its reason, verifiable alone); no test information in a requirement; helper tests tagged with the requirement that uses the helper; bench-only requirements get a tests/bench/<ID>.md sheet.
  • New PLAT: PLAT-POWER-008 (awake pin states, from TECH-HAL-004), PLAT-ISP-001 (v3.0 flashed with the sensor fitted, R9/R10), PLAT-DEBUG-001 (debug UART, from TECH-SERIAL-001).
  • TECH: HAL-001, HAL-006, MAIN-001, DECODE-002, DECODE-003 reworded as design constraints with their reason; 16 plan-level TECH requirements deprecated (their details stay in docs/architecture.md as design notes).
  • Tests retagged to the behaviour they cover (X10 timings → FUNC-X10-005, dec16ToHex → FUNC-X10-006/007, LED → PLAT-POWER-004, SoftSerial → PLAT-DEBUG-001, loopback → FUNC-DECODE-001, lux cell → UI-DECODE-001/003).
  • Dead code removed: AnalogFilter and dec32ToHex had no production caller.
  • All requirement files: "Verification:", "Verified by", "Acceptance:", "bench check pending" removed; behaviour examples kept as "Examples:".
  • Bench sheets: tests/bench/ (11 sheets + bring-up.md, Tars format). The v2.0 release waits for B2, B3, B5 on v3.0 and B3 on the reflashed mushroom.

Native tests (emitter 117, tinyDecoders 63), all board builds and lint pass.

🤖 Generated with Claude Code

arcadien and others added 20 commits November 20, 2026 10:43
…per tests, bench sheets)

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…om TECH-HAL-004), ISP with the sensor fitted (R9/R10), debug UART (from TECH-SERIAL-001)

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…-001): retag helper and HAL tests to the behaviour they cover (TECH-X10-001/002, HAL-002, HAL-005, CONVERT-001, SERIAL-001)

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
… lux unit tests (TECH-DECODE-001, TECH-DECODE-004)

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…(no production caller; TECH-FILTER-001/002, TECH-CONVERT-002)

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…DE-003): reword as design constraints with their reason; deprecate the plan-level TECH requirements (HAL-002..005, HAL-007, FILTER, CONVERT, SERIAL-001, X10, SENSOR-002, DECODE-001/004/005)

Deprecated: TECH-HAL-002..005, TECH-HAL-007, TECH-FILTER-001..002,
TECH-CONVERT-001..002, TECH-SERIAL-001, TECH-X10-001..002, TECH-SENSOR-002,
TECH-DECODE-001, TECH-DECODE-004, TECH-DECODE-005.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…rification sentences, point to PLAT-POWER-008 and FUNC-X10-005 instead of deprecated TECH IDs

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…CONF-DECODE-002..004): drop verification and acceptance sentences, and links to deprecated TECH IDs

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…FUNC-MAIN-001,FUNC-DECODE-001..010): test sentences become behaviour examples, verification and acceptance sentences dropped

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…are dropped where they restate the description

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…FUNC-SENSOR-001,PLAT-POWER-001,PLAT-POWER-003,PLAT-POWER-005,PLAT-POWER-006): bench test sheets and bring-up order

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
… for the new PLAT requirements; deprecated TECH rows kept as design notes, AnalogFilter and dec32ToHex rows removed

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…ated)

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…{id} matches C++ and Markdown

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…PLAT-POWER-005..008,FUNC-SENSOR-001): @Req tag on each bench sheet

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…agged only when every sheet passes for it

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…PLAT-POWER-005..008,FUNC-SENSOR-001): bench sheets run per release, one Results line per release

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…tion: build|inspection line; manual hardware checks stay in bench sheets

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…BUILD-007,CONF-BUILD-011,CONF-BUILD-014,CONF-BUILD-015,CONF-DECODE-002..004,FUNC-SENSOR-002,PLAT-POWER-001,PLAT-POWER-003): Verification: build|inspection line where a build or an inspection checks the requirement

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…BUG-001): derives_from a FUNC or TECH requirement (T7), not another PLAT

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
arcadien and others added 9 commits November 20, 2026 14:53
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…,TECH-CONVERT-001,TECH-X10-001..002,TECH-SENSOR-002,TECH-DECODE-004..005): drop the deprecated TECH-DECODE-001 dependency, TECH-SERIAL-002 at spec level, Superseded by on deprecated TECH requirements (audit 2026-11-20 findings 2, 4, 8)

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…es from TECH-HAL-001 with a baud tolerance and exact number formats; R9/R10 topology only in PLAT-ISP-001, which cites FUNC-SENSOR-001 (audit 2026-11-20 findings 1, 7, 9, 10)

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…finding 3)

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…vironments; PLAT-DEBUG-001 row names Attiny84aHal and the line format (audit 2026-11-20 findings 11, 12)

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
… of 'bench check pending' (audit 2026-11-20 finding 10)

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…SMATCH-001 extended)

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…open)

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…the DS18B20 draft; exact debug log lines (audit 2026-11-20 (2) findings 3, 4)

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
arcadien and others added 3 commits November 20, 2026 16:30
…ication lines without bench mention; LED framing only in PLAT-POWER-004, which also depends on FUNC-SENSOR-003 (audit 2026-11-20 (2) findings 5, 6)

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…ngs, LightSensor edge shows 5 x 30 ms, Oregon v2.1 in the luminosity note

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…-MISMATCH-001 extended, HIST-ARCH-REMOVED-ID-001, TEXT-BACKREF-001)

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@arcadien
arcadien merged commit d93bb47 into master Nov 20, 2026
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant