Release v1.26.0: Add deep-research skill
This commit is contained in:
daymade
@@ -5,8 +5,8 @@
|
||||
"email": "daymadev89@gmail.com"
|
||||
},
|
||||
"metadata": {
|
||||
"description": "Professional Claude Code skills for GitHub operations, document conversion, diagram generation, statusline customization, Teams communication, repomix utilities, skill creation, CLI demo generation, LLM icon access, Cloudflare troubleshooting, UI design system extraction, professional presentation creation, YouTube video downloading, secure repomix packaging, ASR transcription correction, video comparison quality analysis, comprehensive QA testing infrastructure, prompt optimization with EARS methodology, session history recovery, documentation cleanup, PDF generation with Chinese font support, CLAUDE.md progressive disclosure optimization, CCPM skill registry search and management, Promptfoo LLM evaluation framework, iOS app development with XcodeGen and SwiftUI, fact-checking with automated corrections, Twitter/X content fetching, intelligent macOS disk space recovery, skill quality review and improvement, GitHub contribution strategy, complete internationalization/localization setup, and plugin/skill troubleshooting with diagnostic tools",
|
||||
"version": "1.25.0",
|
||||
"description": "Professional Claude Code skills for GitHub operations, document conversion, diagram generation, statusline customization, Teams communication, repomix utilities, skill creation, CLI demo generation, LLM icon access, Cloudflare troubleshooting, UI design system extraction, professional presentation creation, YouTube video downloading, secure repomix packaging, ASR transcription correction, video comparison quality analysis, comprehensive QA testing infrastructure, prompt optimization with EARS methodology, session history recovery, documentation cleanup, format-controlled deep research report generation with evidence tracking, PDF generation with Chinese font support, CLAUDE.md progressive disclosure optimization, CCPM skill registry search and management, Promptfoo LLM evaluation framework, iOS app development with XcodeGen and SwiftUI, fact-checking with automated corrections, Twitter/X content fetching, intelligent macOS disk space recovery, skill quality review and improvement, GitHub contribution strategy, complete internationalization/localization setup, and plugin/skill troubleshooting with diagnostic tools",
|
||||
"version": "1.26.0",
|
||||
"homepage": "https://github.com/daymade/claude-code-skills"
|
||||
},
|
||||
"plugins": [
|
||||
@@ -685,6 +685,27 @@
|
||||
"skills": [
|
||||
"./meeting-minutes-taker"
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "deep-research",
|
||||
"description": "Generate format-controlled research reports with evidence tracking, citations, and iterative review. Use when users request research reports, literature reviews, market or industry analysis, competitive landscapes, policy or technical briefs, or strict report templates and section formatting",
|
||||
"source": "./",
|
||||
"strict": false,
|
||||
"version": "1.0.0",
|
||||
"category": "documentation",
|
||||
"keywords": [
|
||||
"research",
|
||||
"report",
|
||||
"analysis",
|
||||
"literature-review",
|
||||
"market-research",
|
||||
"citations",
|
||||
"evidence",
|
||||
"deepresearch"
|
||||
],
|
||||
"skills": [
|
||||
"./deep-research"
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
|
||||
23
CHANGELOG.md
23
CHANGELOG.md
@@ -10,6 +10,29 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
||||
### Added
|
||||
- None
|
||||
|
||||
## [1.26.0] - 2026-01-25
|
||||
|
||||
### Added
|
||||
- **New Skill**: deep-research - Format-controlled research reports with evidence mapping
|
||||
- Report spec and format contract workflow
|
||||
- Multi-pass parallel drafting with UNION merge
|
||||
- Evidence table with source quality rubric
|
||||
- Citation verification and conflict handling
|
||||
- Bundled references: report template, formatting rules, research plan checklist, source quality rubric, completeness checklist
|
||||
|
||||
### Changed
|
||||
- Updated marketplace skills count from 33 to 34
|
||||
- Updated marketplace version from 1.25.0 to 1.26.0
|
||||
- Updated README.md badges (skills count, version)
|
||||
- Updated README.md to include deep-research in skills listing
|
||||
- Updated README.zh-CN.md badges (skills count, version)
|
||||
- Updated README.zh-CN.md to include deep-research in skills listing
|
||||
- Updated CLAUDE.md skills count from 33 to 34
|
||||
- Added deep-research use case section to README.md
|
||||
- Added deep-research use case section to README.zh-CN.md
|
||||
- Added deep-research documentation quick link to README.md
|
||||
- Added deep-research documentation quick link to README.zh-CN.md
|
||||
|
||||
## [1.25.0] - 2026-01-24
|
||||
|
||||
### Added
|
||||
|
||||
@@ -4,7 +4,7 @@ This file provides guidance to Claude Code (claude.ai/code) when working with co
|
||||
|
||||
## Repository Overview
|
||||
|
||||
This is a Claude Code skills marketplace containing 33 production-ready skills organized in a plugin marketplace structure. Each skill is a self-contained package that extends Claude's capabilities with specialized knowledge, workflows, and bundled resources.
|
||||
This is a Claude Code skills marketplace containing 34 production-ready skills organized in a plugin marketplace structure. Each skill is a self-contained package that extends Claude's capabilities with specialized knowledge, workflows, and bundled resources.
|
||||
|
||||
**Essential Skill**: `skill-creator` is the most important skill in this marketplace - it's a meta-skill that enables users to create their own skills. Always recommend it first for users interested in extending Claude Code.
|
||||
|
||||
@@ -134,7 +134,7 @@ Skills for public distribution must NOT contain:
|
||||
## Marketplace Configuration
|
||||
|
||||
The marketplace is configured in `.claude-plugin/marketplace.json`:
|
||||
- Contains 33 plugins, each mapping to one skill
|
||||
- Contains 34 plugins, each mapping to one skill
|
||||
- Each plugin has: name, description, version, category, keywords, skills array
|
||||
- Marketplace metadata: name, owner, version, homepage
|
||||
|
||||
@@ -144,7 +144,7 @@ The marketplace is configured in `.claude-plugin/marketplace.json`:
|
||||
|
||||
1. **Marketplace Version** (`.claude-plugin/marketplace.json` → `metadata.version`)
|
||||
- Tracks the marketplace catalog as a whole
|
||||
- Current: v1.25.0
|
||||
- Current: v1.26.0
|
||||
- Bump when: Adding/removing skills, major marketplace restructuring
|
||||
- Semantic versioning: MAJOR.MINOR.PATCH
|
||||
|
||||
@@ -193,6 +193,7 @@ The marketplace is configured in `.claude-plugin/marketplace.json`:
|
||||
31. **i18n-expert** - Complete internationalization/localization setup and auditing for UI codebases with framework support, key architecture, and parity validation
|
||||
32. **claude-skills-troubleshooting** - Diagnose and resolve Claude Code plugin and skill configuration issues with diagnostic scripts and architecture documentation
|
||||
33. **meeting-minutes-taker** - Transform meeting transcripts into structured minutes with multi-pass generation, speaker quotes, and iterative human review
|
||||
34. **deep-research** - Generate format-controlled research reports with evidence mapping, citations, and multi-pass synthesis
|
||||
|
||||
**Recommendation**: Always suggest `skill-creator` first for users interested in creating skills or extending Claude Code.
|
||||
|
||||
|
||||
45
README.md
45
README.md
@@ -6,15 +6,15 @@
|
||||
[](./README.zh-CN.md)
|
||||
|
||||
[](https://opensource.org/licenses/MIT)
|
||||
[](https://github.com/daymade/claude-code-skills)
|
||||
[](https://github.com/daymade/claude-code-skills)
|
||||
[](https://github.com/daymade/claude-code-skills)
|
||||
[](https://github.com/daymade/claude-code-skills)
|
||||
[](https://claude.com/code)
|
||||
[](./CONTRIBUTING.md)
|
||||
[](https://github.com/daymade/claude-code-skills/graphs/commit-activity)
|
||||
|
||||
</div>
|
||||
|
||||
Professional Claude Code skills marketplace featuring 33 production-ready skills for enhanced development workflows.
|
||||
Professional Claude Code skills marketplace featuring 34 production-ready skills for enhanced development workflows.
|
||||
|
||||
## 📑 Table of Contents
|
||||
|
||||
@@ -1428,6 +1428,41 @@ claude plugin install meeting-minutes-taker@daymade-skills
|
||||
|
||||
---
|
||||
|
||||
### 34. **deep-research** - Research Report Generator
|
||||
|
||||
Generate format-controlled research reports with evidence tracking and citations.
|
||||
|
||||
**When to use:**
|
||||
- Need a structured research report, literature review, or market/industry analysis
|
||||
- Require strict section formatting or a template to be enforced
|
||||
- Need evidence mapping, citations, and source quality review
|
||||
- Want multi-pass synthesis to avoid missing key findings
|
||||
|
||||
**Key features:**
|
||||
- Report spec and format contract workflow
|
||||
- Evidence table with source quality rubric
|
||||
- Multi-pass complete drafting with UNION merge
|
||||
- Citation verification and conflict handling
|
||||
- Ready-to-use report template and formatting rules
|
||||
|
||||
**Example usage:**
|
||||
```bash
|
||||
# Install the skill
|
||||
claude plugin install deep-research@daymade-skills
|
||||
|
||||
# Then provide a report spec or template and request a deep research report
|
||||
```
|
||||
|
||||
**🎬 Live Demo**
|
||||
|
||||
*Coming soon*
|
||||
|
||||
📚 **Documentation**: See [deep-research/SKILL.md](./deep-research/SKILL.md) and [deep-research/references/research_report_template.md](./deep-research/references/research_report_template.md) for workflow and structure.
|
||||
|
||||
**Requirements**: None
|
||||
|
||||
---
|
||||
|
||||
## 🎬 Interactive Demo Gallery
|
||||
|
||||
Want to see all demos in one place with click-to-enlarge functionality? Check out our [interactive demo gallery](./demos/index.html) or browse the [demos directory](./demos/).
|
||||
@@ -1440,6 +1475,9 @@ Use **github-ops** to streamline PR creation, issue management, and API operatio
|
||||
### For Documentation
|
||||
Combine **markdown-tools** for document conversion and **mermaid-tools** for diagram generation to create comprehensive documentation. Use **llm-icon-finder** to add brand icons.
|
||||
|
||||
### For Research & Analysis
|
||||
Use **deep-research** to produce format-controlled research reports with evidence tables and citations. Combine with **fact-checker** to validate claims or with **twitter-reader** for social-source collection.
|
||||
|
||||
### For PDF & Printable Documents
|
||||
Use **pdf-creator** to convert markdown to print-ready PDFs with proper Chinese font support for formal documents and reports.
|
||||
|
||||
@@ -1536,6 +1574,7 @@ Each skill includes:
|
||||
- **prompt-optimizer**: See `prompt-optimizer/references/ears_syntax.md` for EARS transformation patterns, `prompt-optimizer/references/domain_theories.md` for theory catalog, and `prompt-optimizer/references/examples.md` for complete transformations
|
||||
- **claude-code-history-files-finder**: See `claude-code-history-files-finder/references/session_file_format.md` for JSONL structure and `claude-code-history-files-finder/references/workflow_examples.md` for recovery workflows
|
||||
- **docs-cleaner**: See `docs-cleaner/SKILL.md` for consolidation workflows
|
||||
- **deep-research**: See `deep-research/references/research_report_template.md` for report structure and `deep-research/references/source_quality_rubric.md` for source triage
|
||||
- **pdf-creator**: See `pdf-creator/SKILL.md` for PDF conversion and font setup
|
||||
- **claude-md-progressive-disclosurer**: See `claude-md-progressive-disclosurer/SKILL.md` for CLAUDE.md optimization workflow
|
||||
- **skills-search**: See `skills-search/SKILL.md` for CCPM CLI commands and registry operations
|
||||
|
||||
@@ -6,15 +6,15 @@
|
||||
[](./README.zh-CN.md)
|
||||
|
||||
[](https://opensource.org/licenses/MIT)
|
||||
[](https://github.com/daymade/claude-code-skills)
|
||||
[](https://github.com/daymade/claude-code-skills)
|
||||
[](https://github.com/daymade/claude-code-skills)
|
||||
[](https://github.com/daymade/claude-code-skills)
|
||||
[](https://claude.com/code)
|
||||
[](./CONTRIBUTING.md)
|
||||
[](https://github.com/daymade/claude-code-skills/graphs/commit-activity)
|
||||
|
||||
</div>
|
||||
|
||||
专业的 Claude Code 技能市场，提供 33 个生产就绪的技能，用于增强开发工作流。
|
||||
专业的 Claude Code 技能市场，提供 34 个生产就绪的技能，用于增强开发工作流。
|
||||
|
||||
## 📑 目录
|
||||
|
||||
@@ -1470,6 +1470,41 @@ claude plugin install meeting-minutes-taker@daymade-skills
|
||||
|
||||
---
|
||||
|
||||
### 34. **deep-research** - 深度调研报告生成器
|
||||
|
||||
生成格式可控的调研报告，支持证据追踪与引用。
|
||||
|
||||
**使用场景：**
|
||||
- 需要结构化调研报告、文献综述或行业/市场分析
|
||||
- 需要严格的章节格式或模板约束
|
||||
- 需要证据映射、引用与来源质量审查
|
||||
- 需要多轮综合以避免遗漏关键发现
|
||||
|
||||
**主要功能：**
|
||||
- 报告规格与格式合约工作流
|
||||
- 证据表与来源质量评级
|
||||
- 多轮完整草稿与 UNION 合并
|
||||
- 引用校验与冲突处理
|
||||
- 即用型报告模板与格式规则
|
||||
|
||||
**示例用法：**
|
||||
```bash
|
||||
# 安装技能
|
||||
claude plugin install deep-research@daymade-skills
|
||||
|
||||
# 然后提供报告规格或模板并请求生成调研报告
|
||||
```
|
||||
|
||||
**🎬 实时演示**
|
||||
|
||||
*即将推出*
|
||||
|
||||
📚 **文档**：参见 [deep-research/SKILL.md](./deep-research/SKILL.md) 与 [deep-research/references/research_report_template.md](./deep-research/references/research_report_template.md) 了解工作流程与结构。
|
||||
|
||||
**要求**：无
|
||||
|
||||
---
|
||||
|
||||
## 🎬 交互式演示画廊
|
||||
|
||||
想要在一个地方查看所有演示并具有点击放大功能？访问我们的[交互式演示画廊](./demos/index.html)或浏览[演示目录](./demos/)。
|
||||
@@ -1482,6 +1517,9 @@ claude plugin install meeting-minutes-taker@daymade-skills
|
||||
### 文档处理
|
||||
结合 **markdown-tools** 进行文档转换和 **mermaid-tools** 进行图表生成，创建全面的文档。使用 **llm-icon-finder** 添加品牌图标。
|
||||
|
||||
### 调研与分析
|
||||
使用 **deep-research** 生成格式可控的调研报告，包含证据表与引用。与 **fact-checker** 结合用于验证关键结论，或与 **twitter-reader** 结合收集社媒资料。
|
||||
|
||||
### PDF 与可打印文档
|
||||
使用 **pdf-creator** 将 markdown 转换为适合打印的 PDF，并提供中文字体支持，适用于正式报告和归档材料。
|
||||
|
||||
@@ -1578,6 +1616,7 @@ claude plugin install meeting-minutes-taker@daymade-skills
|
||||
- **prompt-optimizer**：参见 `prompt-optimizer/references/ears_syntax.md` 了解 EARS 转换模式、`prompt-optimizer/references/domain_theories.md` 了解理论目录和 `prompt-optimizer/references/examples.md` 了解完整转换示例
|
||||
- **claude-code-history-files-finder**：参见 `claude-code-history-files-finder/references/session_file_format.md` 了解 JSONL 结构和 `claude-code-history-files-finder/references/workflow_examples.md` 了解恢复工作流
|
||||
- **docs-cleaner**：参见 `docs-cleaner/SKILL.md` 了解整合工作流
|
||||
- **deep-research**：参见 `deep-research/references/research_report_template.md` 了解报告结构，并参见 `deep-research/references/source_quality_rubric.md` 了解来源分级标准
|
||||
- **pdf-creator**：参见 `pdf-creator/SKILL.md` 了解 PDF 转换与字体设置
|
||||
- **claude-md-progressive-disclosurer**：参见 `claude-md-progressive-disclosurer/SKILL.md` 了解 CLAUDE.md 优化工作流
|
||||
- **skills-search**：参见 `skills-search/SKILL.md` 了解 CCPM CLI 命令和注册表操作
|
||||
|
||||
4
deep-research/.security-scan-passed
Normal file
4
deep-research/.security-scan-passed
Normal file
@@ -0,0 +1,4 @@
|
||||
Security scan passed
|
||||
Scanned at: 2026-01-25T15:33:59.582023
|
||||
Tool: gitleaks + pattern-based validation
|
||||
Content hash: 36de97399b27f8a70dc16d74d4abf39d62918f50c6a8f67385463f9b95cc4839
|
||||
207
deep-research/SKILL.md
Normal file
207
deep-research/SKILL.md
Normal file
@@ -0,0 +1,207 @@
|
||||
---
|
||||
name: deep-research
|
||||
description: |
|
||||
Generate format-controlled research reports with evidence tracking, citations, and iterative review. This skill should be used when users request a research report, literature review, market or industry analysis, competitive landscape, policy or technical brief, or require a strict report template and section formatting that a single deepresearch pass cannot reliably enforce.
|
||||
---
|
||||
|
||||
# Deep Research
|
||||
|
||||
Create high-fidelity research reports with strict format control, evidence mapping, and multi-pass synthesis.
|
||||
|
||||
## Quick Start
|
||||
|
||||
1. Clarify the report spec and format contract
|
||||
2. Build a research plan and query set
|
||||
3. Collect evidence with the deepresearch tool (multi-pass if needed)
|
||||
4. Triage sources and build an evidence table
|
||||
5. Draft the full report in multiple complete passes (parallel subagents)
|
||||
6. UNION merge, enforce format compliance, verify citations
|
||||
7. Present draft for human review and iterate
|
||||
|
||||
## Core Workflow
|
||||
|
||||
Copy this checklist and track progress:
|
||||
|
||||
```
|
||||
Deep Research Progress:
|
||||
- [ ] Step 1: Intake and format contract
|
||||
- [ ] Step 2: Research plan and query set
|
||||
- [ ] Step 3: Evidence collection (deepresearch tool)
|
||||
- [ ] Step 4: Source triage and evidence table
|
||||
- [ ] Step 5: Outline and section map
|
||||
- [ ] Step 6: Multi-pass full drafting (parallel subagents)
|
||||
- [ ] Step 7: UNION merge and format compliance
|
||||
- [ ] Step 8: Evidence and citation verification
|
||||
- [ ] Step 9: Present draft for human review and iterate
|
||||
```
|
||||
|
||||
### Step 1: Intake and Format Contract
|
||||
|
||||
Establish the report requirements before any research:
|
||||
|
||||
- Confirm audience, purpose, scope, time range, and geography
|
||||
- Lock output format: Markdown, DOCX, slides, or user-provided template
|
||||
- Capture required sections and exact formatting rules
|
||||
- Confirm citation style (footnotes, inline, numbered, APA, etc.)
|
||||
- Confirm length targets per section
|
||||
- Ask for any existing style guide or sample report
|
||||
|
||||
Create a concise report spec file:
|
||||
|
||||
```
|
||||
Report Spec:
|
||||
- Audience:
|
||||
- Purpose:
|
||||
- Scope:
|
||||
- Time Range:
|
||||
- Geography:
|
||||
- Required Sections:
|
||||
- Section Formatting Rules:
|
||||
- Citation Style:
|
||||
- Output Format:
|
||||
- Length Targets:
|
||||
- Tone:
|
||||
- Must-Include Sources:
|
||||
- Must-Exclude Topics:
|
||||
```
|
||||
|
||||
If a user provides a template or an example report, treat it as a hard constraint and mirror the structure.
|
||||
|
||||
### Step 2: Research Plan and Query Set
|
||||
|
||||
Define the research strategy before calling tools:
|
||||
|
||||
- Break the main question into 3-7 subquestions
|
||||
- Define key entities, keywords, and synonyms
|
||||
- Identify primary sources vs secondary sources
|
||||
- Define disqualifiers (outdated, low quality, opinion-only)
|
||||
- Assemble a query set per section
|
||||
|
||||
Use [references/research_plan_checklist.md](references/research_plan_checklist.md) for guidance.
|
||||
|
||||
### Step 3: Evidence Collection (Deepresearch Tool)
|
||||
|
||||
Use the deepresearch tool to collect evidence and citations.
|
||||
|
||||
- Run multiple complete passes if coverage is uncertain
|
||||
- Vary query phrasing to reduce blind spots
|
||||
- Preserve raw tool output in files for traceability
|
||||
|
||||
**File structure (recommended):**
|
||||
```
|
||||
<output_dir>/research/<topic-name>/
|
||||
deepresearch_pass1.md
|
||||
deepresearch_pass2.md
|
||||
deepresearch_pass3.md
|
||||
```
|
||||
|
||||
If deepresearch is unavailable, rely on user-provided sources only and state limitations explicitly.
|
||||
|
||||
### Step 4: Source Triage and Evidence Table
|
||||
|
||||
Normalize and score sources before drafting:
|
||||
|
||||
- De-duplicate sources across passes
|
||||
- Score sources using [references/source_quality_rubric.md](references/source_quality_rubric.md)
|
||||
- Build an evidence table mapping claims to sources
|
||||
|
||||
Evidence table minimum columns:
|
||||
|
||||
- Source ID
|
||||
- Title
|
||||
- Publisher
|
||||
- Date
|
||||
- URL or reference
|
||||
- Quality tier (A/B/C)
|
||||
- Notes
|
||||
|
||||
### Step 5: Outline and Section Map
|
||||
|
||||
Create an outline that enforces the format contract:
|
||||
|
||||
- Use the template in [references/research_report_template.md](references/research_report_template.md)
|
||||
- Produce a section map with required elements per section
|
||||
- Confirm ordering and headings match the report spec
|
||||
|
||||
### Step 6: Multi-Pass Full Drafting (Parallel Subagents)
|
||||
|
||||
Avoid single-pass drafting; generate multiple complete reports, then merge.
|
||||
|
||||
#### Preferred Strategy: Parallel Subagents (Complete Draft Each)
|
||||
|
||||
Use the Task tool to spawn parallel subagents with isolated context. Each subagent must:
|
||||
|
||||
- Load the report spec, outline, and evidence table
|
||||
- Draft the FULL report (all sections)
|
||||
- Enforce formatting rules and citation style
|
||||
|
||||
**Implementation pattern:**
|
||||
```
|
||||
Task(subagent_type="general-purpose", prompt="Draft complete report ...", run_in_background=false) -> version1.md
|
||||
Task(subagent_type="general-purpose", prompt="Draft complete report ...", run_in_background=false) -> version2.md
|
||||
Task(subagent_type="general-purpose", prompt="Draft complete report ...", run_in_background=false) -> version3.md
|
||||
```
|
||||
|
||||
**Write drafts to files, not conversation context:**
|
||||
```
|
||||
<output_dir>/intermediate/<topic-name>/version1.md
|
||||
<output_dir>/intermediate/<topic-name>/version2.md
|
||||
<output_dir>/intermediate/<topic-name>/version3.md
|
||||
```
|
||||
|
||||
### Step 7: UNION Merge and Format Compliance
|
||||
|
||||
Merge using UNION, never remove content without evidence-based justification:
|
||||
|
||||
- Keep all unique findings from all versions
|
||||
- Consolidate duplicates while preserving the most detailed phrasing
|
||||
- Ensure every claim in the merged draft has a cited source
|
||||
- Enforce the exact section order, headings, and formatting
|
||||
- Re-run formatting rules from [references/formatting_rules.md](references/formatting_rules.md)
|
||||
|
||||
### Step 8: Evidence and Citation Verification
|
||||
|
||||
Verify traceability:
|
||||
|
||||
- Every numeric claim has at least one source
|
||||
- Every recommendation references supporting evidence
|
||||
- No orphan claims without citations
|
||||
- Dates and time ranges are consistent
|
||||
- Conflicts are explicitly called out with both sources
|
||||
|
||||
Use [references/completeness_review_checklist.md](references/completeness_review_checklist.md).
|
||||
|
||||
### Step 9: Present Draft for Human Review and Iterate
|
||||
|
||||
Present the draft as a reviewable version:
|
||||
|
||||
- Emphasize that format compliance and factual accuracy need human review
|
||||
- Accept edits to format, structure, and scope
|
||||
- If the user provides another AI output, cross-compare and UNION merge
|
||||
|
||||
## Output Requirements
|
||||
|
||||
- Match the requested language and tone
|
||||
- Preserve technical terms in English
|
||||
- Respect the report spec and formatting rules
|
||||
- Include a references section or bibliography
|
||||
|
||||
## Reference Files
|
||||
|
||||
| File | When to Load |
|
||||
| --- | --- |
|
||||
| [research_report_template.md](references/research_report_template.md) | Build outline and draft structure |
|
||||
| [formatting_rules.md](references/formatting_rules.md) | Enforce section formatting and citation rules |
|
||||
| [source_quality_rubric.md](references/source_quality_rubric.md) | Score and triage sources |
|
||||
| [research_plan_checklist.md](references/research_plan_checklist.md) | Build research plan and query set |
|
||||
| [completeness_review_checklist.md](references/completeness_review_checklist.md) | Review for coverage, citations, and compliance |
|
||||
|
||||
## Anti-Patterns
|
||||
|
||||
- Single-pass drafting without parallel complete passes
|
||||
- Splitting passes by section instead of full report drafts
|
||||
- Ignoring the format contract or user template
|
||||
- Claims without citations or evidence table mapping
|
||||
- Mixing conflicting dates without calling out discrepancies
|
||||
- Copying external AI output without verification
|
||||
- Deleting intermediate drafts or raw research outputs
|
||||
25
deep-research/references/completeness_review_checklist.md
Normal file
25
deep-research/references/completeness_review_checklist.md
Normal file
@@ -0,0 +1,25 @@
|
||||
# Completeness Review Checklist
|
||||
|
||||
Verify the draft meets all requirements before delivery.
|
||||
|
||||
## Structure and Format
|
||||
- All required sections present and ordered
|
||||
- Headings match the format contract
|
||||
- Length targets met per section
|
||||
|
||||
## Evidence and Citations
|
||||
- Every claim has a citation
|
||||
- Every numeric claim has at least one Tier A or B source
|
||||
- Conflicting sources are explicitly noted
|
||||
- Evidence table maps claims to sources
|
||||
|
||||
## Content Quality
|
||||
- Findings answer the research questions
|
||||
- Recommendations are tied to evidence
|
||||
- Limitations and uncertainty are documented
|
||||
- Terminology is consistent
|
||||
|
||||
## Final Checks
|
||||
- Dates and time ranges are consistent
|
||||
- No unsupported claims
|
||||
- No duplicate or conflicting statements
|
||||
31
deep-research/references/formatting_rules.md
Normal file
31
deep-research/references/formatting_rules.md
Normal file
@@ -0,0 +1,31 @@
|
||||
# Formatting Rules
|
||||
|
||||
Use these rules to enforce strict report formatting.
|
||||
|
||||
## Headings
|
||||
- Use H2 for top-level sections
|
||||
- Use H3 for subsections
|
||||
- Keep heading titles consistent with the report spec
|
||||
|
||||
## Section Order
|
||||
- Follow the report spec order exactly
|
||||
- Do not add or remove sections without approval
|
||||
|
||||
## Bullets and Tables
|
||||
- Use bullets for lists of findings and actions
|
||||
- Use tables for comparisons, metrics, or timelines
|
||||
- Keep tables compact and label all columns
|
||||
|
||||
## Citations
|
||||
- Use the citation style defined in the report spec
|
||||
- Place citations immediately after the claim
|
||||
- If a claim has multiple sources, list all relevant sources
|
||||
|
||||
## Terminology
|
||||
- Define key terms once and reuse consistently
|
||||
- Preserve technical terms in English
|
||||
|
||||
## Formatting Hygiene
|
||||
- Avoid mixed numbering styles in the same section
|
||||
- Avoid inline URLs in prose unless the spec requires it
|
||||
- Do not embed new assets unless requested
|
||||
26
deep-research/references/research_plan_checklist.md
Normal file
26
deep-research/references/research_plan_checklist.md
Normal file
@@ -0,0 +1,26 @@
|
||||
# Research Plan Checklist
|
||||
|
||||
Use this checklist before calling the deepresearch tool.
|
||||
|
||||
## Scope and Questions
|
||||
- Define the primary research question
|
||||
- Break into 3-7 subquestions
|
||||
- Define scope boundaries and exclusions
|
||||
- Define time range and geography
|
||||
|
||||
## Evidence Strategy
|
||||
- Identify primary sources needed
|
||||
- Identify secondary sources needed
|
||||
- Define inclusion and exclusion criteria
|
||||
- Define minimum number of sources per section
|
||||
|
||||
## Query Set
|
||||
- Create query variants per subquestion
|
||||
- Include synonyms and alternate terms
|
||||
- Add disambiguating keywords
|
||||
|
||||
## Query Log Template
|
||||
- Query:
|
||||
- Intended section:
|
||||
- Date run:
|
||||
- Notes:
|
||||
49
deep-research/references/research_report_template.md
Normal file
49
deep-research/references/research_report_template.md
Normal file
@@ -0,0 +1,49 @@
|
||||
# Research Report Template
|
||||
|
||||
## Title
|
||||
- Report title
|
||||
- Date
|
||||
- Author or team (optional)
|
||||
|
||||
## Executive Summary
|
||||
- 3-6 bullets, each supported by evidence
|
||||
- Include top conclusions and implications
|
||||
|
||||
## Research Question and Scope
|
||||
- Primary question
|
||||
- Scope boundaries (what is included and excluded)
|
||||
- Time range and geography
|
||||
|
||||
## Methodology
|
||||
- Data sources used
|
||||
- Search strategy and inclusion criteria
|
||||
- Limitations and known gaps
|
||||
|
||||
## Key Findings
|
||||
- 5-10 findings, each with citations
|
||||
|
||||
## Analysis
|
||||
### Section 1: [Theme]
|
||||
- Structured paragraphs with citations
|
||||
- If comparative, include a table
|
||||
|
||||
### Section 2: [Theme]
|
||||
- Structured paragraphs with citations
|
||||
|
||||
### Section 3: [Theme]
|
||||
- Structured paragraphs with citations
|
||||
|
||||
## Risks and Limitations
|
||||
- Data gaps
|
||||
- Conflicting sources
|
||||
- Uncertainty ranges
|
||||
|
||||
## Recommendations (If requested)
|
||||
- Actionable recommendations tied to findings
|
||||
- Each recommendation cites evidence
|
||||
|
||||
## Appendix A: Evidence Table
|
||||
- Table mapping claims to sources
|
||||
|
||||
## Appendix B: Sources
|
||||
- Full citations or links
|
||||
28
deep-research/references/source_quality_rubric.md
Normal file
28
deep-research/references/source_quality_rubric.md
Normal file
@@ -0,0 +1,28 @@
|
||||
# Source Quality Rubric
|
||||
|
||||
Classify sources into tiers and prioritize higher quality evidence.
|
||||
|
||||
## Tier A (Highest)
|
||||
- Primary sources: government data, standards bodies, peer-reviewed papers
|
||||
- Official filings: annual reports, regulatory filings, audited statements
|
||||
- First-party datasets with transparent methodology
|
||||
|
||||
## Tier B (Reliable)
|
||||
- Reputable news organizations with editorial standards
|
||||
- Industry analyst reports with clear methodology
|
||||
- Company technical blogs with data and disclosures
|
||||
|
||||
## Tier C (Use Sparingly)
|
||||
- Opinion pieces without evidence
|
||||
- Marketing materials without verification
|
||||
- Aggregators without clear sourcing
|
||||
|
||||
## Exclusion Rules
|
||||
- Exclude sources with no date or author
|
||||
- Exclude sources that cannot be verified
|
||||
- Exclude sources that are clearly outdated for the topic
|
||||
|
||||
## Conflict Handling
|
||||
- Surface conflicting sources explicitly
|
||||
- Prefer higher tier sources
|
||||
- Note uncertainty when conflicts remain
|
||||
Reference in New Issue
Block a user