-
Notifications
You must be signed in to change notification settings - Fork 1
TEMPLATE
miswired edited this page Feb 2, 2026
·
1 revision
Status: Not Started Verified: 0/0 claims Last Updated: YYYY-MM-DD Source Document: {Document-Name}.md
This verification file validates technical claims in {Document-Name}.md against authoritative sources.
Document Purpose: {Brief description of what the source document teaches/explains}
Verification Scope:
- {Category 1 - e.g., Hardware specifications}
- {Category 2 - e.g., Software requirements}
- {Category 3 - e.g., Configuration details}
Known Issues: {List any issues found, or "None" if all verified}
- Source: {Specific reference - e.g., "ESP32-S3 TRM v1.1, p.47" or "pins.h:15"}
- Confidence: {HIGH|MEDIUM|LOW|UNKNOWN}
-
Status: {✓ Verified | ❌ Incorrect |
⚠️ Needs Testing | ? Unknown} - Notes: {Additional context, corrections, or test requirements}
Example:
-
Source: Code/Glitchy/include/pins.h:15
#define POWER_GLITCH_PIN 15 - Confidence: HIGH (verified in source code)
- Status: ✓ Verified
- Notes: Cross-referenced with KiCad schematic Rev 1.0, sheet 2
- Source: {Reference}
- Confidence: {HIGH|MEDIUM|LOW|UNKNOWN}
-
Status: {✓ Verified | ❌ Incorrect |
⚠️ Needs Testing | ? Unknown} - Notes: {Context}
Example:
- Source: platformio.ini (not found), project.md mentions PlatformIO but no version
- Confidence: LOW (version requirement not documented in code)
-
Status:
⚠️ Needs Testing - Notes: Should verify minimum PlatformIO version and document in platformio.ini
- Source: {Reference}
- Confidence: {HIGH|MEDIUM|LOW|UNKNOWN}
-
Status: {✓ Verified | ❌ Incorrect |
⚠️ Needs Testing | ? Unknown} - Notes: {Context}
Example:
- Source: Not found in code or configuration files
- Confidence: LOW (assumed from project name)
-
Status:
⚠️ Needs Testing - Notes: Requires testing on actual hardware. Check main.cpp WiFi initialization code.
- Source: {Reference}
- Confidence: {HIGH|MEDIUM|LOW|UNKNOWN}
-
Status: {✓ Verified | ❌ Incorrect |
⚠️ Needs Testing | ? Unknown} - Notes: {Context}
Example:
- Source: None (timing not documented)
- Confidence: UNKNOWN
-
Status:
⚠️ Needs Testing - Notes: Actual time depends on upload speed and firmware size. Should test and document range.
- Source: {Reference}
- Confidence: {HIGH|MEDIUM|LOW|UNKNOWN}
-
Status: {✓ Verified | ❌ Incorrect |
⚠️ Needs Testing | ? Unknown} - Notes: {Context}
Example:
- Source: "Power Analysis Attacks" (Mangard et al.), Chapter 8; Academic paper "Fault Attacks on Secure Embedded Devices" (Bar-El et al., 2004)
- Confidence: HIGH (established academic research)
- Status: ✓ Verified
- Notes: Well-documented attack technique. Multiple academic sources confirm mechanism.
- Document Location: {Section or line in source document}
- Problem: {What's wrong}
- Correct Information: {What it should say}
- Source: {Authoritative source for correction}
- Severity: {Critical|Major|Minor}
- Proposed Fix: {Suggested correction}
Example:
- Document Location: "Getting Started" section, step 3
- Problem: States "Pin 12 triggers the glitch"
- Correct Information: Pin 15 triggers the glitch (POWER_GLITCH_PIN)
- Source: pins.h:15
- Severity: Critical (incorrect hardware information)
- Proposed Fix: Change "Pin 12" to "Pin 15" in step 3
The following claims require testing on physical Glitchy hardware:
- {Claim requiring testing}
- {Another claim requiring testing}
Test Procedures:
- {Claim}: {How to test}
- {Claim}: {How to test}
Before marking this verification as complete:
- All technical claims identified and extracted
- Claims organized by category
- Each claim has source citation
- Each claim has confidence level
- Each claim has status icon
- Hardware-dependent claims marked for testing
- Issues documented with corrections
- Summary section completed
- Index README.md updated
- OpenSpec task marked complete
- {General observation}
- {Areas needing more research}
- {Related documents to check}
Verification completed by: {Name/Agent} Review date: YYYY-MM-DD Approved by: {Reviewer name}