project-dumper

Generate structured Markdown documentation from multi-language source code.

19|1|Updated Mar 22, 2026
One-click install
npx skills add https://github.com/zrh091110225/safe-project-dumper --skill project-dumper
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: project-dumper
Source: https://github.com/zrh091110225/safe-project-dumper/tree/main
Command: npx skills add https://github.com/zrh091110225/safe-project-dumper --skill project-dumper

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill extracts project knowledge from source code and generates structured Markdown documentation to preserve design intent during knowledge transfer, without copying the source code.

Core Features & Use Cases

  • Generates multi-document outputs: README.md, ARCHITECTURE.md, API.md, DATABASE.md, FLOWS.md with Mermaid diagrams.
  • Supports optional resources (scripts/, references/, assets/) controlled by SKILL.md to tailor the workflow.
  • Includes an offline QR transfer workflow for secure document handoffs.

Quick Start

Execute the /project-dumper command in the current directory to generate the documentation bundle.

Frequently Asked Questions about project-dumper

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

FAQPage Schema
How do I generate architecture and API documentation from source code for knowledge transfer?

You can generate architecture and API documentation by running a command that parses source code and outputs structured Markdown files like README.md, API.md, and ARCHITECTURE.md with Mermaid diagrams for knowledge transfer without sharing the actual code.

What's the best way to document database design and project flows without exposing proprietary code?

The best way to document database design and flows without exposing code is to extract structural knowledge into Markdown files like DATABASE.md and FLOWS.md, using Mermaid diagrams to visually represent the database design and process flows.

Does this code documentation tool work with multi-language codebases like Java, Python, and Go?

Yes, this code documentation tool works with multi-language codebases. It supports Java, JavaScript, Python, and Go, transforming the source code from these languages into structured project documentation.

Can I use Mermaid diagrams to visualize project architecture and API flows in Markdown?

Yes, you can use Mermaid diagrams to visualize project architecture and API flows. The generated Markdown documentation includes Mermaid diagrams directly within files like ARCHITECTURE.md and FLOWS.md to map out the system structure.

How do I securely hand off project documentation to an offline environment?

You can securely hand off project documentation to an offline environment using the optional offline QR transfer workflow, which encodes the generated Markdown documents for secure transfer without requiring network access.

Are there limitations when generating documentation for multi-language codebases?

A limitation is that generation requires deterministic output controlled by SKILL.md, meaning optional resource directories like scripts or assets must be explicitly configured to ensure repeatable handoffs across different multi-language codebases.