40 lines
1.2 KiB
Markdown
40 lines
1.2 KiB
Markdown
# Evidence Contract
|
|
|
|
## Primary evidence first
|
|
|
|
Store command output, logs, generated query plans, benchmark results, browser observations, and other primary material under `docs/<프로젝트>/evidence/raw/` before creating presentation assets.
|
|
|
|
## Terminal evidence
|
|
|
|
For a command used as evidence, retain:
|
|
|
|
- exact command (without embedded credentials);
|
|
- working directory;
|
|
- executed timestamp;
|
|
- exit code;
|
|
- raw stdout/stderr;
|
|
- source revision when relevant.
|
|
|
|
Render terminal UI with `./tools/terminal-evidence/render_terminal.py`.
|
|
|
|
The visual asset is explanatory. The raw evidence is the provenance.
|
|
|
|
## Browser evidence
|
|
|
|
A screenshot record should state:
|
|
|
|
- URL/origin;
|
|
- code revision/environment;
|
|
- setup state;
|
|
- action performed;
|
|
- what visible/network fact the screenshot demonstrates;
|
|
- what it does not demonstrate.
|
|
|
|
## Diagram evidence
|
|
|
|
Architecture/sequence/state SVGs are derived explanations. Their nodes/edges must be traceable to code/config/runtime evidence. Do not draw a desired architecture and present it as the current architecture.
|
|
|
|
## Measurements
|
|
|
|
Every metric needs a context: dataset/workload, environment, relevant configuration, measurement method, and comparison condition. Preserve raw measurement results where practical.
|