项目理解skill-v1

codebase_architecture_analyzer_v1/assets/report.md

@@ -0,0 +1,204 @@
+# {PROJECT_NAME} 架构分析报告
+
+> 生成时间: {TIMESTAMP}
+> 分析工具: Claude Code - Codebase Architecture Analyzer
+
+---
+
+## 一、项目概览
+
+### 1.1 基本信息
+
+- **项目类型**: {PROJECT_TYPE}
+- **主要语言**: {PRIMARY_LANGUAGE} ({PRIMARY_FILE_COUNT} 个文件)
+- **次要语言**: {SECONDARY_LANGUAGE} ({SECONDARY_FILE_COUNT} 个文件)
+- **代码规模**: 约 {TOTAL_LINES} 行代码
+
+### 1.2 技术栈
+
+**后端**:
+{BACKEND_STACK}
+
+**前端**:
+{FRONTEND_STACK}
+
+**数据库**:
+{DATABASE_STACK}
+
+**基础设施**:
+{INFRASTRUCTURE_STACK}
+
+### 1.3 子系统组成
+
+{SUBSYSTEMS_LIST}
+
+---
+
+## 二、系统架构
+
+### 2.1 架构图
+
+```mermaid
+{SYSTEM_ARCHITECTURE_DIAGRAM}
+```
+
+### 2.2 子系统详情
+
+{SUBSYSTEMS_DETAILS}
+
+### 2.3 通信机制
+
+{COMMUNICATION_MECHANISMS}
+
+---
+
+## 三、核心业务流程
+
+### 3.1 识别的架构模式
+
+**核心模式**: {DETECTED_PATTERN}
+
+{PATTERN_DESCRIPTION}
+
+### 3.2 业务流程图
+
+```mermaid
+{WORKFLOW_DIAGRAM}
+```
+
+### 3.3 执行单元清单
+
+{EXECUTION_UNITS_LIST}
+
+### 3.4 关键决策点
+
+{DECISION_POINTS}
+
+---
+
+## 四、数据流分析
+
+### 4.1 数据流序列图
+
+```mermaid
+{SEQUENCE_DIAGRAM}
+```
+
+### 4.2 核心数据模型
+
+{DATA_MODELS_LIST}
+
+### 4.3 数据转换链路
+
+{DATA_TRANSFORMATION_CHAIN}
+
+---
+
+## 五、快速上手指南
+
+### 5.1 环境要求
+
+{ENVIRONMENT_REQUIREMENTS}
+
+### 5.2 安装步骤
+
+```bash
+{INSTALLATION_STEPS}
+```
+
+### 5.3 启动命令
+
+```bash
+{STARTUP_COMMANDS}
+```
+
+### 5.4 核心入口文件
+
+{ENTRY_POINTS_LIST}
+
+---
+
+## 六、代码位置索引
+
+### 6.1 核心业务逻辑
+
+{CORE_LOGIC_INDEX}
+
+### 6.2 API 端点
+
+{API_ENDPOINTS_INDEX}
+
+### 6.3 数据模型定义
+
+{DATA_MODELS_INDEX}
+
+### 6.4 配置文件
+
+{CONFIG_FILES_INDEX}
+
+---
+
+## 七、代码质量概览
+
+### 7.1 统计指标
+
+- 总文件数: {TOTAL_FILES}
+- 代码行数: {CODE_LINES}
+- 注释行数: {COMMENT_LINES}
+- 空行数: {BLANK_LINES}
+
+### 7.2 目录结构树
+
+```
+{DIRECTORY_TREE}
+```
+
+---
+
+## 八、外部资源
+
+### 8.1 文档链接
+
+{DOCUMENTATION_LINKS}
+
+### 8.2 学术论文
+
+{PAPERS_LIST}
+
+### 8.3 参考资料
+
+{REFERENCES_LIST}
+
+---
+
+## 九、注意事项
+
+### 9.1 已知限制
+
+{KNOWN_LIMITATIONS}
+
+### 9.2 待验证事项
+
+{TODO_VERIFY}
+
+---
+
+## 附录
+
+### A. 依赖清单
+
+{DEPENDENCIES_LIST}
+
+### B. 环境变量
+
+{ENVIRONMENT_VARIABLES}
+
+### C. 分析方法
+
+本报告基于以下方法生成：
+- 静态代码分析（AST 解析）
+- 配置文件解析
+- 目录结构分析
+- 模式匹配识别
+
+所有结论均基于代码事实，标注了具体的文件位置以供验证。