Research Kit

Research Kit 是一套服务于科研的工具套件，基于 TSMER 框架（Target、Strategy/Plan、Method、Experiment、Result），帮助研究人员系统化、规范化地完成研究任务。

核心特性

• 结构化研究流程：提供五个明确的研究阶段，确保研究过程的系统性和完整性
• AI 助手集成：支持通过 GitHub Copilot 等 AI 助手进行调用
• 标准化交付物：为每个研究阶段提供详细的交付物模板
• 可验证的验收标准：确保研究目标的可衡量性和可达成性
• 全流程支持：从目标界定到结果分析的完整研究生命周期支持

研究阶段

Research Kit 包含以下五个研究阶段：

1. Target（目标界定阶段）

• 系统性文献调研
• 问题提炼与筛选
• 研究对象界定
• 量化研究目标设定
• 可验证验收标准制定
• 理论基础梳理

2. Strategy/Plan（策略规划阶段）

• 研究范式确定
• 方法论选定
• 研究架构设计
• 分阶段任务拆解
• 规划方案验收标准制定

3. Method（方法设计与任务细化阶段）

• 研究方法科学验证
• 任务精细化拆解
• 执行规范与评判标准制定
• 任务衔接节点明确
• 方法设计验收标准制定

4. Experiment（研究实操与实施阶段）

• 研究任务执行
• 标准化环境搭建
• 研究过程管理与记录
• 执行偏差调整
• 阶段性成果评估

5. Result（结果分析与总结阶段）

• 研究成果整理与分析
• 目标达成度评估
• 结果根因分析
• 经验规律提炼
• 研究报告生成

安装

1. 安装 Research CLI

# 从源码安装
cd /home/maxine/ai/research-kit
pip install -e .

# 验证安装
research --help

2. 安装到 GitHub Copilot

# 安装到 GitHub Copilot
research install github-copilot

使用方法

通过 CLI 初始化研究阶段

# 初始化 Target 阶段
research init target

# 初始化 Strategy 阶段
research init strategy

# 初始化 Method 阶段
research init method

# 初始化 Experiment 阶段
research init experiment

# 初始化 Result 阶段
research init result

通过 GitHub Copilot 调用

在 GitHub Copilot Chat 中使用以下格式调用：

@researchkit.target
研究领域：[你的研究领域]
现有背景：[你的研究背景]

@researchkit.strategy
Target 阶段成果：
- 研究对象：[研究对象]
- 研究目标：[研究目标]
- 验收标准：[验收标准]

@researchkit.method
Strategy 阶段成果：
- 研究范式：[研究范式]
- 方法论：[方法论]
- 架构设计：[架构设计]

@researchkit.experiment
Method 阶段成果：
- 精细化任务流程：[任务流程]
- 执行规范：[执行规范]

@researchkit.result
Experiment 阶段成果：
- 原始成果：[原始成果]
- 过程记录：[过程记录]

Target 阶段验收标准：
- [验收标准 1]
- [验收标准 2]

项目结构

research-kit/
├── src/
│   └── research_cli/      # CLI 核心实现
├── templates/              # 命令模板和交付物模板
│   ├── deliverables/       # 各阶段交付物模板
│   ├── target.md           # Target 阶段命令模板
│   ├── strategy.md         # Strategy 阶段命令模板
│   ├── method.md           # Method 阶段命令模板
│   ├── experiment.md       # Experiment 阶段命令模板
│   └── result.md           # Result 阶段命令模板
├── scripts/                # 辅助脚本
│   ├── bash/               # Bash 脚本
│   └── powershell/         # PowerShell 脚本
├── .github/
│   ├── agents/             # GitHub Copilot 代理配置
│   └── prompts/            # 提示模板
├── docs/                   # 文档
├── pyproject.toml          # 项目配置
└── README.md               # 项目说明

技术栈

• Python 3.11+
• Typer (CLI 框架)
• Rich (终端美化)
• httpx (HTTP 客户端)
• PyYAML (配置管理)

适用场景

Research Kit 适用于以下场景：

• 学术研究项目
• 企业研发项目
• 技术探索与创新
• 跨学科研究合作
• 学生科研训练

贡献

欢迎通过以下方式贡献 Research Kit：

• 提交 Issue 报告问题或提出新功能建议
• 提交 Pull Request 改进代码或文档
• 分享使用案例和最佳实践

许可证

MIT License