ext-skills/docs/findings-template.md
2026-08-28 09:49:35 -07:00

41 lines
1.6 KiB
Markdown

# Experimental Findings Template
Use this template when adding an entry to [experimental-findings.md](experimental-findings.md). Include enough evidence for another contributor to evaluate the result, and write "Not documented" rather than inferring missing details.
---
## [Implementation or experiment name]
**Date:** YYYY-MM-DD or Not documented
**Implementation:**
- **Repository:** [name](URL)
- **Author:** Name or handle
- **Relevant artifacts:** Links to skill files, server/client code, commits, or pull requests
**Approach tested:** Link to the relevant section of [approaches.md](approaches.md), or describe the approach if it is not listed.
**Setup:**
- **Clients tested:** Names and versions
- **Models tested:** Names and versions
- **Configuration notes:** Relevant server, runtime, dependency, and operating-system details
**What was tested:** Describe the scenarios or behaviors evaluated.
**Results:**
- **What worked:** Observed successes
- **What didn't:** Observed failures
- **What was surprising:** Unexpected behavior
**Requirements or design questions addressed:** Link the finding to the current [problem statement](problem-statement.md), [use cases](use-cases.md), or [approaches](approaches.md).
**Evidence and reproduction:** Provide commands, configuration, logs, measurements, or links that let another contributor inspect or repeat the experiment.
**Limitations:** State what remains untested, uncertain, or specific to the recorded environment.
**Sources and attribution:** Link community input and identify contributors by name and handle where possible.
---