skills.rest
korwlik23
korwlik23COMMUNITY
Explore all skills by this author →
WebsiteGitHub

project-sitemap

Generate a structured PROJECT_SITEMAP.md from repository code and configs.

Updated May 6, 2026
Search Tags:#documentation#dependency graph#architecture overview#project mapping#codebase onboarding#route discovery#repo analysis
One-click install
npx skills add https://github.com/korwlik23/skills --skill project-sitemap
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: project-sitemap
Source: https://github.com/korwlik23/skills/tree/main/v1/project-sitemap
Command: npx skills add https://github.com/korwlik23/skills --skill project-sitemap

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill removes the time-consuming guesswork of understanding an unfamiliar repository by producing a clear, structured project map that an AI agent or developer can use immediately.

Core Features & Use Cases

  • Codebase discovery & classification: Scans configs, entry points, directory layout, and identifies major subsystem types like routes, services, data models, and tests.
  • Relationship mapping: Documents key flows such as request→service→data, component hierarchies, auth behavior, state movement, and external integrations.
  • Machine-readable, living output: Generates a root-level PROJECT_SITEMAP.md that can be kept current after refactors and structural changes.

Quick Start

Ask your agent to generate the project sitemap for this repository and save it as PROJECT_SITEMAP.md in the project root.

Frequently Asked Questions about project-sitemap

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

FAQPage Schema
How do I map a codebase for quick onboarding and architecture overview?▼

To map a codebase for onboarding, you need to scan real code and configs to extract routes, models, and dependencies. This generates a structured PROJECT_SITEMAP.md file that provides an instant architectural overview of the repository.

What is the best way to generate a dependency graph for an unfamiliar project structure?▼

A dependency graph for an unfamiliar project structure is generated by scanning directory layouts and source files. It maps relationships like request flows and component hierarchies into a machine-readable markdown file for immediate analysis.

Can I use this to discover routes and endpoints across different directory layouts?▼

Yes, route discovery works across common stacks and directory layouts by scanning actual code sources and configurations. It identifies and documents endpoints while safely skipping generated artifacts to ensure accurate mapping.

How do I document repository analysis without fabricating architectural details?▼

Documenting repository analysis without fabrication requires scanning real code and config sources to extract CI, models, and tests. It outputs a parseable map reflecting the actual codebase without inventing missing details.

Does codebase mapping work on existing projects after major refactors?▼

Codebase mapping works on existing projects after refactors by rescanning the source code and directory structure. It produces an updated living document that refreshes the project structure and relationship mapping.

Related Skills

Explore More Software Engineering Skills→
chdalskichdalski
7

project-init

Scan repositories to generate project-specific CLAUDE.md files for AI agents.

Community
Intermediate
mvillmowmvillmow
18

analyze-code-structure

Map module hierarchies and dependencies across multi-language codebases.

Community
Basic
XCmiaowXCmiaow

graphviz

Generate directed or undirected graph diagrams from DOT definitions.

Community
Basic
AradotsoAradotso
7

iida-mcp-ida-integration

Expose IDA Pro static analysis as MCP tools over HTTP.

Official
Advanced