codebase-consolidation
Compare original and translation side by side
🇺🇸
Original
English🇨🇳
Translation
ChineseCodebase Consolidation & Analysis
代码库整合与分析
Systematically analyze codebases to identify consolidation opportunities, document architecture, and generate actionable insights.
系统性地分析代码库，识别整合机会、记录架构并生成可执行的洞察。
Quick Reference
快速参考
- Analysis Dimensions - 8 analysis dimensions with detailed criteria
- Consolidation Patterns - Common refactoring patterns with examples
- Report Templates - Output format templates
- 分析维度 - 包含详细标准的8个分析维度
- 整合模式 - 带示例的常见重构模式
- 报告模板 - 输出格式模板
When to Use
适用场景
- Starting on a new codebase - Understand structure quickly
- Planning refactoring - Identify consolidation opportunities
- Code review preparation - Comprehensive analysis before changes
- Documentation needs - Generate architecture docs
- Technical debt assessment - Quantify and prioritize improvements
- Onboarding new developers - Create codebase overview
- Pre-release audits - Quality and security review
Don't use for: Single file analysis, quick bug fixes, simple feature additions
- 接手新代码库时 - 快速理解结构
- 规划重构时 - 识别整合机会
- 代码审查准备阶段 - 变更前的全面分析
- 需要文档时 - 生成架构文档
- 技术债务评估 - 量化并优先处理改进项
- 新开发者入职 - 创建代码库概览
- 发布前审计 - 质量与安全审查
不适用场景：单个文件分析、快速bug修复、简单功能新增
Core Purpose
核心目标
Comprehensive codebase analysis:
- Code Duplication - Find duplicate code for consolidation
- Architectural Analysis - Document system structure and patterns
- Refactoring Opportunities - Identify improvement areas
- Technical Debt Assessment - Quantify and prioritize debt
- Documentation Generation - Create architecture diagrams and docs
- Multi-Perspective Analysis - Review from architect, developer, product views
- Quality Metrics - Complexity, coverage, maintainability
全面的代码库分析：
- 代码重复 - 找出重复代码以便整合
- 架构分析 - 记录系统结构与模式
- 重构机会 - 识别可改进的领域
- 技术债务评估 - 量化并优先处理债务
- 文档生成 - 创建架构图与文档
- 多视角分析 - 从架构师、开发者、产品视角进行审查
- 质量指标 - 复杂度、覆盖率、可维护性
Analysis Dimensions
分析维度
| Dimension | Focus |
|---|---|
| Code Duplication | Find duplicate/similar code blocks |
| Architectural Structure | System architecture and component relationships |
| Code Organization | Module structure and separation of concerns |
| Refactoring Opportunities | Large files, complex functions |
| Technical Debt | TODOs, missing tests, outdated deps |
| Quality Metrics | LOC, complexity, coverage |
| Design Patterns | Patterns and anti-patterns in use |
| Cross-Cutting Concerns | Error handling, logging, security |
See analysis-dimensions.md for detailed criteria.
| 维度 | 重点 |
|---|---|
| 代码重复 | 查找重复/相似代码块 |
| 架构结构 | 系统架构与组件关系 |
| 代码组织 | 模块结构与关注点分离 |
| 重构机会 | 大文件、复杂函数 |
| 技术债务 | TODO注释、缺失测试、过时依赖 |
| 质量指标 | 代码行数（LOC）、复杂度、覆盖率 |
| 设计模式 | 已使用的模式与反模式 |
| 横切关注点 | 错误处理、日志记录、安全性 |
查看**analysis-dimensions.md**获取详细标准。
Analysis Workflow
分析流程
- Discovery - Project structure, file counts, configuration
- Dependency Analysis - cargo tree, outdated, audit
- Duplication Detection - Large files, tech debt markers
- Complexity Analysis - LOC statistics, long functions
- Architecture Mapping - Components, dependencies, data flow
- Quality Assessment - Coverage, linting, formatting
- Documentation Review - Doc generation, API documentation
- Synthesis - Comprehensive report with recommendations
- 发现阶段 - 项目结构、文件数量、配置信息
- 依赖分析 - cargo tree、过时依赖、审计
- 重复代码检测 - 大文件、技术债务标记
- 复杂度分析 - LOC统计、长函数
- 架构映射 - 组件、依赖、数据流
- 质量评估 - 覆盖率、代码检查、格式化
- 文档审查 - 文档生成、API文档
- 综合汇总 - 包含建议的全面报告
Output Formats
输出格式
- Executive Summary - Health score, key metrics, priorities
- Architecture Documentation - System diagram, patterns, data flows
- Refactoring Roadmap - Phased plan with tasks and estimates
- Technical Debt Report - Quantified debt, payoff strategy
- Onboarding Document - Developer guide to codebase
See report-templates.md for complete templates.
- 执行摘要 - 健康评分、关键指标、优先级
- 架构文档 - 系统图、模式、数据流
- 重构路线图 - 分阶段计划，包含任务与估算
- 技术债务报告 - 量化的债务、偿还策略
- 入职文档 - 开发者代码库指南
查看**report-templates.md**获取完整模板。
Best Practices
最佳实践
✓ Start with high-level structure, use automated tools, prioritize findings, provide concrete examples with file paths, estimate effort, consider multiple perspectives
✗ Don't analyze without clear goals, only report problems, provide generic advice, ignore context, recommend big rewrites, overwhelm with detail
See consolidation-patterns.md for refactoring patterns and examples.
✓ 从高层结构入手，使用自动化工具，优先处理发现的问题，提供包含文件路径的具体示例，估算工作量，考虑多视角
✗ 不要在没有明确目标的情况下进行分析，不要只报告问题，不要提供通用建议，不要忽略上下文，不要建议大规模重写，不要用过多细节造成信息过载
查看**consolidation-patterns.md**获取重构模式与示例。