如何创建研究资料包：结构化领域知识文档的完整指南与模板
The Agent Skills Directory
安装命令
npx skills add https://smithery.ai/skills/cipherstash/creating-research-packages🇨🇳中文介绍
创建研究资料包
概述
将复杂的领域知识打包成独立的模块，为不同的时间预算和读者角色提供多个入口点。
开始时声明： "我正在使用创建研究资料包技能来记录这个领域知识。"
使用场景
- 记录复杂的研究发现
- 创建领域知识包（物理、算法、API）
- 构建可以独立共享的自包含文档
- 需要多种阅读路径的主题（快速概览 vs 深度研究）
- 需要跟踪验证状态的知识
流程
步骤 1：确定资料包范围
确定需要打包哪些知识：
- 核心主题是什么？
- 有哪些子主题？
- 读者是谁？（角色、时间预算）
- 需要哪些验证？
步骤 2：创建目录结构
mkdir -p docs/[topic]
标准资料包结构：
[topic]/
├── 00-START-HERE.md # 入口点 + 验证状态
├── README.md # 资料包概述 + TL;DR
├── how-to-use-this.md # 详细导航指南
├── [core-topic-1].md # 主要研究内容
├── [core-topic-2].md # 附加研究
├── design-decisions.md # 决策原因
├── QUICK-REFERENCE.md # 单页摘要
├── VERIFICATION-REVIEW.md # 准确性审核
└── examples/ # 工作示例（如适用）
步骤 3：编写入口点 (00-START-HERE.md)
包含：
- 带有视觉指示器的验证状态
- 时间预算选项（5 分钟、20 分钟、2 小时）
- 快速导航到关键文档
- 先决条件（如果有）
# [主题]：从这里开始
**状态：** ✅ 已验证 | **最后更新：** YYYY-MM-DD
## 选择你的路径
| 时间 | 目标 | 从...开始 |
|------|------|------------|
| 5 分钟 | 快速概览 | [README 中的 TL;DR 部分] |
| 20 分钟 | 理解背景 | [README + design-decisions] |
| 2 小时 | 完全理解 | [按顺序阅读所有文档] |
步骤 4：编写包含 TL;DR 的 README
README 是资料包的概述：
- TL;DR 部分（2-3 句话，核心见解）
- 按时间预算划分的阅读路径
- 基于角色的路径
- 资料包内容概述
- 关键概念及详细内容的链接
使用模板： ${CLAUDE_PLUGIN_ROOT}templates/research-package-template.md
步骤 5：编写导航指南 (how-to-use-this.md)
针对不同读者的详细指南：
- 基于角色的路径及阅读顺序
- 每条路径的时间估算
- 每个角色的关键收获
- 文档间的交叉引用
步骤 6：编写核心内容
对于每个主题文档：
- 清晰的范围声明
- 带标题的结构化内容
- 有帮助的视觉辅助（图表、表格）
- 相关文档的交叉引用
- 验证说明（如适用）
步骤 7：创建快速参考
用于快速查阅的单页摘要：
- 关键公式/常量
- 常用命令
- 快速诊断表
- 状态图标图例
使用模板： ${CLAUDE_PLUGIN_ROOT}templates/quick-reference-template.md
步骤 8：添加验证跟踪
如果准确性至关重要：
- 创建 VERIFICATION-REVIEW.md
- 跟踪已验证的内容和时间
- 记录发现的差异
- 链接到权威来源
- 包含建议的更新
步骤 9：验证资料包完整性
检查清单：
- 00-START-HERE.md 有清晰的导航
- README 的 TL;DR 抓住了精髓
- 阅读路径覆盖了不同的时间预算
- 为不同读者提供了基于角色的路径
- QUICK-REFERENCE 确实是单页
- 所有交叉引用有效
- 验证状态是最新的
检查清单
- 资料包范围明确定义
- 目录结构已创建
- 入口点 (00-START-HERE) 已编写
- 包含 TL;DR 的 README 已编写
- 导航指南已编写
- 核心内容文档已编写
- 快速参考已创建
- 验证跟踪（如需要）已添加
- 所有内部链接已验证
反面模式
不要：
- 为简单主题创建资料包（过度设计）
- 跳过 TL;DR（读者需要快速概览）
- 省略时间估算（读者无法规划）
- 忽略关键知识的验证
- 让 QUICK-REFERENCE 超过一页
应该：
- 将 TL;DR 控制在 2-3 句话
- 提供多个入口点
- 跟踪技术准确性验证
- 大量使用交叉引用
- 用新手的视角测试导航
相关技能
- 组织文档：
${CLAUDE_PLUGIN_ROOT}skills/organizing-documentation/SKILL.md - 记录调试工作流：
${CLAUDE_PLUGIN_ROOT}skills/documenting-debugging-workflows/SKILL.md - 创建质量门：
${CLAUDE_PLUGIN_ROOT}skills/creating-quality-gates/SKILL.md
参考
- 标准：
${CLAUDE_PLUGIN_ROOT}standards/documentation-structure.md - 模板：
${CLAUDE_PLUGIN_ROOT}templates/research-package-template.md - 快速参考模板：
${CLAUDE_PLUGIN_ROOT}templates/quick-reference-template.md
每周安装次数
–
来源
首次出现
–
🇺🇸English
Creating Research Packages
Overview
Bundle complex domain knowledge into self-contained modules with multiple entry points for different time budgets and reader roles.
Announce at start: "I'm using the creating-research-packages skill to document this domain knowledge."
When to Use
- Documenting complex research findings
- Creating domain knowledge packages (physics, algorithms, APIs)
- Building self-contained documentation that can be shared independently
- Topics requiring multiple reading paths (quick overview vs deep dive)
- Knowledge that needs verification tracking
The Process
Step 1: Identify the Package Scope
Determine what knowledge should be packaged:
- What is the core topic?
- What are the sub-topics?
- Who are the readers? (roles, time budgets)
- What verification is needed?
Step 2: Create Directory Structure
mkdir -p docs/[topic]
Standard package structure:
[topic]/
├── 00-START-HERE.md # Entry point + verification status
├── README.md # Package overview + TL;DR
├── how-to-use-this.md # Detailed navigation guide
├── [core-topic-1].md # Main research content
├── [core-topic-2].md # Additional research
├── design-decisions.md # Why decisions were made
├── QUICK-REFERENCE.md # One-page summary
├── VERIFICATION-REVIEW.md # Accuracy audit
└── examples/ # Working examples (if applicable)
广告位招租
在这里展示您的产品或服务
触达数万 AI 开发者，精准高效
