Back to catalog

investigation

Scaffolds a template for a small investigation for empirical experimentation. Use when the user asks for an investigation, experiment or research to support making design decisions, assess performance or try out a new idea that requires data or an MVP.

  • Category: discovered
  • Tags: github, community
  • Version: 1.0.0
  • Author: walid
  • Downloads: 0
  • GitHub stars: 20
  • Updated: 2025-12-22

Download the latest version (v1.0.0) from this page.

SKILL.md

---
name: investigation
description: Scaffolds a template for a small investigation for empirical experimentation. Use when the user asks for an investigation, experiment or research to support making design decisions, assess performance or try out a new idea that requires data or an MVP.
---

# Set up an investigation

## Instructions

1. Create a folder in `scratch/` with the format `{YYYY-MM-DD}-{descriptive-name}`. You will mainly work inside this folder.
2. Create a `README.md` in this folder where you will:
   1. Describe the task.
   2. Take background notes for context.
   3. Create a task list for progress tracking.
   4. Summarize results and outcomes.
3. Create scripts and testing data files in this folder to conduct an empirical investigation.
4. For multi-step investigations with sub-experiments, consider generating individual markdown files to take interediate notes.
5. The `README.md` should contain actionable findings to support a subsequent implementation or design decision.

## Best practices
- Both for this library and other ones, it's worth writing a simple script or calling the library interactively to list its members or try out different constructions to explore the API and document it in a markdown file called `API.md`.
- Generate figures when applicable (e.g., plots, data visualizations) and reference them inline in the markdown files.
-