skills.rest
gesmith0606
gesmith0606COMMUNITY
Explore all skills by this author →
GitHub

gsd-map-codebase

Analyze repository files and write seven standardized planning documents to .planning/codebase/.

Updated Aug 15, 2025
Search Tags:#onboarding#codebase#mapping#parallel-agents#planning-docs#gsd
One-click install
npx skills add https://github.com/gesmith0606/nfl_data_engineering --skill gsd-map-codebase-gesmith0606
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: gsd-map-codebase
Source: https://github.com/gesmith0606/nfl_data_engineering/tree/main/.claude/skills/gsd-map-codebase
Command: npx skills add https://github.com/gesmith0606/nfl_data_engineering --skill gsd-map-codebase-gesmith0606

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill analyzes an existing repository and produces a standardized, discoverable map of the codebase to speed onboarding, architecture reviews, and refactoring preparation by generating human-readable planning documents.

Core Features & Use Cases

  • Parallel mapping agents: Launches focused agents for tech, architecture, quality, and concerns to explore different areas of the codebase concurrently.
  • Standardized outputs: Writes seven structured documents (STACK.md, INTEGRATIONS.md, ARCHITECTURE.md, STRUCTURE.md, CONVENTIONS.md, TESTING.md, CONCERNS.md) into .planning/codebase/.
  • Verification and commit: Verifies document existence and line counts, commits the codebase map, and surfaces next steps for project planning.
  • Use Case: Run this on a brownfield repository to create a living codebase map for engineering onboarding and to inform a planned refactor.

Quick Start

Run the gsd-map-codebase skill with an optional focus argument such as "api" to generate the .planning/codebase/ documents.

Frequently Asked Questions about gsd-map-codebase

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

FAQPage Schema
How do I map an existing codebase to speed up engineering onboarding?▼

To map an existing codebase for onboarding, analyze repository files and generate standardized planning documents. This produces a structured map of the codebase into .planning/codebase/ to accelerate onboarding and architecture reviews.

What is the best way to document codebase architecture for a brownfield project refactor?▼

Documenting codebase architecture for a brownfield refactor involves writing structured planning documents like ARCHITECTURE.md and STRUCTURE.md. This approach uses parallel agents to explore the codebase and creates a living map for refactoring preparation.

How do I generate structured planning docs for my repository's tech stack and conventions?▼

Generate structured planning docs for your repository by analyzing files and writing standardized outputs such as STACK.md, CONVENTIONS.md, and TESTING.md. These documents are saved into the .planning/codebase/ directory for discoverability.

Can I map only a specific area of a codebase instead of the whole repository?▼

Yes, you can map a specific area of a codebase by passing an optional focus argument, such as "api". This targets the mapping agents to generate planning documents focused on that particular area of the repository.

Does mapping a codebase with parallel agents verify the generated planning documents?▼

Yes, mapping a codebase with parallel agents verifies the generated planning documents by checking their existence and line counts. After verification, it commits the codebase map and surfaces next steps for project planning.

Related Skills

Explore More Software Engineering Skills→
jpoutrinjpoutrin
14

rfc-specification

Generate RFC documents with structured sections and evidence-based analysis.

Community
Basic
apsulliapsulli

GSD Codebase Mapper

Analyzes codebase structure, dependencies, patterns, and technical debt to generate ARCHITECTURE.md and STACK.md.

Community
Intermediate
roycolumbia-coderoycolumbia-code

gsd-map-codebase

Analyze a codebase with parallel agents and generate seven documentation files.

Community
Advanced
brainbrewlabsbrainbrewlabs
7

doc-generation

Generate JSDoc, docstrings, README files, and API references from JavaScript/TypeScript and Python codebases.

Official
Intermediate