doc-synthesizer

Extract modules, dependencies, and data-flow from codebases into Mermaid diagrams.

Updated Apr 20, 2026
One-click install
npx skills add https://github.com/thistleknot/skills --skill doc-synthesizer
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: doc-synthesizer
Source: https://github.com/thistleknot/skills/tree/main/doc-synthesizer
Command: npx skills add https://github.com/thistleknot/skills --skill doc-synthesizer

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Producing up-to-date documentation for a codebase is slow and error-prone, especially when dependencies and data flows are not obvious from reading files one by one.

Core Features & Use Cases

  • AST-based project analysis: infers module structure, imports, classes, functions, and module summaries directly from source code.
  • Dependency visualization with Mermaid: generates module dependency graphs to reveal coupling and circular dependencies.
  • Data-flow diagramming (optional): produces Mermaid data-flow diagrams that map entry points to internal resources and external integrations, with optional URI fetch/crawl for additional context.
  • Use case: generate onboarding and architecture overviews for new teammates by turning an unfamiliar repository into readable documentation plus diagrams.

Quick Start

Use the doc-synthesizer skill to create a documentation synthesis report for your repository and include dependency and data-flow Mermaid diagrams.

Frequently Asked Questions about doc-synthesizer

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

FAQPage Schema
How do I generate architecture documentation from source code?

Generating architecture documentation from source code requires AST-based analysis to extract modules, imports, and functions. The process synthesizes this inferred structure into a Markdown artifact with embedded JSON metadata, creating readable onboarding overviews for new teammates.

How do I visualize circular dependencies and module coupling in a codebase?

To visualize circular dependencies and module coupling, you can generate Mermaid-formatted dependency graphs from code. By extracting AST-based module relationships, the graphs reveal structural coupling and highlight circular dependencies directly from the source files.

Can I map external integrations and data flow from repository entry points?

Yes, mapping external integrations and data flow from entry points involves generating Mermaid data-flow diagrams. This process traces internal resources and external connections, utilizing optional URI crawling to fetch additional context for accurate architecture visualization.

Does automated codebase documentation generation work without external dependencies?

Automated codebase documentation generation can work without external dependencies. AST-based analysis extracts module summaries and inferred data-flow directly from the local repository, requiring only the source code to produce Markdown documentation and Mermaid diagrams.

What is the best way to create onboarding docs for an unfamiliar codebase?

The best way to create onboarding docs for an unfamiliar codebase is synthesizing AST-based documentation. This approach extracts module relationships and entry points, generating Markdown architecture overviews alongside Mermaid dependency graphs to accelerate team understanding.

When should I avoid using AST-based code analysis for documentation synthesis?

Avoid using AST-based code analysis for documentation synthesis when a codebase relies heavily on dynamic imports or runtime metaprogramming. Static extraction cannot accurately infer module relationships, dependencies, or data-flow for the generated Mermaid diagrams in these scenarios.