Back to Details

create-technical-spike

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Create Technical Spike Document

创建Technical Spike文档

Create time-boxed technical spike documents for researching critical questions that must be answered before development can proceed. Each spike focuses on a specific technical decision with clear deliverables and timelines.
创建有时间限制的Technical Spike文档，用于研究那些在开发推进前必须解决的关键问题。每个Spike聚焦于一个特定的技术决策，包含明确的交付成果和时间线。

Document Structure

文档结构

Create individual files in 
${input:FolderPath|docs/spikes}
directory. Name each file using the pattern: 
[category]-[short-description]-spike.md
(e.g., 
api-copilot-integration-spike.md
, 
performance-realtime-audio-spike.md
).
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:FolderPath|docs/spikes}
目录下创建独立文件。每个文件命名遵循以下格式：
[category]-[short-description]-spike.md
（例如：
api-copilot-integration-spike.md
、
performance-realtime-audio-spike.md
）。
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}

${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]
Spike目标： [需要解决的清晰、具体的问题或决策]
重要性： [对开发/架构决策的影响]
时间限制： [分配给此Spike的时长]
决策截止日期： [必须在此日期前解决，以避免阻塞开发]

Research Question(s)

研究问题

Primary Question: [Main technical question that needs answering]
Secondary Questions:
  • [Related question 1]
  • [Related question 2]
  • [Related question 3]
核心问题： [需要解答的主要技术问题]
次要问题：
  • [相关问题1]
  • [相关问题2]
  • [相关问题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]
  • [具体研究任务1]
  • [具体研究任务2]
  • [具体研究任务3]
  • [创建概念验证/原型]
  • [记录研究结果与建议]

Success Criteria

成功标准

This spike is complete when:
  • [Specific criteria 1]
  • [Specific criteria 2]
  • [Clear recommendation documented]
  • [Proof of concept completed (if applicable)]
当满足以下条件时，此Spike完成：
  • [具体标准1]
  • [具体标准2]
  • [已记录明确的建议]
  • [已完成概念验证（如适用）]

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]
相关组件： [受此决策影响的系统组件列表]
依赖关系： [哪些其他Spike或决策依赖于此问题的解决]
约束条件： [影响解决方案的已知限制或要求]

Research Findings

研究结果

Investigation Results

调查结果

[Document research findings, test results, and evidence gathered]
[记录研究发现、测试结果和收集到的证据]

Prototype/Testing Notes

原型/测试笔记

[Results from any prototypes, spikes, or technical experiments]
[来自任何原型、Spike或技术实验的结果]

External Resources

外部资源

  • [Link to relevant documentation]
  • [Link to API references]
  • [Link to community discussions]
  • [Link to examples/tutorials]
  • [相关文档链接]
  • [API参考链接]
  • [社区讨论链接]
  • [示例/教程链接]

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]
  • [行动项1]
  • [行动项2]
  • [更新架构文档]
  • [创建实施任务]

Status History

状态历史

DateStatusNotes
[Date]🔴 Not StartedSpike created and scoped
[Date]🟡 In ProgressResearch commenced
[Date]🟢 Complete[Resolution summary]
Last updated: [Date] by [Name]
undefined
日期状态备注
[日期]🔴 未开始Spike已创建并确定范围
[日期]🟡 进行中研究已启动
[日期]🟢 已完成[解决情况摘要]
最后更新：[日期] by [姓名]
undefined

Categories for Technical Spikes

Technical Spike的分类

API Integration

API集成

  • Third-party API capabilities and limitations
  • Integration patterns and authentication
  • Rate limits and performance characteristics
  • 第三方API的功能与限制
  • 集成模式与认证方式
  • 速率限制与性能特征

Architecture & Design

架构与设计

  • System architecture decisions
  • Design pattern applicability
  • Component interaction models
  • 系统架构决策
  • 设计模式的适用性
  • 组件交互模型

Performance & Scalability

性能与可扩展性

  • Performance requirements and constraints
  • Scalability bottlenecks and solutions
  • Resource utilization patterns
  • 性能要求与约束
  • 可扩展性瓶颈与解决方案
  • 资源使用模式

Platform & Infrastructure

平台与基础设施

  • Platform capabilities and limitations
  • Infrastructure requirements
  • Deployment and hosting considerations
  • 平台功能与限制
  • 基础设施要求
  • 部署与托管考虑因素

Security & Compliance

安全与合规

  • Security requirements and implementations
  • Compliance constraints
  • Authentication and authorization approaches
  • 安全要求与实现方案
  • 合规约束
  • 认证与授权方法

User Experience

用户体验

  • User interaction patterns
  • Accessibility requirements
  • Interface design decisions
  • 用户交互模式
  • 可访问性要求
  • 界面设计决策

File Naming Conventions

文件命名规范

Use descriptive, kebab-case names that indicate the category and specific unknown:
API/Integration Examples:
  • api-copilot-chat-integration-spike.md
  • api-azure-speech-realtime-spike.md
  • api-vscode-extension-capabilities-spike.md
Performance Examples:
  • performance-audio-processing-latency-spike.md
  • performance-extension-host-limitations-spike.md
  • performance-webrtc-reliability-spike.md
Architecture Examples:
  • architecture-voice-pipeline-design-spike.md
  • architecture-state-management-spike.md
  • architecture-error-handling-strategy-spike.md
使用描述性的短横线分隔命名（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

Best Practices for AI Agents

AI Agent的最佳实践

  1. One Question Per Spike: Each document focuses on a single technical decision or research question
  2. Time-Boxed Research: Define specific time limits and deliverables for each spike
  3. Evidence-Based Decisions: Require concrete evidence (tests, prototypes, documentation) before marking as complete
  4. Clear Recommendations: Document specific recommendations and rationale for implementation
  5. Dependency Tracking: Identify how spikes relate to each other and impact project decisions
  6. Outcome-Focused: Every spike must result in an actionable decision or recommendation
  1. 每个Spike聚焦一个问题： 每份文档仅关注一个技术决策或研究问题
  2. 限时研究： 为每个Spike定义明确的时间限制和交付成果
  3. 基于证据的决策： 在标记为完成前，需要有具体的证据（测试、原型、文档）
  4. 清晰的建议： 记录具体的实施建议及其理由
  5. 依赖跟踪： 明确Spike之间的关联及其对项目决策的影响
  6. 以结果为导向： 每个Spike必须产出可执行的决策或建议

Research Strategy

研究策略

Phase 1: Information Gathering

阶段1：信息收集

  1. Search existing documentation using search/fetch tools
  2. Analyze codebase for existing patterns and constraints
  3. Research external resources (APIs, libraries, examples)
  1. 使用搜索/获取工具查找现有文档
  2. 分析代码库以了解现有模式与约束
  3. 研究外部资源（API、库、示例）

Phase 2: Validation & Testing

阶段2：验证与测试

  1. Create focused prototypes to test specific hypotheses
  2. Run targeted experiments to validate assumptions
  3. Document test results with supporting evidence
  1. 创建聚焦的原型以测试特定假设
  2. 开展针对性实验以验证假设
  3. 记录测试结果及支持证据

Phase 3: Decision & Documentation

阶段3：决策与文档记录

  1. Synthesize findings into clear recommendations
  2. Document implementation guidance for development team
  3. Create follow-up tasks for implementation
  1. 将研究结果整合为清晰的建议
  2. 为开发团队记录实施指南
  3. 创建后续实施任务

Tools Usage

工具使用

  • search/searchResults: Research existing solutions and documentation
  • fetch/githubRepo: Analyze external APIs, libraries, and examples
  • codebase: Understand existing system constraints and patterns
  • runTasks: Execute prototypes and validation tests
  • editFiles: Update research progress and findings
  • vscodeAPI: Test VS Code extension capabilities and limitations
Focus on time-boxed research that resolves critical technical decisions and unblocks development progress.
  • search/searchResults： 研究现有解决方案与文档
  • fetch/githubRepo： 分析外部API、库和示例
  • codebase： 了解现有系统的约束与模式
  • runTasks： 执行原型与验证测试
  • editFiles： 更新研究进度与结果
  • vscodeAPI： 测试VS Code扩展的功能与限制
专注于限时研究，解决关键技术决策问题，解除开发推进的阻塞。