What is a codebase blueprint?

A blueprint is a detailed technical document that describes the purpose, architecture, behavior, and key files of a specific system or module within a repository.

Does it update existing documentation?

Yes, the skill includes an audit phase that reads existing blueprints and compares them to the current code to identify needed updates or orphaned documents.

Where are these blueprints stored?

To ensure visibility and consistency, all blueprints are stored in a centralized '/blueprints' directory located at the repository root.

Can it detect dependencies between systems?

Yes, during the discovery phase, the skill analyzes how different parts of the codebase interact to document relationships and data flow between systems.

How is the documentation index managed?

The blueprint index is automatically managed by MCP tools whenever a blueprint is created or updated, ensuring the directory remains organized without manual effort.

System Blueprints Generator

Name: System Blueprints Generator
Author: TheBushidoCollective

byTheBushidoCollective

•

학습 및 문서화

Generates comprehensive, architectural documentation for entire codebases by analyzing project structures and system dependencies.

소개

The Blueprints Generator is a sophisticated documentation skill designed to create a 'living map' of your software architecture. It performs a multi-phase process—discovery, auditing, and generation—to ensure every major system in your repository is accurately documented at the root level. By utilizing specialized MCP tools, it automates the creation of structured blueprints that cover architecture, data flow, and API interfaces, while simultaneously managing a centralized index to prevent documentation rot and duplication.

주요 기능

Comprehensive auditing of existing blueprints against current code implementation
Automatic index management and frontmatter handling via MCP tools
72 GitHub stars
Automated discovery of project structures, modules, and entry points
Standardized markdown templates for consistent system documentation
Repository-wide documentation centralization at the root directory

사용 사례

Onboarding developers to complex repositories with clear architectural maps
Maintaining up-to-date technical documentation during rapid refactoring cycles
Auditing legacy codebases to identify undocumented systems and technical debt

소개

주요 기능

Comprehensive auditing of existing blueprints against current code implementation
Automatic index management and frontmatter handling via MCP tools
72 GitHub stars
Automated discovery of project structures, modules, and entry points
Standardized markdown templates for consistent system documentation
Repository-wide documentation centralization at the root directory

사용 사례

Onboarding developers to complex repositories with clear architectural maps
Maintaining up-to-date technical documentation during rapid refactoring cycles
Auditing legacy codebases to identify undocumented systems and technical debt