Back to Details

github-deep-research

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

GitHub Deep Research Skill

GitHub深度研究Skill

Multi-round research combining GitHub API, web_search, web_fetch to produce comprehensive markdown reports.
结合GitHub API、web_search、web_fetch进行多轮研究，生成全面的Markdown报告。

Research Workflow

研究工作流

  • Round 1: GitHub API
  • Round 2: Discovery
  • Round 3: Deep Investigation
  • Round 4: Deep Dive
  • 第一轮：GitHub API
  • 第二轮：发现阶段
  • 第三轮：深度调查
  • 第四轮：深度钻研

Core Methodology

核心方法论

Query Strategy

查询策略

Broad to Narrow: Start with GitHub API, then general queries, refine based on findings.
Round 1: GitHub API
Round 2: "{topic} overview"
Round 3: "{topic} architecture", "{topic} vs alternatives"
Round 4: "{topic} issues", "{topic} roadmap", "site:github.com {topic}"
Source Prioritization:
  1. Official docs/repos (highest weight)
  2. Technical blogs (Medium, Dev.to)
  3. News articles (verified outlets)
  4. Community discussions (Reddit, HN)
  5. Social media (lowest weight, for sentiment)
从宽到窄：从GitHub API开始，再进行通用查询，根据研究结果逐步细化。
Round 1: GitHub API
Round 2: "{topic} overview"
Round 3: "{topic} architecture", "{topic} vs alternatives"
Round 4: "{topic} issues", "{topic} roadmap", "site:github.com {topic}"
来源优先级:
  1. 官方文档/仓库 (最高权重)
  2. 技术博客 (Medium、Dev.to)
  3. 新闻文章 (权威媒体)
  4. 社区讨论 (Reddit、HN)
  5. 社交媒体 (最低权重，用于舆情分析)

Research Rounds

研究轮次

Round 1 - GitHub API Directly execute 
scripts/github_api.py
without 
read_file()
:
bash
python /path/to/skill/scripts/github_api.py <owner> <repo> summary
python /path/to/skill/scripts/github_api.py <owner> <repo> readme
python /path/to/skill/scripts/github_api.py <owner> <repo> tree
Available commands (the last argument of 
github_api.py
):
  • summary
  • info
  • readme
  • tree
  • languages
  • contributors
  • commits
  • issues
  • prs
  • releases
Round 2 - Discovery (3-5 web_search)
  • Get overview and identify key terms
  • Find official website/repo
  • Identify main players/competitors
Round 3 - Deep Investigation (5-10 web_search + web_fetch)
  • Technical architecture details
  • Timeline of key events
  • Community sentiment
  • Use web_fetch on valuable URLs for full content
Round 4 - Deep Dive
  • Analyze commit history for timeline
  • Review issues/PRs for feature evolution
  • Check contributor activity
Round 1 - GitHub API 直接执行
scripts/github_api.py
，无需调用
read_file()
:
bash
python /path/to/skill/scripts/github_api.py <owner> <repo> summary
python /path/to/skill/scripts/github_api.py <owner> <repo> readme
python /path/to/skill/scripts/github_api.py <owner> <repo> tree
可用命令（
github_api.py
的最后一个参数）:
  • summary
  • info
  • readme
  • tree
  • languages
  • contributors
  • commits
  • issues
  • prs
  • releases
Round 2 - 发现阶段 (3-5次web_search)
  • 获取概览并确定关键术语
  • 查找官方网站/仓库
  • 识别主要参与者/竞品
Round 3 - 深度调查 (5-10次web_search + web_fetch)
  • 技术架构细节
  • 关键事件时间线
  • 社区舆情
  • 对有价值的URL使用web_fetch获取完整内容
Round 4 - 深度钻研
  • 分析提交历史以构建时间线
  • 查看issues/PRs以了解功能演进
  • 检查贡献者活跃度

Report Structure

报告结构

Follow template in 
assets/report_template.md
:
  1. Metadata Block - Date, confidence level, subject
  2. Executive Summary - 2-3 sentence overview with key metrics
  3. Chronological Timeline - Phased breakdown with dates
  4. Key Analysis Sections - Topic-specific deep dives
  5. Metrics & Comparisons - Tables, growth charts
  6. Strengths & Weaknesses - Balanced assessment
  7. Sources - Categorized references
  8. Confidence Assessment - Claims by confidence level
  9. Methodology - Research approach used
遵循
assets/report_template.md
中的模板:
  1. 元数据块 - 日期、置信度、研究主题
  2. 执行摘要 - 2-3句话的概览，包含关键指标
  3. 时间线 - 按阶段划分的时间节点
  4. 核心分析章节 - 针对主题的深度剖析
  5. 指标与对比 - 表格、增长图表
  6. 优势与劣势 - 客观评估
  7. 来源 - 分类整理的参考资料
  8. 置信度评估 - 按置信度划分的研究结论
  9. 方法论 - 所使用的研究方法

Mermaid Diagrams

Mermaid图表

Include diagrams where helpful:
Timeline (Gantt):
mermaid
gantt
    title Project Timeline
    dateFormat YYYY-MM-DD
    section Phase 1
    Development    :2025-01-01, 2025-03-01
    section Phase 2
    Launch         :2025-03-01, 2025-04-01
Architecture (Flowchart):
mermaid
flowchart TD
    A[User] --> B[Coordinator]
    B --> C[Planner]
    C --> D[Research Team]
    D --> E[Reporter]
Comparison (Pie/Bar):
mermaid
pie title Market Share
    "Project A" : 45
    "Project B" : 30
    "Others" : 25
在需要的地方添加图表:
时间线（甘特图）:
mermaid
gantt
    title Project Timeline
    dateFormat YYYY-MM-DD
    section Phase 1
    Development    :2025-01-01, 2025-03-01
    section Phase 2
    Launch         :2025-03-01, 2025-04-01
架构（流程图）:
mermaid
flowchart TD
    A[User] --> B[Coordinator]
    B --> C[Planner]
    C --> D[Research Team]
    D --> E[Reporter]
对比（饼图/柱状图）:
mermaid
pie title Market Share
    "Project A" : 45
    "Project B" : 30
    "Others" : 25

Confidence Scoring

置信度评分

Assign confidence based on source quality:
ConfidenceCriteria
High (90%+)Official docs, GitHub data, multiple corroborating sources
Medium (70-89%)Single reliable source, recent articles
Low (50-69%)Social media, unverified claims, outdated info
根据来源质量分配置信度:
置信度判定标准
高（90%+）官方文档、GitHub数据、多个独立佐证来源
中（70-89%）单一可靠来源、近期文章
低（50-69%）社交媒体、未经验证的说法、过时信息

Output

输出

Save report as: 
research_{topic}_{YYYYMMDD}.md
报告保存为: 
research_{topic}_{YYYYMMDD}.md

Formatting Rules

格式规则

  • Chinese content: Use full-width punctuation（，。：；！？）
  • Technical terms: Provide Wiki/doc URL on first mention
  • Tables: Use for metrics, comparisons
  • Code blocks: For technical examples
  • Mermaid: For architecture, timelines, flows
  • 中文内容: 使用全角标点（，。：；！？）
  • 技术术语: 首次提及需提供Wiki/文档链接
  • 表格: 用于展示指标、对比数据
  • 代码块: 用于技术示例
  • Mermaid: 用于架构图、时间线、流程图

Best Practices

最佳实践

  1. Start with official sources - Repo, docs, company blog
  2. Verify dates from commits/PRs - More reliable than articles
  3. Triangulate claims - 2+ independent sources
  4. Note conflicting info - Don't hide contradictions
  5. Distinguish fact vs opinion - Label speculation clearly
  6. Reference sources - Add source references near claims where applicable
  7. Update as you go - Don't wait until end to synthesize
  1. 从官方来源入手 - 仓库、文档、公司博客
  2. 通过提交记录/PR验证日期 - 比文章更可靠
  3. 多方验证结论 - 至少2个独立来源
  4. 标注矛盾信息 - 不要隐藏冲突点
  5. 区分事实与观点 - 明确标注推测内容
  6. 引用来源 - 在结论附近添加来源参考（如有）
  7. 边研究边更新 - 不要等到最后再整合内容