View on GitHub

Lightspeed core service

Lightspeed core service

How to organize PoC output

When a spike includes a proof-of-concept, the validation results should be structured so that reviewers can quickly understand what was tested and what was found.

Directory structure

Place results in docs/design/<feature>/poc-results/.

Name files with a numeric prefix that reflects reading order. Order them by usefulness for the human reviewer:

poc-results/
├── 01-poc-report.txt       — findings, methodology, implications
├── 02-conversation-log.txt  — human-readable record of the PoC
├── 03-token-usage.txt       — quantitative data
├── 04-events.json           — structured event data
├── 05-summaries.txt         — extracted outputs
├── ...
└── NN-raw-data.json         — full machine-readable data

Not all files apply to every PoC, use ones that make sense.

What a good report file contains

The report file (01-poc-report.txt) is the most important output. A reviewer who reads only this file should understand everything significant.

Include:

What NOT to include in the merge

PoC results are removed before merging the spike PR (see howto-run-a-spike.md, step 10). They serve their purpose during review and are preserved in git history.

Naming conventions