ds-report-writer

Files (1)

• SKILL.md

SKILL.md (first lines)

# DS Report Writer

Transform analysis outputs into clear, compelling reports for technical and non-technical audiences.

---

## Workflow

```
1. Gather analysis artifacts (notebooks, metrics, charts, data)
2. Determine audience and format
3. Generate report using appropriate template
4. Polish language and structure
```

---

## Step 1 -- Gather Artifacts

Collect from the user's workspace:
- Notebook outputs (`.ipynb` cell outputs)
- Saved charts (`.png`, `.svg`)
- Metrics / results (printed outputs, CSV files)
- Model comparison tables
- Feature importance rankings

---

## Step 2 -- Audience and Format

| Audience | Tone | Technical depth | Length |
|---|---|---|---|
| Executive / Business | Action-oriented, business impact | Minimal -- no code, few stats | 1-2 pages |
| Technical stakeholder (PM, analyst) | Balanced insights + methodology | Moderate -- key stats, no code | 2-4 pages |
| Technical peer (DS/ML engineer) | Precise, reproducible | Full -- code snippets, formulas, configs | 4-8 pages |

### Output Format

| Request | Format |
|---|---|
| "Report" / "document" | Markdown (`.md`) |
| "Slide deck" / "presentation" | Delegate to `pptx` skill if available, else markdown with slide-break markers |
| "Email summary" | Short markdown with copy-paste-ready text |

---

## Step 3 -- Generate Report

### Executive Report Template

```markdown
# [Project Title]: Key Findings

**Date**: [date] | **Author**: [name] | **Status**: [Draft/Final]

---

## Bottom Line

[1-2 sentences: what did you find and what should we do about it?]

## Key Findings

1. **[Finding]**: [1-2 sentences with the key metric and business implication]
2. **[Finding]**: [...]
3. **[Finding]**: [...]

## Recommendation

[What action should be taken? By whom? By when?]

## Methodology (Brief)

[2-3 sentences: what data was used, what approach was taken, key assumptions]

## Next Steps

- [ ] [Action item 1]
- [ ] [Action item 2]

---
*For detailed methodology, see the [technical appendix](link).*
```

### Technical Report Template

```markdown
# [Project Title]

**Date**: [date] | **Author**: [name]

---

## 1. Objective

[What question were we trying to answer? What problem were we solving?]

## 2. Data

- **Source**: [where the data came from]
- **Size**: [rows x columns]
- **Time range**: [if applicable]
- **Key variables**: [target + top features]
- **Data quality notes**: [missing values, cleaning applied]

## 3. Methodology

### Approach
[Description of the analytical approach]

### Models Evaluated
[If applicable: table of models with hyperparameters]

### Evaluation Metric
[Why this metric was chosen]

## 4. Results

### Key Metrics

From tezansahu/ai-garage, GPL-3.0.

More from tezansahu/ai-garage