Code Research Crafter
Craft comprehensive research proposals from code analysis to GitHub RFC publication.
Overview
This skill provides a complete 6-phase workflow for deep codebase research and professional proposal crafting:
- 1. Code Analysis - Understanding existing implementation through systematic exploration
- Academic Research - Finding relevant papers, algorithms, and prior art
- Community Analysis - Reviewing GitHub issues, discussions, and maintainer feedback
- Solution Design - Architecture design with data models and phased implementation plans
- Documentation - Generating structured technical documents (Chinese/English)
- RFC Publication - Writing and submitting professional RFCs to GitHub
When to Use
Use this skill when you need to:
- - Analyze an open-source codebase and propose enhancements
- Research technical problems with academic rigor
- Design system architectures with evidence-based decisions
- Create professional RFCs for open-source communities
- Document complex technical proposals with proper citations
Workflow
Phase 1: Problem Discovery & Code Analysis
Step 1: Identify the target area
- - Search for relevant files in the codebase using glob patterns
- Look for GitHub issues related to the topic
- Check existing documentation (docs/, README, etc.)
Step 2: Deep code analysis
CODEBLOCK0
Step 3: Document findings
- - Note current architecture limitations
- Identify specific code locations and their roles
- Quantify problems (e.g., "50% of files lack documentation")
Phase 2: Academic & Community Research
Step 1: Search for academic papers
- - Use WebSearch to find relevant research papers
- Focus on papers from 2024-2025
- Look for algorithms, data structures, and approaches
Step 2: Analyze GitHub community
- - Search for related issues and discussions
- Check maintainer responses and feedback
- Identify pain points from user comments
Step 3: Extract key insights
- - Document relevant algorithms and approaches
- Note community sentiment and feature requests
- Identify gaps between current implementation and best practices
Phase 3: Solution Design
Step 1: Define design principles
- - Evidence-based: Reference specific code locations
- Academic rigor: Cite recent papers
- Human-centered: Use organization analogies
- Cost-aware: Track token/performance implications
Step 2: Architect the solution
- - Design layered architecture (Foundation → Enhancement → Intelligence → Governance)
- Define data models (dual-track: user-defined + system-learned)
- Plan visibility tiers (private/team/global)
Step 3: Plan implementation phases
- - Phase 1: Foundation (data collection)
- Phase 2: Enhancement (builds on Phase 1)
- Phase 3: Intelligence (AI/ML on data)
- Phase 4: Governance (control/monitoring)
Phase 4: Documentation Generation
Step 1: Create structured documents
- - Use python-docx for professional formatting
- Include table of contents, headers, and proper structure
- Add citations and references
Step 2: Generate bilingual versions
- - Create English version for international communities
- Create Chinese version for local stakeholders
- Ensure consistent terminology
Phase 5: English RFC Writing
Step 1: Structure the RFC
CODEBLOCK1
Step 2: Follow community conventions
- - Use existing RFCs as templates
- Reference GitHub issues and discussions
- Include code examples and diagrams
Phase 6: GitHub Publication
Step 1: Prepare the RFC
- - Create markdown file in appropriate location
- Ensure proper formatting and links
- Add relevant labels
Step 2: Submit to GitHub
- - Create issue or discussion with RFC content
- Reference related issues
- Tag relevant maintainers
Step 3: Engage the community
- - Respond to comments and questions
- Update RFC based on feedback
- Track implementation progress
Output Examples
Memory Consolidation RFC
Combines Zettelkasten + PPR + Sleep Consolidation approaches for knowledge management.
Multi-Agent Collaboration RFC
Features Capability Profiling and Shared Blackboard architecture for agent coordination.
Temporal Decay Bug Fixes
Expands date pattern recognition in configuration interfaces.
Best Practices
- 1. Quote specific code locations - Always reference file paths and line numbers
- Quantify problems - Use metrics like "50% of files" or "3x performance improvement"
- Cite recent research - Prefer papers from 2024-2025
- Use analogies - Make complex concepts accessible with organization/workflow analogies
- Design for adoption - Include migration paths and gradual rollout plans
- Track costs - Document token usage, performance implications, and resource requirements
- Engage early - Reference existing issues and invite collaboration from the start
Success Metrics
A successful Code Research Crafter output should:
- - ✅ Receive community engagement (comments, reactions)
- ✅ Quantify problems with code evidence
- ✅ Reference academic research
- ✅ Provide phased, actionable implementation plans
- ✅ Be clear for all audiences (technical and non-technical)
Tools & Resources
- - Code Analysis:
glob, grep, INLINECODE2 - Academic Research:
WebSearch, INLINECODE4 - Documentation:
python-docx for professional document generation - Publication:
browser_use_desktop for GitHub submission - Version Control:
desktop_terminal_execute for Git operations
License
MIT License - See LICENSE.txt for details.
代码研究工匠
从代码分析到GitHub RFC发布,打造全面的研究提案。
概述
本技能提供了一套完整的六阶段工作流,用于深度代码库研究和专业提案撰写:
- 1. 代码分析 — 通过系统性探索理解现有实现
- 学术研究 — 查找相关论文、算法和现有技术
- 社区分析 — 审查GitHub议题、讨论和维护者反馈
- 方案设计 — 包含数据模型和分阶段实施计划的架构设计
- 文档编写 — 生成结构化的技术文档(中/英文)
- 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
结合卡片盒笔记法 + PPR + 睡眠巩固方法进行知识管理。
多智能体协作RFC
采用能力画像和共享黑板架构实现智能体协调。
时间衰减错误修复
扩展配置界面中的日期模式识别。
最佳实践
- 1. 引用具体代码位置 — 始终引用文件路径和行号
- 量化问题 — 使用50%的文件或3倍性能提升等指标
- 引用近期研究 — 优先选择2024-2025年的论文
- 使用类比 — 通过组织/工作流类比使复杂概念易于理解
- 设计便于采纳 — 包含迁移路径和渐进式推广计划
- 跟踪成本 — 记录Token使用量、性能影响和资源需求
- 尽早参与 — 从一开始就引用现有议题并邀请协作
成功指标
成功的代码研究工匠输出应:
- - ✅ 获得社区参与(评论、反应)
- ✅ 用代码证据量化问题
- ✅ 引用学术研究
- ✅ 提供分阶段、可操作的实施计划
- ✅ 对所有受众(技术人员和非技术人员)清晰易懂
工具与资源
- - 代码分析:glob、grep、read
- 学术研究:WebSearch、WebFetch
- 文档编写:python-docx用于专业文档生成
- 发布工具:browserusedesktop用于GitHub提交
- 版本控制:desktopterminalexecute用于Git操作
许可证
MIT许可证 — 详情请参阅LICENSE.txt。