skills.rest
suwandre
suwandreCOMMUNITY
Explore all skills by this author →
Website𝕏@jdogelsGitHub

codemap

Map a codebase into seven planning documents in .planning/codebase/.

Updated Apr 28, 2026
Search Tags:#architecture#documentation#onboarding#codebase#mapping#tech-debt
One-click install
npx skills add https://github.com/suwandre/my-codex-config --skill codemap-suwandre
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: codemap
Source: https://github.com/suwandre/my-codex-config/tree/main/skills/codemap
Command: npx skills add https://github.com/suwandre/my-codex-config --skill codemap-suwandre

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Orchestrate parallel codebase analysis to produce 7 structured documents about the codebase in .planning/codebase/. This gives teams a single source of truth for onboarding and planning.

Core Features & Use Cases

  • Produce seven planning documents in .planning/codebase/: STACK.md, INTEGRATIONS.md, ARCHITECTURE.md, STRUCTURE.md, CONVENTIONS.md, TESTING.md, and CONCERNS.md
  • Enable fast onboarding, architecture understanding, and consistent coding standards across projects
  • Support codebase mapping for new features and technical debt assessment

Quick Start

Invoke codemap to analyze the repository and generate the seven planning documents in .planning/codebase/.

Frequently Asked Questions about codemap

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

FAQPage Schema
How do I generate architecture documentation for an existing codebase?▼

To generate architecture documentation for an existing codebase, codemap analyzes your repository and produces seven structured planning documents in .planning/codebase/. These documents include STACK.md, ARCHITECTURE.md, and CONVENTIONS.md to establish a single source of truth.

What is the best way to map codebase structure for onboarding?▼

The best way to map codebase structure for onboarding is to orchestrate parallel codebase analysis that generates structured documentation. This approach produces files like STRUCTURE.md and INTEGRATIONS.md, giving new team members immediate access to architecture understanding and consistent coding standards.

Can I use codebase mapping for technical debt assessment?▼

Yes, you can use codebase mapping for technical debt assessment. The process generates a CONCERNS.md document that highlights existing issues alongside architecture and testing documentation, enabling thorough technical debt evaluation across projects.

Does codemap require any dependencies to document a codebase?▼

No, codemap does not require any dependencies to document a codebase. It operates independently to map your project into seven planning documents using internal agent templates, requiring only an existing codebase to analyze and output to .planning/codebase/.

What structured documents are produced when mapping a codebase?▼

When mapping a codebase, seven structured documents are produced in .planning/codebase/: STACK.md, INTEGRATIONS.md, ARCHITECTURE.md, STRUCTURE.md, CONVENTIONS.md, TESTING.md, and CONCERNS.md. These files collectively support onboarding, architecture understanding, and technical debt assessment.

Related Skills

Explore More Software Engineering Skills→
az9713az9713

dark-code-suite-init

Initialize a project with dark code prevention directories, CLAUDE.md section, and baseline audit.

Community
Intermediate
li3pli3p

debt-scan

Identify and prioritize technical debt in a codebase for remediation planning.

Community
Intermediate
ogprotegeogprotege

repo-doc-auditor

Audit repository documentation against code and recent changes.

Community
Advanced
danbridanbri
1

local-sparql

Deploy local SPARQL endpoints for querying RDF corpora.

Community
Intermediate