菜单
Comprehensive codebase analysis framework covering 14 technical areas including system overview, architecture, modules, integrations, workflows, and deployment patterns. Use when analyzing a codebase structure for documentation or understanding.
用 Codex 或 Claude 帮你安装 复制这段 Prompt，粘贴到 Codex、Claude 或其他助手里，让它检查 Skill 页面并帮你完成安装。
基于 SOC 职业分类
Output templates and response formats for documentation page generation. Defines JSON response structure, metadata schema, and error handling templates. Use when generating documentation pages and returning status.
Quality validation checklist for generated documentation pages. Covers content completeness, evidence backing, markdown syntax, diagram validation, and cross-reference consistency. Use before finalizing any documentation page.
Documentation structure heuristics and sitemap patterns for different codebase types and team sizes. Covers horizontal (concern-based), vertical (domain-based), and hybrid patterns. Use when planning documentation organization.
Evidence-backed documentation patterns with source code citations. Provides guidelines for citing source files, line numbers, and code examples in technical documentation. Use when writing documentation that needs to reference actual code.
ASCII diagram generation skill for creating professional architectural diagrams in text format. Supports C4 models, sequence diagrams, component diagrams, deployment diagrams, data flow diagrams, class diagrams, and integration diagrams for technical documentation.
Output templates and formatting rules for documentation structure files. Defines the four-section format (Proposed Root, Sitemap, Page Plan, Navigation Rules), front matter schema, and confirmation messages. Use when generating documentation structure output.
| name | codebase-analysis-patterns |
| description | Comprehensive codebase analysis framework covering 14 technical areas including system overview, architecture, modules, integrations, workflows, and deployment patterns. Use when analyzing a codebase structure for documentation or understanding. |
| user-invocable | false |
A systematic framework for analyzing codebases across 14 technical areas. This skill provides the analysis structure and signals to look for when examining a repository.
Purpose: Understand the project at a high level.
Signals to extract:
Detection patterns:
# Check for project metadata
package.json, pyproject.toml, Cargo.toml, go.mod, pom.xml
README.md (first paragraph often describes purpose)
Purpose: Identify languages, frameworks, and tools.
Signals to extract:
Detection patterns:
# Language detection
*.ts, *.tsx → TypeScript
*.py → Python
*.go → Go
*.rs → Rust
*.java → Java
# Framework detection
next.config.* → Next.js
angular.json → Angular
settings.py + urls.py → Django
main.py + FastAPI import → FastAPI
Purpose: Identify the structural design.
Signals to extract:
Detection patterns:
# Layered architecture signals
/controllers or /handlers → presentation layer
/services or /usecases → business logic layer
/repositories or /dal → data access layer
# Microservices signals
Multiple Dockerfiles or docker-compose services
/services/* with independent package files
API gateway configuration
Purpose: Understand client-side organization.
Signals to extract:
Detection patterns:
# React patterns
/components, /hooks, /contexts
useState, useEffect, useContext imports
# State management
/store, /redux, /state directories
createStore, configureStore, create (zustand)
Purpose: Understand server-side organization.
Signals to extract:
Detection patterns:
# API route patterns
/routes, /api, /endpoints directories
@app.route, @router.get, @GetMapping decorators
# Module patterns
/modules/*/ → feature-based
/domain/*/ → domain-driven
Purpose: Catalog major components.
Signals to extract:
Output format:
| Module | Type | Path | Dependencies | Interface |
|---|---|---|---|---|
| auth | API | /services/auth | db, redis | POST /login, /register |
| worker | Background | /workers/email | queue, smtp | processEmailQueue() |
Purpose: Identify persistence mechanisms.
Signals to extract:
Detection patterns:
# Database configuration
DATABASE_URL, MONGO_URI environment variables
/migrations, /prisma, /drizzle directories
*.sql files, schema definitions
# Cache patterns
REDIS_URL, redis.createClient()
@Cacheable annotations
Purpose: Map third-party connections.
Signals to extract:
Detection patterns:
# SDK imports
import stripe, from '@stripe/stripe-js'
import twilio, from 'twilio'
# API client patterns
/integrations, /clients, /external directories
fetch('https://api.stripe.com/...')
Purpose: Trace critical user journeys.
Signals to extract:
Detection patterns:
# Workflow indicators
/workflows, /flows, /sagas directories
State machines, step functions
Transaction boundaries
Purpose: Understand infrastructure and deployment.
Signals to extract:
Detection patterns:
# Container configuration
Dockerfile, docker-compose.yml
.dockerignore
# IaC patterns
/terraform, /infrastructure, /infra directories
*.tf, *.yaml (CloudFormation), Pulumi.*
# CI/CD
.github/workflows/, .gitlab-ci.yml, Jenkinsfile
Purpose: Understand quality assurance approach.
Signals to extract:
Detection patterns:
# Test directories
/tests, /__tests__, /spec, /e2e
*.test.ts, *.spec.py, *_test.go
# CI configuration
.github/workflows/*.yml
test, lint, build, deploy stages
Purpose: Identify security mechanisms.
Signals to extract:
Detection patterns:
# Auth patterns
/auth, /security directories
passport, next-auth, @nestjs/passport imports
JWT verification middleware
# Secrets
.env files (check .gitignore)
secrets/, vault configuration
Purpose: Map the repository organization.
Signals to extract:
Output format:
/
├── src/ → Source code
├── tests/ → Test files
├── docs/ → Documentation
├── scripts/ → Build/deploy scripts
├── config/ → Configuration files
└── dist/ → Build output (generated)
Purpose: Capture anything not covered above.
Potential areas:
| Coverage | Score | Action |
|---|---|---|
| 12-14 areas populated | 85-100% | Proceed with documentation |
| 9-11 areas populated | 70-84% | Review gaps, may proceed |
| < 9 areas populated | < 70% | Request additional context |
Version: 1.0 Last Updated: 2026-01-22