返回顶部
c

code-research-crafter代码研究工坊

A complete 6-phase workflow for researching codebases, designing enhancement proposals, and publishing RFCs to GitHub. Covers code analysis, academic research, solution design, documentation generation, and RFC publication.

作者: admin | 来源: ClawHub
源自
ClawHub
版本
V 1.0.0
安全检测
已通过
269
下载量
免费
免费
0
收藏
概述
安装方式
版本历史

code-research-crafter

代码研究工匠

从代码分析到GitHub RFC发布,打造全面的研究提案。

概述

本技能提供了一套完整的六阶段工作流,用于深度代码库研究和专业提案撰写:

  1. 1. 代码分析 — 通过系统性探索理解现有实现
  2. 学术研究 — 查找相关论文、算法和现有技术
  3. 社区分析 — 审查GitHub议题、讨论和维护者反馈
  4. 方案设计 — 包含数据模型和分阶段实施计划的架构设计
  5. 文档编写 — 生成结构化的技术文档(中/英文)
  6. RFC发布 — 编写并向GitHub提交专业的RFC

使用场景

当您需要以下内容时,请使用此技能:

  • - 分析开源代码库并提出改进建议
  • 以学术严谨性研究技术问题
  • 基于证据设计系统架构
  • 为开源社区创建专业的RFC
  • 编写带有适当引用的复杂技术提案文档

工作流

第一阶段:问题发现与代码分析

步骤1:确定目标领域

  • - 使用glob模式在代码库中搜索相关文件
  • 查找与该主题相关的GitHub议题
  • 检查现有文档(docs/、README等)

步骤2:深度代码分析
bash

查找相关源文件


glob /[模块]//.ts
glob /[组件]*.ts

读取关键实现文件

read src/[模块]/[关键文件].ts

搜索特定模式

grep [模式] src//*.ts

步骤3:记录发现

  • - 记录当前架构的局限性
  • 确定特定代码位置及其作用
  • 量化问题(例如:50%的文件缺少文档)

第二阶段:学术与社区研究

步骤1:搜索学术论文

  • - 使用WebSearch查找相关研究论文
  • 重点关注2024-2025年的论文
  • 查找算法、数据结构和方法

步骤2:分析GitHub社区

  • - 搜索相关议题和讨论
  • 检查维护者的回复和反馈
  • 从用户评论中识别痛点

步骤3:提取关键见解

  • - 记录相关算法和方法
  • 注意社区情绪和功能请求
  • 识别当前实现与最佳实践之间的差距

第三阶段:方案设计

步骤1:定义设计原则

  • - 基于证据:引用特定代码位置
  • 学术严谨:引用近期论文
  • 以人为本:使用组织类比
  • 成本意识:跟踪Token/性能影响

步骤2:架构方案

  • - 设计分层架构(基础层 → 增强层 → 智能层 → 治理层)
  • 定义数据模型(双轨制:用户定义 + 系统学习)
  • 规划可见性层级(私有/团队/全局)

步骤3:规划实施阶段

  • - 第一阶段:基础(数据收集)
  • 第二阶段:增强(基于第一阶段构建)
  • 第三阶段:智能(基于数据的AI/ML)
  • 第四阶段:治理(控制/监控)

第四阶段:文档生成

步骤1:创建结构化文档

  • - 使用python-docx进行专业格式化
  • 包含目录、标题和适当结构
  • 添加引用和参考文献

步骤2:生成双语版本

  • - 为国际社区创建英文版本
  • 为本地利益相关者创建中文版本
  • 确保术语一致性

第五阶段:英文RFC编写

步骤1:构建RFC结构
markdown

RFC:[标题]

问题陈述

[带有代码证据的量化问题]

现有技术

[学术研究和现有解决方案]

建议方案

[架构、数据模型、实施阶段]

权衡分析

[成本分析、迁移路径、风险]

协作邀请

[如何参与]

步骤2:遵循社区惯例

  • - 使用现有RFC作为模板
  • 引用GitHub议题和讨论
  • 包含代码示例和图表

第六阶段:GitHub发布

步骤1:准备RFC

  • - 在适当位置创建markdown文件
  • 确保格式正确并包含链接
  • 添加相关标签

步骤2:提交到GitHub

  • - 创建包含RFC内容的议题或讨论
  • 引用相关议题
  • 标记相关维护者

步骤3:与社区互动

  • - 回复评论和问题
  • 根据反馈更新RFC
  • 跟踪实施进度

输出示例

记忆整合RFC

结合卡片盒笔记法 + PPR + 睡眠巩固方法进行知识管理。

多智能体协作RFC

采用能力画像和共享黑板架构实现智能体协调。

时间衰减错误修复

扩展配置界面中的日期模式识别。

最佳实践

  1. 1. 引用具体代码位置 — 始终引用文件路径和行号
  2. 量化问题 — 使用50%的文件或3倍性能提升等指标
  3. 引用近期研究 — 优先选择2024-2025年的论文
  4. 使用类比 — 通过组织/工作流类比使复杂概念易于理解
  5. 设计便于采纳 — 包含迁移路径和渐进式推广计划
  6. 跟踪成本 — 记录Token使用量、性能影响和资源需求
  7. 尽早参与 — 从一开始就引用现有议题并邀请协作

成功指标

成功的代码研究工匠输出应:

  • - ✅ 获得社区参与(评论、反应)
  • ✅ 用代码证据量化问题
  • ✅ 引用学术研究
  • ✅ 提供分阶段、可操作的实施计划
  • ✅ 对所有受众(技术人员和非技术人员)清晰易懂

工具与资源

  • - 代码分析:glob、grep、read
  • 学术研究:WebSearch、WebFetch
  • 文档编写:python-docx用于专业文档生成
  • 发布工具:browserusedesktop用于GitHub提交
  • 版本控制:desktopterminalexecute用于Git操作

许可证

MIT许可证 — 详情请参阅LICENSE.txt。

标签

skill ai

通过对话安装

该技能支持在以下平台通过对话安装:

OpenClaw WorkBuddy QClaw Kimi Claude

方式一:安装 SkillHub 和技能

帮我安装 SkillHub 和 code-research-crafter-1776206003 技能

方式二:设置 SkillHub 为优先技能安装源

设置 SkillHub 为我的优先技能安装源,然后帮我安装 code-research-crafter-1776206003 技能

通过命令行安装

skillhub install code-research-crafter-1776206003

下载

⬇ 下载 code-research-crafter v1.0.0(免费)

文件大小: 9.24 KB | 发布时间: 2026-4-15 13:24

v1.0.0 最新 2026-4-15 13:24
Initial release of Code Research Crafter — a 6-phase workflow for codebase analysis, research, proposal design, and RFC publication.

- Guides users from code exploration to structured RFC publication on GitHub.
- Includes academic/community research, architecture/design, and documentation generation (English/Chinese).
- Outlines best practices for evidence-based, collaborative technical proposals.
- Provides tool recommendations and success metrics for effective output.

Archiver·手机版·闲社网·闲社论坛·羊毛社区· 多链控股集团有限公司 · 苏ICP备2025199260号-1

Powered by Discuz! X5.0   © 2024-2025 闲社网·线报更新论坛·羊毛分享社区·http://xianshe.com

p2p_official_large
返回顶部