quant-doc-generator-skill

Generate architecture documentation for a quantitative trading framework by analyzing the directory structure, core modules, and data flow to produce structured markdown outputs and visual diagrams. This Skill automates multi-stage analysis to create a complete, ready-to-share developer doc set.

Yes, you can create Mermaid diagrams automatically from your codebase. The Skill generates Mermaid diagram code and AI prompt-ready visualization prompts by analyzing the architectural structure and data flow of the uploaded framework.

The best way to visualize data flow in a quantitative framework is through multi-stage analysis that generates architecture briefs and visual outputs. This process applies structural and core module deep dives to map complex data pipelines into clear diagrams.

Yes, this documentation generator supports multi-stage analysis for onboarding developers. It provides four distinct modes—structure, core, viz, and all—to systematically break down the framework and deliver comprehensive documentation packages.

To start auto-documenting your framework, upload or reference your code and select an analysis mode. You can choose /struct for structure, /core for modules, /viz for visuals, or /all to generate the complete documentation package.

You should avoid using automated architecture visualization if your codebase lacks a clear directory structure or distinct core modules. The Skill requires a structured framework to accurately map data flow and generate meaningful Mermaid diagrams.