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.

Use this for GitHub-hosted project research, not for a local checked-out repo where

codebase-deep-research

is the better fit.

通过多轮研究，结合 GitHub API、web_search、web_fetch，生成全面的 Markdown 报告。

适用于研究托管在 GitHub 上的项目，不适用于本地已检出的 repo；对于后者，

codebase-deep-research

更合适。

Research Workflow

研究工作流

Round 1: GitHub API
Round 2: Discovery
Round 3: Deep Investigation
Round 4: Deep Dive

第 1 轮：GitHub API
第 2 轮：探索发现
第 3 轮：深入调查
第 4 轮：深入剖析

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:

Official docs/repos (highest weight)
Technical blogs (Medium, Dev.to)
News articles (verified outlets)
Community discussions (Reddit, HN)
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}"

来源优先级：

官方文档/repo（权重最高）
技术博客（Medium、Dev.to）
新闻文章（已核验的媒体）
社区讨论（Reddit、HN）
社交媒体（权重最低，用于了解情绪倾向）

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

第 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

第 2 轮 - 探索发现（3-5 次 web_search）

获取概览并识别关键术语
查找官方网站/repo
确认主要参与者/竞争者

第 3 轮 - 深入调查（5-10 次 web_search + web_fetch）

技术架构细节
关键事件时间线
社区情绪
对有价值的 URL 使用 web_fetch 获取完整内容

第 4 轮 - 深入剖析

分析 commit 历史，重建时间线
审阅 issues/PRs，分析功能演进
检查贡献者活跃度

Report Structure

报告结构

Follow template in

assets/report_template.md

Metadata Block - Date, confidence level, subject
Executive Summary - 2-3 sentence overview with key metrics
Chronological Timeline - Phased breakdown with dates
Key Analysis Sections - Topic-specific deep dives
Metrics & Comparisons - Tables, growth charts
Strengths & Weaknesses - Balanced assessment
Sources - Categorized references
Confidence Assessment - Claims by confidence level
Methodology - Research approach used

遵循

assets/report_template.md

中的模板：

元数据块 - 日期、置信度等级、研究对象
执行摘要 - 2-3 句概览，包含关键指标
时间线 - 按阶段划分并附日期
关键分析章节 - 针对具体主题的深入分析
指标与对比 - 表格、增长图表
优势与劣势 - 客观全面的评估
来源 - 分类参考文献
置信度评估 - 按置信度等级划分结论
方法论 - 采用的研究方法

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

在有助于表达时加入图示：

时间线（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

架构（Flowchart）：

mermaid

flowchart TD
    A[User] --> B[Coordinator]
    B --> C[Planner]
    C --> D[Research Team]
    D --> E[Reporter]

对比（Pie/Bar）：

mermaid

pie title Market Share
    "Project A" : 45
    "Project B" : 30
    "Others" : 25

Confidence Scoring

置信度评分

Assign confidence based on source quality:

Confidence	Criteria
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/文档 URL
表格：用于指标和对比
代码块：用于技术示例
Mermaid：用于架构、时间线和流程图

Best Practices

最佳实践

Start with official sources - Repo, docs, company blog
Verify dates from commits/PRs - More reliable than articles
Triangulate claims - 2+ independent sources
Note conflicting info - Don't hide contradictions
Distinguish fact vs opinion - Label speculation clearly
Reference sources - Add source references near claims where applicable
Update as you go - Don't wait until end to synthesize

优先使用官方来源 - Repo、文档、公司博客
从 commits/PRs 核验日期 - 比文章更可靠
交叉验证结论 - 2 个及以上独立来源
注明冲突信息 - 不隐瞒矛盾之处
区分事实与观点 - 明确标注推测
引用来源 - 在适用情况下，在相关结论附近添加来源引用
持续更新 - 不要等到最后才进行综合归纳