yezhwi/framework-distillation

# framework-distillation [English](./README.md) | [简体中文](./README.zh-CN.md)    **提取架构，而非代码。** 本项目旨在帮助其他 AI 或团队在不复制具体实现的前提下，重现类似的架构。 ## 为什么使用它 当你希望实现以下目标时，请使用 `framework-distillation`： - 深入理解框架超越 README 和公开 API 之外的真实结构 - 逆向工程其 runtime 模型、生命周期、状态机和扩展点 - 在另一种语言或领域中重现类似的架构 - 通过架构和 tradeoffs 来比较框架，而不是仅仅依赖功能清单 - 为未来的实现工作创建 AI 可读的知识包 核心优势： - **架构优先** — 专注于系统形态、模块边界、runtime 和 tradeoffs - **感知证据** — 明确区分观察到的事实与推论，并妥善处理弱证据 - **面向重现** — 产出的结果旨在帮助其他 AI 或团队构建类似的系统 ## 适用人群 - 使用 AgentSkills 风格技能系统的 AI 编程 agent 用户 - 设计内部 runtime 或编排系统的平台工程师 - 研究成熟开源框架的架构师 - 构建 agent runtime、工作流引擎、插件系统或类似基础设施的团队 ## 快速示例 示例 prompt： ``` Analyze LangGraph using framework-distillation. Goal: extract architecture knowledge for building an enterprise agent runtime in Java. Depth: deep. Focus: runtime, graph execution, checkpoint, state model, extension mechanism, production readiness. ``` 预期结果： - 架构概述 - Runtime 与生命周期模型 - 状态与数据模型分析 - 扩展机制分析 - 设计决策与 tradeoffs - 重现指南 - AI 模拟 prompt ## 安装说明 本仓库遵循 [AgentSkills](https://agentskills.io/home) / `SKILL.md` 格式。 ### Claude Code 将本项目放置在您的 Claude Code 技能目录下，文件夹名为 `framework-distillation`。 ### Codex / 使用 `~/.agents/skills` 的本地 agent ``` mkdir -p ~/.agents/skills cd ~/.agents/skills git clone https://github.com/yezhwi/framework-distillation.git framework-distillation ``` ### 通用的 AgentSkills 兼容设置 任何支持基于 `SKILL.md` 技能的技能运行器都可以将本仓库作为技能目录加载： ``` framework-distillation/ ├── SKILL.md └── references/ ``` 如果您的平台需要不同的安装位置，请将此目录复制到该平台配置的技能路径中。 ## 如何使用 最低限度输入： - 仓库 URL 或本地源代码路径 推荐输入： - 框架名称 - 分析目标 - 目标实现语言或领域 - 深度：`mini`、`standard` 或 `deep` - 重点关注领域，例如 runtime、状态机、插件、存储、调度器或生产就绪情况 ### 输出模式 - **mini** — 快速的初步架构摘要 - **standard** — 适用于大多数研究的完整架构提取 - **deep** — 用于框架重现的详尽逆向工程 有关完整的输出结构，请参阅 [`references/output-modes.md`](./references/output-modes.md)。 ### 如何使用输出结果 生成蒸馏结果后： - 从仓库摘要和架构部分开始，获取供人类阅读的概述 - 将知识包、重现指南和 AI 模拟 prompt 作为 AI 辅助实现的主要输入 - 在重构或比较框架之前，使用设计决策、runtime、状态和扩展相关的章节 有关详细的使用指南，请参阅 [`references/deliverables.md`](./references/deliverables.md)。 ## 示例 请参阅 [`examples/`](./examples/) 中的示例 prompt，了解针对特定框架的切入点。 - [`examples/langgraph.md`](./examples/langgraph.md) — agent runtime、图执行、checkpoint、状态模型 - [`examples/temporal.md`](./examples/temporal.md) — 工作流引擎、持久化执行、恢复、调度 - [`examples/vscode-extensions.md`](./examples/vscode-extensions.md) — 插件系统、扩展生命周期、兼容性 如需快速概述，请从 [`examples/README.md`](./examples/README.md) 开始。 ## 技能覆盖范围 该技能可帮助分析： - 仓库目的和目标用户 - 架构与模块边界 - Runtime 与执行流程 - 生命周期与状态机 - 核心数据模型 - 扩展机制 - 工程决策与 tradeoffs - 性能与生产就绪情况 - 可复用的架构原则 - 重现路线图 有关完整的检查清单，请参阅 [`references/analysis-checklist.md`](./references/analysis-checklist.md)。 ## 何时使用 适用场景： - 逆向工程框架架构 - 研究源代码以寻找可复用的架构模式 - 使用另一种语言构建类似的框架 - 架构层面的框架比较 不适用场景： - 仅需 README 摘要 - API 教程或使用指南 - 逐文件的代码走读 - 复制粘贴式的实现指南 ## 仓库结构 ``` framework-distillation/ ├── SKILL.md ├── README.md ├── README.zh-CN.md ├── CONTRIBUTING.md ├── LICENSE ├── social-preview.svg ├── examples/ │ ├── README.md │ ├── README.zh-CN.md │ ├── langgraph.md │ ├── temporal.md │ └── vscode-extensions.md └── references/ ├── analysis-checklist.md ├── deliverables.md ├── output-modes.md ├── self-test.md └── simulated-dialogue-tests.md ``` ### 重要文件 - [`SKILL.md`](./SKILL.md) — 主要技能入口 - [`README.md`](./README.md) — 项目概述、安装说明、示例和品牌文案 - [`CONTRIBUTING.md`](./CONTRIBUTING.md) — 贡献工作流和审查期望 - [`LICENSE`](./LICENSE) — Apache License 2.0 - [`examples/README.md`](./examples/README.md) — 示例 prompt 概述 - [`references/analysis-checklist.md`](./references/analysis-checklist.md) — 详细的分析阶段和质量门禁 - [`references/output-modes.md`](./references/output-modes.md) — mini / standard / deep 输出结构 - [`references/deliverables.md`](./references/deliverables.md) — 交付物布局、使用指南和 AI 模拟 prompt 模板 - [`references/self-test.md`](./references/self-test.md) — 记录的漏洞与修复 - [`references/simulated-dialogue-tests.md`](./references/simulated-dialogue-tests.md) — 可复用的压力测试 prompt - [`social-preview.svg`](./social-preview.svg) — GitHub 社交预览图的源资源文件 ## 项目状态 处于早期的开源包。其结构和指导已足够稳定可供使用，但措辞、示例和平台说明将持续改进。 ## 品牌资产 ### 可用资产 - [`social-preview.svg`](./social-preview.svg) — 默认的 GitHub 社交预览源文件 ### 推荐文案 **宣传语** ``` Turn open-source frameworks into architecture playbooks for humans and AI. ``` **简短描述** ``` An AgentSkills-compatible skill for reverse engineering framework architecture, runtime, extension points, and tradeoffs. ``` **GitHub About 描述** ``` Turn open-source frameworks into architecture playbooks for humans and AI. ``` **社交预览标题** ``` Framework Distillation ``` **社交预览副标题** ``` Reverse-engineer framework architecture, runtime, extension points, and tradeoffs. ``` ### 建议用法 - 在 README 首屏部分和项目摘要中使用宣传语 - 使用 GitHub About 描述作为仓库元数据 - 将 `social-preview.svg` 导出为 PNG 以用作 GitHub 社交预览图 - 在发布文章或文档卡片中复用社交预览的标题和副标题 ### 一致性说明 - 保持信息传达以架构优先，而非功能优先 - 相比于通用的 AI 措辞，更倾向于使用逆向工程、runtime、状态、扩展点和 tradeoffs 等术语 - 在需要简短原则句的地方，复用 `提取架构，而非代码。` - 避免将项目定位为 API 教程或代码复制指南 ## 赞助 如果这个项目对您有帮助，您可以在这里支持它。

## 许可证 基于 [Apache License 2.0](./LICENSE) 授权。

标签：AI知识库, SOC Prime, 代码智能体, 开发工具, 架构分析, 软件架构