Initial commit
This commit is contained in:
Zhongwei Li
21
skills/benchmarking/report-creator/CHANGELOG.md
Normal file
21
skills/benchmarking/report-creator/CHANGELOG.md
Normal file
@@ -0,0 +1,21 @@
|
||||
# Changelog
|
||||
|
||||
All notable changes to the report-creator skill will be documented in this file.
|
||||
|
||||
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
||||
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
||||
|
||||
## [0.1.0] - 2025-11-27
|
||||
|
||||
### Added
|
||||
- Initial release with Academic Research Report template
|
||||
- Complete 7-section document structure (Background through Conclusion)
|
||||
- Academic-style CSS template for PDF export
|
||||
- Table formatting guidelines (summary statistics, hypothesis evaluation, variables)
|
||||
- Figure embedding patterns with page-break protection
|
||||
- Typography conventions for academic writing
|
||||
- Report quality checklist
|
||||
- Integration with html-diagram-creator and markdown-to-pdf-converter
|
||||
|
||||
### Based On
|
||||
- paralleLLM empathy-experiment-v1.0.pdf (17 pages, November 2024)
|
||||
56
skills/benchmarking/report-creator/README.md
Normal file
56
skills/benchmarking/report-creator/README.md
Normal file
@@ -0,0 +1,56 @@
|
||||
# Report Creator
|
||||
|
||||
Publication-quality academic research report templates with professional structure and PDF export optimization.
|
||||
|
||||
## Overview
|
||||
|
||||
This skill provides templates for creating research reports, experiment writeups, technical whitepapers, and empirical studies. Templates follow academic paper conventions with proper structure, table formatting, and PDF export optimization.
|
||||
|
||||
## Key Features
|
||||
|
||||
- **Academic structure**: Abstract, Executive Summary, numbered sections, Appendices
|
||||
- **Professional tables**: Academic-style borders (2px top/bottom on headers)
|
||||
- **Figure support**: Centered figures with captions, page-break protection
|
||||
- **PDF-optimized CSS**: Proper page breaks, orphan/widow control, margins
|
||||
|
||||
## Quick Start
|
||||
|
||||
```bash
|
||||
# Trigger the skill
|
||||
"Create a research report for [your experiment]"
|
||||
|
||||
# Convert to PDF (after markdown is generated)
|
||||
pandoc report.md --standalone --css=pdf-style.css -t html | weasyprint - report.pdf
|
||||
```
|
||||
|
||||
## Trigger Phrases
|
||||
|
||||
- "create a research report"
|
||||
- "write up my experiment results"
|
||||
- "technical whitepaper template"
|
||||
- "empirical study format"
|
||||
- "academic report structure"
|
||||
|
||||
## Document Structure
|
||||
|
||||
1. Title and Metadata
|
||||
2. Abstract (150-250 words)
|
||||
3. Executive Summary with metrics table
|
||||
4. Background and Motivation
|
||||
5. Methodology
|
||||
6. Results
|
||||
7. Analysis and Discussion
|
||||
8. Limitations
|
||||
9. Future Work
|
||||
10. Conclusion
|
||||
11. Appendices
|
||||
|
||||
## Related Skills
|
||||
|
||||
- `html-diagram-creator` - Create publication-quality figures
|
||||
- `html-to-png-converter` - Export diagrams to PNG
|
||||
- `markdown-to-pdf-converter` - Convert markdown to PDF
|
||||
|
||||
## Documentation
|
||||
|
||||
See [SKILL.md](SKILL.md) for complete templates, CSS styling, and formatting guidelines.
|
||||
134
skills/benchmarking/report-creator/SKILL.md
Normal file
134
skills/benchmarking/report-creator/SKILL.md
Normal file
@@ -0,0 +1,134 @@
|
||||
---
|
||||
name: report-creator
|
||||
description: "Use PROACTIVELY when user needs to create research reports, experiment writeups, technical whitepapers, or empirical studies. Provides templates with professional structure, CSS styling for PDF export, and proper figure/table formatting. Currently supports: Academic Research Report. Based on publication-quality standards."
|
||||
version: "0.1.0"
|
||||
author: "Connor Skiro"
|
||||
category: documentation
|
||||
---
|
||||
|
||||
# Report Creator
|
||||
|
||||
## Overview
|
||||
|
||||
Provides templates for creating publication-quality research reports with professional structure, styling, and PDF export optimization.
|
||||
|
||||
**Available Templates**:
|
||||
- **Academic Research Report**: Full empirical study format
|
||||
|
||||
**Key Capabilities**:
|
||||
- Academic structure (Abstract, Methodology, Results, Discussion)
|
||||
- Professional tables with academic borders
|
||||
- Figure support with captions and page-break protection
|
||||
- PDF-optimized CSS via pandoc + weasyprint
|
||||
|
||||
## When to Use
|
||||
|
||||
**Trigger Phrases**:
|
||||
- "create a research report"
|
||||
- "write up my experiment results"
|
||||
- "technical whitepaper template"
|
||||
- "empirical study format"
|
||||
|
||||
**Use Cases**:
|
||||
- AI/ML experiment reports
|
||||
- Benchmark evaluation writeups
|
||||
- Technical research documentation
|
||||
- Empirical study publications
|
||||
|
||||
**NOT for**:
|
||||
- Blog posts or casual documentation
|
||||
- API documentation
|
||||
- Presentation slides
|
||||
- Quick README files
|
||||
|
||||
## Document Structure
|
||||
|
||||
| Section | Content |
|
||||
|---------|---------|
|
||||
| Abstract | 150-250 word summary |
|
||||
| Executive Summary | Key finding + metrics table |
|
||||
| 1. Background | Research context, hypotheses |
|
||||
| 2. Methodology | Design, variables, protocol |
|
||||
| 3. Results | Statistics, observations |
|
||||
| 4. Discussion | Hypothesis evaluation, implications |
|
||||
| 5. Limitations | Methodological, dataset, evaluation |
|
||||
| 6. Future Work | Research directions |
|
||||
| 7. Conclusion | Synthesis, bottom line |
|
||||
| Appendices | Supporting materials |
|
||||
|
||||
## Quick Start
|
||||
|
||||
1. Copy template from [reference/report-template.md](reference/report-template.md)
|
||||
2. Fill in sections with your research data
|
||||
3. Add figures using HTML figure tags
|
||||
4. Export to PDF:
|
||||
|
||||
```bash
|
||||
# One-liner conversion
|
||||
pandoc report.md --standalone --css=pdf-style.css -t html | weasyprint - report.pdf
|
||||
```
|
||||
|
||||
## Reference Files
|
||||
|
||||
| File | Content |
|
||||
|------|---------|
|
||||
| [report-template.md](reference/report-template.md) | Full markdown template |
|
||||
| [pdf-style.css](reference/pdf-style.css) | Academic CSS styling |
|
||||
| [table-patterns.md](reference/table-patterns.md) | Table and figure patterns |
|
||||
|
||||
## Key Formatting Patterns
|
||||
|
||||
### Tables (Academic Style)
|
||||
- 2px borders on header top/bottom
|
||||
- 1px borders between rows
|
||||
- 2px border on final row
|
||||
- `page-break-inside: avoid`
|
||||
|
||||
### Figures
|
||||
```html
|
||||
<figure style="margin: 2em auto; page-break-inside: avoid; text-align: center;">
|
||||
<img src="figure-1.png" alt="Description" style="max-width: 100%;">
|
||||
<figcaption>Figure 1: Caption text.</figcaption>
|
||||
</figure>
|
||||
```
|
||||
|
||||
### Typography
|
||||
| Element | Usage |
|
||||
|---------|-------|
|
||||
| **Bold** | Key findings, hypothesis status |
|
||||
| *Italic* | Figure captions, emphasis |
|
||||
| `code` | Model IDs, file names |
|
||||
| > Quote | Sample prompts, messages |
|
||||
|
||||
## Conversion Commands
|
||||
|
||||
```bash
|
||||
# Prerequisites
|
||||
which pandoc weasyprint # Both required
|
||||
|
||||
# Two-step
|
||||
pandoc report.md -o report.html --standalone --css=pdf-style.css
|
||||
weasyprint report.html report.pdf
|
||||
|
||||
# One-liner
|
||||
pandoc report.md --standalone --css=pdf-style.css -t html | weasyprint - report.pdf
|
||||
```
|
||||
|
||||
## Completion Checklist
|
||||
|
||||
- [ ] All 7 main sections present
|
||||
- [ ] Abstract summarizes question, method, findings
|
||||
- [ ] Executive summary has metrics table
|
||||
- [ ] Tables have academic borders
|
||||
- [ ] Figures have numbered captions
|
||||
- [ ] No orphaned headings at page bottoms
|
||||
|
||||
## Related Skills
|
||||
|
||||
- **html-diagram-creator**: Create figures for embedding
|
||||
- **html-to-png-converter**: Export diagrams to PNG
|
||||
- **markdown-to-pdf-converter**: General markdown conversion
|
||||
|
||||
---
|
||||
|
||||
**Based on**: paralleLLM empathy-experiment-v1.0.pdf (17 pages, November 2024)
|
||||
136
skills/benchmarking/report-creator/reference/pdf-style.css
Normal file
136
skills/benchmarking/report-creator/reference/pdf-style.css
Normal file
@@ -0,0 +1,136 @@
|
||||
/* Academic Report PDF Styling
|
||||
* For use with pandoc + weasyprint
|
||||
* Based on paralleLLM empathy-experiment-v1.0.pdf conventions
|
||||
*/
|
||||
|
||||
body {
|
||||
font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Helvetica, Arial, sans-serif;
|
||||
line-height: 1.6;
|
||||
max-width: 800px;
|
||||
margin: 0 auto;
|
||||
padding: 2em;
|
||||
}
|
||||
|
||||
h1, h2, h3, h4 {
|
||||
margin-top: 1.5em;
|
||||
margin-bottom: 0.5em;
|
||||
}
|
||||
|
||||
/* Academic-style tables */
|
||||
table {
|
||||
width: 100%;
|
||||
border-collapse: collapse;
|
||||
margin: 1em 0;
|
||||
page-break-inside: avoid;
|
||||
}
|
||||
|
||||
table th, table td {
|
||||
padding: 0.5em 0.75em;
|
||||
text-align: left;
|
||||
vertical-align: top;
|
||||
}
|
||||
|
||||
table thead th {
|
||||
border-top: 2px solid #000;
|
||||
border-bottom: 2px solid #000;
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
table tbody td {
|
||||
border-bottom: 1px solid #ddd;
|
||||
}
|
||||
|
||||
table tbody tr:last-child td {
|
||||
border-bottom: 2px solid #000;
|
||||
}
|
||||
|
||||
/* Blockquotes for prompts/examples */
|
||||
blockquote {
|
||||
border-left: 4px solid #ddd;
|
||||
margin: 1em 0;
|
||||
padding-left: 1em;
|
||||
color: #555;
|
||||
page-break-inside: avoid;
|
||||
}
|
||||
|
||||
/* Code blocks */
|
||||
code {
|
||||
background: #f5f5f5;
|
||||
padding: 0.2em 0.4em;
|
||||
border-radius: 3px;
|
||||
font-size: 0.9em;
|
||||
}
|
||||
|
||||
pre {
|
||||
background: #f5f5f5;
|
||||
padding: 1em;
|
||||
overflow-x: auto;
|
||||
border-radius: 5px;
|
||||
page-break-inside: avoid;
|
||||
}
|
||||
|
||||
pre code {
|
||||
background: none;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
/* Horizontal rules as section dividers */
|
||||
hr {
|
||||
border: none;
|
||||
border-top: 1px solid #ddd;
|
||||
margin: 2em 0;
|
||||
}
|
||||
|
||||
/* Page break control */
|
||||
@page {
|
||||
margin: 2cm;
|
||||
}
|
||||
|
||||
figure {
|
||||
page-break-inside: avoid;
|
||||
margin: 1.5em 0;
|
||||
}
|
||||
|
||||
figure img {
|
||||
max-width: 100%;
|
||||
height: auto;
|
||||
display: block;
|
||||
}
|
||||
|
||||
figcaption {
|
||||
text-align: center;
|
||||
font-style: italic;
|
||||
margin-top: 0.5em;
|
||||
font-size: 0.9em;
|
||||
}
|
||||
|
||||
/* Keep headings with following content */
|
||||
h2, h3, h4 {
|
||||
page-break-after: avoid;
|
||||
}
|
||||
|
||||
h2 {
|
||||
page-break-before: auto;
|
||||
margin-top: 2em;
|
||||
}
|
||||
|
||||
/* Prevent orphan paragraphs */
|
||||
p {
|
||||
orphans: 3;
|
||||
widows: 3;
|
||||
}
|
||||
|
||||
/* Keep lists together */
|
||||
ul, ol {
|
||||
page-break-inside: avoid;
|
||||
}
|
||||
|
||||
/* Reduced spacing for subsections */
|
||||
h3 {
|
||||
margin-top: 1.5em;
|
||||
}
|
||||
|
||||
/* Bold findings/labels stay with content */
|
||||
p strong:first-child {
|
||||
page-break-after: avoid;
|
||||
}
|
||||
218
skills/benchmarking/report-creator/reference/report-template.md
Normal file
218
skills/benchmarking/report-creator/reference/report-template.md
Normal file
@@ -0,0 +1,218 @@
|
||||
# Academic Research Report Template
|
||||
|
||||
Complete markdown template for research reports following academic conventions.
|
||||
|
||||
## Full Template
|
||||
|
||||
```markdown
|
||||
# [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
|
||||
@@ -0,0 +1,78 @@
|
||||
# Table Formatting Patterns
|
||||
|
||||
Academic-style table patterns for research reports.
|
||||
|
||||
## Summary Statistics Table
|
||||
|
||||
```markdown
|
||||
| Identity | N | Mean Score | Std Dev | Pass Rate | Metric |
|
||||
|----------|---|------------|---------|-----------|--------|
|
||||
| condition_a | 100 | 0.584 | 0.259 | 59.0% | **8.0%** |
|
||||
| condition_b | 99 | 0.658 | 0.138 | **87.9%** | 12.1% |
|
||||
```
|
||||
|
||||
## Hypothesis Evaluation Table
|
||||
|
||||
```markdown
|
||||
| Hypothesis | Status | Evidence |
|
||||
|------------|--------|----------|
|
||||
| H1 | **REJECTED** | [Brief summary with numbers] |
|
||||
| H2 | **NOT SUPPORTED** | [Brief summary with numbers] |
|
||||
| H3 | **PARTIALLY SUPPORTED** | [Brief summary with numbers] |
|
||||
```
|
||||
|
||||
## Variables Table (3-column)
|
||||
|
||||
```markdown
|
||||
| Level | Description | Example Framing |
|
||||
|-------|-------------|-----------------|
|
||||
| 1. Direct Human | Control condition | "Hi, I'm Sarah..." |
|
||||
| 2. AI Testing | Explicit evaluation | "[AUTOMATED TEST]..." |
|
||||
```
|
||||
|
||||
## Dependent Variables Table
|
||||
|
||||
```markdown
|
||||
| Variable | Type | Measurement |
|
||||
|----------|------|-------------|
|
||||
| Score | Continuous (0-1) | API response parsing |
|
||||
| Pass Rate | Binary | Score >= threshold |
|
||||
```
|
||||
|
||||
## Executive Summary Metrics
|
||||
|
||||
```markdown
|
||||
| Metric | Result |
|
||||
|--------|--------|
|
||||
| Primary hypothesis | [Supported/Rejected] — [brief reason] |
|
||||
| Secondary hypothesis | [Status] — [brief reason] |
|
||||
| Sample size | n = [N] |
|
||||
| Practical implication | [Key takeaway] |
|
||||
```
|
||||
|
||||
## Figure Embedding
|
||||
|
||||
### Standard Figure
|
||||
```html
|
||||
<figure style="margin: 2em auto; page-break-inside: avoid; text-align: center;">
|
||||
<img src="figure-1.png" alt="Description" style="max-width: 100%; height: auto;">
|
||||
<figcaption>Figure 1: Descriptive caption explaining what the figure shows.</figcaption>
|
||||
</figure>
|
||||
```
|
||||
|
||||
### Figure with Border
|
||||
```html
|
||||
<figure style="margin: 2em auto; page-break-inside: avoid; text-align: center; border: 1px solid #eee; padding: 1em; border-radius: 8px;">
|
||||
<img src="architecture.png" alt="System architecture">
|
||||
<figcaption>Figure 2: System architecture showing data flow.</figcaption>
|
||||
</figure>
|
||||
```
|
||||
|
||||
## Typography Conventions
|
||||
|
||||
| Element | Usage |
|
||||
|---------|-------|
|
||||
| **Bold** | Key findings, important metrics, hypothesis status |
|
||||
| *Italic* | Figure captions, emphasis, latin terms |
|
||||
| `code` | Model IDs, technical terms, file names |
|
||||
| > Blockquote | Sample prompts, user messages, system messages |
|
||||
Reference in New Issue
Block a user