What kind of systems can I document with this tool?

You can document anything from specific features (like authentication) and directory paths to individual components like MCP servers or internal hook dispatchers.

Where are the blueprints stored?

All blueprints are strictly created at the repository root in the blueprints/ directory to ensure they remain accessible as repository-wide design documents rather than being hidden in subpackages.

Can it update existing documentation?

Yes, the skill is designed to both create new blueprints and update existing ones, ensuring your technical documentation stays in sync with your actual code implementation.

How does the skill research my system?

It uses a multi-step process including glob and grep to find relevant files, reads implementation details to understand data flow, and checks existing documentation and test files to capture expected behavior.

System Blueprint Generator

Name: System Blueprint Generator
Author: TheBushidoCollective

byTheBushidoCollective

•

Learning & Documentation

Researches codebases to automatically generate and update comprehensive technical system blueprints at the repository root.

The System Blueprint Generator empowers developers to maintain accurate, high-quality technical documentation without manual drudgery. By performing deep analysis of implementation files, public APIs, and data flows, this skill creates standardized markdown blueprints that serve as a single source of truth for specific systems within a repository. It ensures consistency by strictly placing documents at the repository root and provides a structured framework covering architecture, dependencies, and behavior, making it indispensable for onboarding, architectural reviews, and long-term project maintenance.

Key Features

01Intelligent duplicate detection to prevent fragmented documentation across packages.

0295 GitHub stars

03Standardized blueprint templates with YAML frontmatter and structured sections.

04Comprehensive mapping of public APIs, internal data flows, and dependencies.

05Automated codebase research using glob and grep for deep system analysis.

06Centralized repository root storage for unified documentation management.

Use Cases

01Updating architectural blueprints after a major refactor or API change.

02Mapping out dependencies and data flows for a newly integrated system component.

03Generating technical documentation for a legacy feature with no existing notes.

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add thebushidocollective/han create-blueprint

For use in Claude.ai and ChatGPT

Download Skill