diagram-reports-generator

Scan geometry-course chapters to generate Markdown reports of diagrams and MicroSims.

1|Updated Nov 21, 2024
One-click install
npx skills add https://github.com/dmccreary/geometry-course --skill diagram-reports-generator-dmccreary
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: diagram-reports-generator
Source: https://github.com/dmccreary/geometry-course/tree/main/diagram-reports-generator
Command: npx skills add https://github.com/dmccreary/geometry-course --skill diagram-reports-generator-dmccreary

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

This skill helps instructors and curriculum developers automatically generate comprehensive reports of diagrams and MicroSims across geometry-course chapters, enabling quick auditing and visualization.

Core Features & Use Cases

  • Automatically scans docs/chapters to identify diagrams and MicroSims, extracting metadata such as Bloom's taxonomy, UI element counts, and difficulty estimates.
  • Generates two report formats: a concise table view and a detailed, chapter-organized view, ready for MkDocs navigation.
  • Supports curriculum insights, instructor guides, and authoring workflows by providing ready-to-use documentation artifacts.

Quick Start

Run the script to generate the two reports by analyzing docs/chapters and outputting diagram-table.md and diagram-details.md.

Frequently Asked Questions about diagram-reports-generator

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

FAQPage Schema
How do I generate reports of diagrams and MicroSims across geometry-course chapters?

Generate diagram and MicroSim reports by running a Python script that scans docs/chapters to extract metadata like Bloom's levels, UI element counts, and difficulty estimates, producing structured Markdown table and detailed per-chapter views.

Can I automatically extract Bloom's taxonomy levels and difficulty estimates from Markdown documentation?

Automatically extract Bloom's taxonomy levels and difficulty estimates from Markdown details by scanning chapter files, mapping element metadata, and generating structured reports for curriculum insights and instructor guides.

How do I create a table view of interactive elements for an MkDocs curriculum site?

Create an MkDocs-compatible table view by running the script to analyze chapter documentation, outputting diagram-table.md with concise metadata and diagram-details.md with a chapter-organized breakdown for site navigation.

What's the best way to audit interactive MicroSims and diagrams in a geometry course?

Audit MicroSims and diagrams by scanning all chapters in docs/chapters to identify every interactive element, extract UI element counts, and produce comprehensive documentation artifacts for quick visualization and curriculum review.

Do I need any external dependencies to run the diagram report generation script?

Run the diagram report generation script without external dependencies, as it uses standard Python scripts to scan Markdown files and output structured reports directly into your documentation workflow.

Can I use these generated reports for curriculum insights and instructor guides?

Use the generated reports for curriculum insights and instructor guides by leveraging extracted metadata like Bloom's levels and difficulty estimates to support curriculum auditing and authoring workflows.