research-report

Generate a Markdown report from JSON results with a table of contents.

4|Updated Feb 20, 2023
One-click install
npx skills add https://github.com/Hayao0819/dotfiles --skill research-report-hayao0819
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: research-report
Source: https://github.com/Hayao0819/dotfiles/tree/main/modules/home-manager/llm/skills/research-report
Command: npx skills add https://github.com/Hayao0819/dotfiles --skill research-report-hayao0819

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Researchers often spend significant time compiling and formatting results into readable reports. This skill automatically transforms deep research outputs into a structured Markdown report, saving time and reducing manual errors.

Core Features & Use Cases

  • Automated Summary: Aggregates results from a directory of outputs (e.g., JSON files) and generates a cohesive narrative with a navigable table of contents.
  • Field-aware Reporting: Supports multi-language field mappings and flexible categorization for diverse datasets.
  • Use Case: A scientist runs an analysis producing multiple topic JSONs; the skill aggregates them into a publish-ready topic report.

Quick Start

Place the topic results into a directory and run the generator to produce report.md.

Frequently Asked Questions about research-report

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate a Markdown report from JSON research data?

To generate a Markdown report from JSON research data, the skill extracts JSON results from a topic directory, formats fields based on mappings, and writes a structured Markdown report to topic/report.md.

Can I automatically build a table of contents from multiple JSON files?

Yes, you can automatically build a table of contents from multiple JSON files. The skill computes key metrics from the aggregated research results and generates a navigable table of contents for the final Markdown report.

How do I skip unknown fields or uncertain values when aggregating research results?

To skip unknown fields or uncertain values when aggregating research results, the generated Python script automatically filters the data. It skips uncertain values and unknown fields while applying field mappings to format the output.

Does the report generator support custom field selection for summaries?

Yes, the report generator supports custom field selection for summaries. It allows user-selectable fields to tailor the research summary, ensuring the generated Markdown report includes only the relevant data metrics.

What is the best way to automate converting deep research outputs into a cohesive narrative?

The best way to automate converting deep research outputs into a cohesive narrative is using this skill. It aggregates directory outputs, applies multi-language field mappings, and emits a Python script to produce a structured report.

Do I need external dependencies to write a Python script for Markdown report generation?

No, you do not need external dependencies to write a Python script for Markdown report generation. The skill emits a standalone generate_report.py script that reads JSON files and writes the formatted Markdown report independently.