Files
gh-cskiro-claudex/skills/benchmarking/report-creator/reference/report-template.md
2025-11-29 18:16:40 +08:00

4.2 KiB
Raw Blame History

Academic Research Report Template

Complete markdown template for research reports following academic conventions.

Full Template

# [Title]
## [Subtitle - descriptive]

**Date**: [Date]
**Model Tested**: [model-id] (if applicable)
**Trials**: [sample size description]

---

## Abstract

[150-250 word summary of research question, methodology, key findings, implications]

---

## Executive Summary

**Key Finding**: [One-sentence summary of most important result]

| Metric | Result |
|--------|--------|
| Primary hypothesis | [Supported/Rejected] — [brief reason] |
| Secondary hypothesis | [Status] — [brief reason] |
| Sample size | n = [N] |
| Practical implication | [Key takeaway] |

---

## 1. Background and Motivation

### 1.1 Research Context
[Problem statement, why this matters, prior work]

### 1.2 Hypotheses
**H1 (Primary)**: [Testable prediction]
**H2 (Secondary)**: [Additional prediction]

---

## 2. Methodology

### 2.1 Experimental Design

#### 2.1.1 Overview
[Design summary: conditions × scenarios × trials]

#### 2.1.2 Variables

**Independent Variable**: [What you manipulated]

| Level | Description | Example |
|-------|-------------|---------|
| 1. [Condition] | [Description] | [Example framing] |
| 2. [Condition] | [Description] | [Example framing] |

**Dependent Variables**:

| Variable | Type | Measurement |
|----------|------|-------------|
| [Metric] | Continuous (0-1) | [How measured] |

**Control Variables**:
- [List of held-constant factors]

### 2.2 Dataset Design
[Scenario distribution, categories, sampling]

### 2.3 Scoring Logic
[How pass/fail or scores determined]

### 2.4 Experimental Protocol

Model: [model-id] Provider: [API provider] Test Cases: [N] Trials per Case: [N] Total Completions: [N] Runtime: [duration]


### 2.5 Test Infrastructure
[Figure showing pipeline/architecture]

---

## 3. Results

### 3.1 Summary Statistics
[Main results table with all conditions]

### 3.2 [Key Metric] by [Grouping Variable]
[Visualization or detailed breakdown]

### 3.3 Key Observations

**Finding 1: [Title]**
[Description with specific numbers]

**Finding 2: [Title]**
[Description with specific numbers]

---

## 4. Analysis and Discussion

### 4.1 Hypothesis Evaluation

| Hypothesis | Status | Evidence |
|------------|--------|----------|
| H1 | [REJECTED/SUPPORTED] | [Summary] |
| H2 | [REJECTED/SUPPORTED] | [Summary] |

### 4.2 Interpretation
[What the results mean, behavioral modes identified]

### 4.3 Theoretical Implications
[Broader significance, model behavior insights]

### 4.4 Practical Implications
[Deployment recommendations, risk assessment]

---

## 5. Limitations

### 5.1 Methodological Limitations
1. **[Limitation]**: [Explanation]
2. **[Limitation]**: [Explanation]

### 5.2 Dataset Limitations
[Sample size, language, cultural scope]

### 5.3 Evaluation Limitations
[Scoring limitations, validation gaps]

---

## 6. Future Work
1. **[Direction]**: [Description]
2. **[Direction]**: [Description]

---

## 7. Conclusion
[3-5 paragraph synthesis: main findings, implications, bottom line]

---

## Appendix A: [Title]

### A.1 [Subsection]
[Supporting materials, sample prompts, raw data excerpts]

## Appendix B: [Title]

### B.1 [Technical Details]
[Implementation details, indicator lists, architecture diagrams]

---

*Report generated by [Author]*

Section Guidelines

Abstract (150-250 words)

  • Research question or problem
  • Methodology summary
  • Key findings
  • Implications

Executive Summary

  • One-sentence key finding
  • Metrics table with hypothesis status
  • Sample size and practical takeaway

Background

  • Why this research matters
  • Prior work context
  • Clear, testable hypotheses

Methodology

  • Experimental design overview
  • Variables table (IV, DV, control)
  • Dataset description
  • Scoring criteria
  • Protocol details

Results

  • Summary statistics table
  • Visualizations or breakdowns
  • Numbered findings with specific data

Discussion

  • Hypothesis evaluation table
  • Interpretation of findings
  • Theoretical implications
  • Practical recommendations

Limitations

  • Methodological constraints
  • Dataset scope limitations
  • Evaluation gaps

Future Work

  • Numbered research directions
  • Extensions of current work

Conclusion

  • Synthesis of findings
  • Bottom-line takeaway