SuperAPI AI 工具集

create-technical-spike

编程与开发

查看项目

更新于 10-15 13:39

技能介绍

用途

本技能用于在开发实施前,创建限时(time-boxed)的技术探针文档,以研究并解决关键的技术决策问题。每个探针聚焦一个特定的技术疑问,并带有明确的交付物与时间线,帮助团队在开发推进前消除不确定性。

主要能力

  • 在指定目录(默认 ${input:FolderPath|docs/spikes})中生成独立文件,命名模式为 [category]-[short-description]-spike.md,例如 api-copilot-integration-spike.md、performance-realtime-audio-spike.md。
  • 生成结构化的文档模板,包含 YAML frontmatter 字段:title、category、status、priority、timebox、created、updated、owner、tags。
  • 文档正文包含以下分区:Summary(含 Spike Objective、Why This Matters、Timebox、Decision Deadline)、Research Question(s)(主问题与次问题)、Investigation Plan(研究任务与成功标准)、Technical Context(相关组件、依赖、约束)、Research Findings(调查结果、原型/测试记录、外部资源)、Decision(建议、理由、实施说明、后续动作)、Status History 表格。
  • 支持多种探针类别:API Integration、Architecture & Design、Performance & Scalability、Platform & Infrastructure、Security & Compliance、User Experience。
  • 提供文件命名约定示例,覆盖 API/集成、性能、架构三类场景。

使用方式

技能通过模板中的 ${input:...} 占位符提示填写各项参数,如 SpikeTitle、Category、Priority、Timebox、Owner。文件命名采用描述性的 kebab-case,需体现类别与具体未知项。

文档状态使用标记:🔴 Not Started、🟡 In Progress、🟢 Complete,并在 Status History 表格中记录日期、状态与备注。

资料中提到的工具用法包括:

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

研究策略

技能建议分三阶段进行:

  1. 信息收集:检索现有文档、分析代码库既有模式与约束、研究外部资源。
  2. 验证与测试:创建聚焦原型测试特定假设、运行定向实验、记录带证据的测试结果。
  3. 决策与文档:将发现综合为清晰建议、为开发团队编写实施指南、创建后续实施任务。

适用场景

  • 需要评估第三方 API 的能力、限制、认证方式、速率限制与性能特征时。
  • 需要做出系统架构决策、评估设计模式适用性或组件交互模型时。
  • 需要明确性能要求与约束、扩展性瓶颈与解决方案时。
  • 需要评估平台能力与限制、基础设施需求、部署与托管考量时。
  • 需要梳理安全要求、合规约束、认证授权方式时。
  • 需要确定用户交互模式、无障碍要求或界面设计决策时。

最佳实践

  • 每个探针只聚焦一个技术决策或研究问题。
  • 为每个探针定义具体时间限制与交付物。
  • 在标记完成前要求具体证据(测试、原型、文档)。
  • 记录明确的建议与理由。
  • 跟踪探针之间的关系及其对项目决策的影响。
  • 每个探针都必须产出可执行的决策或建议。

限制

资料未提供本技能的安装方式、收费与价格信息、支持的平台范围,以及具体的集成或运行环境要求,这些内容暂未提供。