Report
When
Experiment reports, technical plans, analysis reviews, benchmark reports, stage conclusions. NOT for pure implementation, local fixes, simple Q&A.
Core Rules
- Every key conclusion must be supported by experiments, data, statistical analysis, or reliable sources.
- No fake evidence — HARD RULE: Every
PASSstatus in a report must quote a real, verifiable source: a trace.md line number, a real tool call ID, a real file path that exists on disk, or a real command output. If you cannot point to the evidence, the status MUST be⚠ partialor✗ fail, neverPASS. Writing "dispatched X" without a real dispatch, or "researched Y" without a real search, is fabrication — do not do it. - No fake evidence: if there is no experiment/figure/table/test, it cannot be a confirmed conclusion.
- If experiment results, structured result files, or plots already exist, they MUST be consumed in the report body or appendix.
Artifact exists, report does not show itis not allowed. - Every figure in the body must be followed by an analysis paragraph: what is seen, what conclusion it supports, whether it triggered new tests/rollback/risk judgment.
- Before citing any file, check it really exists on disk.
- Structure diagrams: use
mermaid. ASCII/plain-text box diagrams are forbidden — this is a blocking gate. - If plots contain Chinese text, check font rendering explicitly. Fix before delivery.
- Metric sanity gate — HARD RULE: any extreme headline metric (Sharpe > 10, accuracy > 0.95, AUPRC near 1.0, etc.) computed on fewer than ~100 samples, or contradicting the report's own main results, MUST be flagged
⚠ statistically meaninglessand must NOT be used as a conclusion argument. Report the sample size next to every headline metric.
Structure
- Background and goal
- Domain background and business mechanism
- Architecture / flow diagrams (mermaid)
- Data and experiment setup
- Methods, baselines, technical routes
- Main result tables
- Statistical tests and significance
- Visualization analysis
- Interpretability analysis (SHAP / feature attribution or equivalent)
- Failure cases, counterexamples, limits
- Risks, next-round hypotheses, engineering suggestions
- Conclusion
- Appendix
Artifact Layout
- Body:
docs/<name>.md - Figures:
docs/images/, referenced relatively in body - PDF export:
docs/<name>.pdfwhen formal delivery needed
Required Content
- At least one main result comparison table
- Post-experiment analysis (SHAP/feature attribution or equivalent) — NOT optional for formal reports
- Every conclusion points back to a concrete experiment ID, figure, table, or appendix item
- Structured result files (CSV/JSON/parquet) must be summarized or excerpted in body/appendix, not left only on disk
- For event-driven experiments: record
DETECTEDvsINJECTED, boundaries, parameters, random seed - For qualitative labels: robust statistics, effect size, support level,
Uncertain/Inconclusivehandling
Text Style
- Conclusion first, then evidence, then limits.
- Separate
confirmed/signs but not confirmed/current guess. - No adjective-only judgments without evidence.
Relation to Other Modules
- Experiment data/figures must come from
experimentmodule outputs. - TS conclusions must pass
ts-corevalidation. - Forecast outputs must pass
ts-coreforecast validation. - If data from many sources, unify through
ts-coredata contract first.