| 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
- Create a folder in
scratch/with the format{YYYY-MM-DD}-{descriptive-name}. You will mainly work inside this folder. - Create a
README.mdin this folder where you will:- Describe the task.
- Take background notes for context.
- Create a task list for progress tracking.
- Summarize results and outcomes.
- Create scripts and testing data files in this folder to conduct an empirical investigation.
- For multi-step investigations with sub-experiments, consider generating individual markdown files to take interediate notes.
- The
README.mdshould 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.