mcpField
C
create-technical-spike

create-technical-spike

github.com/github开发40.5k9.0k 次安装1 天前更新
代码仓库

关于 create-technical-spike

用于创建限时技术预研文档的 Skill,围绕单项技术决策组织研究,并产出可执行建议。它为 AI Agent 和开发团队提供从信息收集、验证到记录结论的流程。

主要功能

  1. 01结构化预研文档模板
  2. 02按类别梳理技术问题
  3. 03定义时限与交付物
  4. 04研究、原型和测试指引
  5. 05基于证据形成建议

适用场景

  1. 01集成前评估第三方 API
  2. 02验证性能或架构假设
  3. 03记录研究结果和后续任务

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/github/awesome-copilot --skill create-technical-spike

安装后在 Claude Code 中输入/create-technical-spike确认已加载。

详细介绍

创建技术刺探文档

创建限时技术刺探文档,用于研究在开发能够继续之前必须回答的关键问题。每个刺探聚焦于一项具体的技术决策,并明确交付物和时间线。

文档结构

在 ${input:FolderPath|docs/spikes} 目录中创建单独的文件。使用以下模式命名每个文件:[category]-[short-description]-spike.md(例如 api-copilot-integration-spike.md、performance-realtime-audio-spike.md)。

---
title: "${input:SpikeTitle}"
category: "${input:Category|Technical}"
status: "🔴 Not Started"
priority: "${input:Priority|High}"
timebox: "${input:Timebox|1 week}"
created: [YYYY-MM-DD]
updated: [YYYY-MM-DD]
owner: "${input:Owner}"
tags: ["technical-spike", "${input:Category|technical}", "research"]
---

# ${input:SpikeTitle}

## Summary

**Spike Objective:** [Clear, specific question or decision that needs resolution]

**Why This Matters:** [Impact on development/architecture decisions]

**Timebox:** [How much time allocated to this spike]

**Decision Deadline:** [When this must be resolved to avoid blocking development]

## Research Question(s)

**Primary Question:** [Main technical question that needs answering]

**Secondary Questions:**

- [Related question 1]
- [Related question 2]
- [Related question 3]

## Investigation Plan

### Research Tasks

- [ ] [Specific research task 1]
- [ ] [Specific research task 2]
- [ ] [Specific research task 3]
- [ ] [Create proof of concept/prototype]
- [ ] [Document findings and recommendations]

### Success Criteria

**This spike is complete when:**

- [ ] [Specific criteria 1]
- [ ] [Specific criteria 2]
- [ ] [Clear recommendation documented]
- [ ] [Proof of concept completed (if applicable)]

## Technical Context

**Related Components:** [List system components affected by this decision]

**Dependencies:** [What other spikes or decisions depend on resolving this]

**Constraints:** [Known limitations or requirements that affect the solution]

## Research Findings

### Investigation Results

[Document research findings, test results, and evidence gathered]

### Prototype/Testing Notes

[Results from any prototypes, spikes, or technical experiments]

### External Resources

- [Link to relevant documentation]
- [Link to API references]
- [Link to community discussions]
- [Link to examples/tutorials]

## Decision

### Recommendation

[Clear recommendation based on research findings]

### Rationale

[Why this approach was chosen over alternatives]

### Implementation Notes

[Key considerations for implementation]

### Follow-up Actions

- [ ] [Action item 1]
- [ ] [Action item 2]
- [ ] [Update architecture documents]
- [ ] [Create implementation tasks]

## Status History

| Date   | Status         | Notes                      |
| ------ | -------------- | -------------------------- |
| [Date] | 🔴 Not Started | Spike created and scoped   |
| [Date] | 🟡 In Progress | Research commenced         |
| [Date] | 🟢 Complete    | [Resolution summary]       |

---

_Last updated: [Date] by [Name]_

技术刺探的类别

API 集成
  • 第三方 API 的能力与限制
  • 集成模式与身份验证
  • 速率限制与性能特征
架构与设计
  • 系统架构决策
  • 设计模式的适用性
  • 组件交互模型
性能与可扩展性
  • 性能需求与约束
  • 可扩展性瓶颈与解决方案
  • 资源利用模式
平台与基础设施
  • 平台能力与限制
  • 基础设施需求
  • 部署与托管方面的考量
安全与合规
  • 安全需求与实现
  • 合规约束
  • 身份验证与授权方式
用户体验
  • 用户交互模式
  • 无障碍需求
  • 界面设计决策

文件命名约定

使用描述性的 kebab-case 名称,指明类别和具体未知项:

API/集成示例:

  • api-copilot-chat-integration-spike.md
  • api-azure-speech-realtime-spike.md
  • api-vscode-extension-capabilities-spike.md

性能示例:

  • performance-audio-processing-latency-spike.md
  • performance-extension-host-limitations-spike.md
  • performance-webrtc-reliability-spike.md

架构示例:

  • architecture-voice-pipeline-design-spike.md
  • architecture-state-management-spike.md
  • architecture-error-handling-strategy-spike.md

面向 AI Agent 的最佳实践

  1. 每个刺探一个问题: 每个文档聚焦于一项技术决策或研究问题

  2. 限时研究: 为每个刺探定义具体的时间限制和交付物

  3. 基于证据的决策: 在标记为完成之前,要求提供具体证据(测试、原型、文档)

  4. 清晰的建议: 记录具体的建议及实施理由

  5. 依赖关系跟踪: 确定各刺探之间的相互关系以及对项目决策的影响

  6. 以结果为导向: 每个刺探都必须得出可操作的决策或建议

研究策略

第 1 阶段:信息收集
  1. 搜索现有文档,使用搜索/抓取工具
  2. 分析代码库,了解现有模式和约束
  3. 研究外部资源(API、库、示例)
第 2 阶段:验证与测试
  1. 创建聚焦的原型,以测试具体假设
  2. 运行有针对性的实验,以验证假设
  3. 记录测试结果,并附上支持性证据
第 3 阶段:决策与文档
  1. 综合分析结果,形成清晰的建议
  2. 记录实施指导,供开发团队使用
  3. 创建后续任务,用于实施

工具用法

  • search/searchResults: 研究现有解决方案和文档
  • fetch/githubRepo: 分析外部 API、库和示例
  • codebase: 了解现有系统约束和模式
  • runTasks: 执行原型和验证测试
  • editFiles: 更新研究进展和发现
  • vscodeAPI: 测试 VS Code 扩展的能力与限制

专注于限时研究,解决关键的技术决策并解除开发进度的阻塞。

评论

支持 Markdown