mcpField
T
technical-specification

technical-specification

github.com/aj-geddes开发373806 次安装34 周前更新
代码仓库

关于 technical-specification

这项技能用于编写技术规格，明确需求、架构、实现细节和验收标准，适合产品与工程团队。可用于功能规格、设计记录、API 定义及其他项目文档。

主要功能

  1. 01需求与验收标准
  2. 02架构和实现细节
  3. 03API 契约与数据模型
  4. 04数据库模式文档
  5. 05安全、性能与风险指引

适用场景

  1. 01起草功能规格
  2. 02记录架构决策
  3. 03定义 API 或数据库设计
  4. 04准备技术提案或 RFC

安装

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

$npx skills add https://github.com/aj-geddes/useful-ai-prompts --skill technical-specification

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

包含的文件

除 SKILL.md 外，安装时一起下载的参考资料和脚本。

references/
api-data-models.md
authentication-endpoints.md
database-schema.md
functional-requirements.md
non-functional-requirements.md
phase-1-core-authentication.md
rate-limiting.md
templates/
doc-template.md

详细介绍

技术规范

目录

概述

创建全面的技术规范，明确软件项目的系统需求、架构、实现细节和验收标准。

适用场景

  • 功能规范
  • 系统设计文档
  • 需求文档（PRD）
  • 架构决策记录（ADR）
  • 技术提案
  • RFC（征求意见稿）
  • API 设计规范
  • 数据库架构设计

快速开始

最小可用示例：

# Technical Specification: [Feature Name]

**Document Status:** Draft | Review | Approved | Implemented
**Version:** 1.0
**Author:** John Doe
**Date:** 2025-01-15
**Reviewers:** Jane Smith, Bob Johnson
**Last Updated:** 2025-01-15

## Executive Summary

Brief 2-3 sentence overview of what this spec covers and why it's being built.

**Problem:** What problem are we solving?
**Solution:** High-level description of the solution
**Impact:** Expected business/user impact

---

## 1. Background

### Context

Provide background on why this feature is needed:

// ... (see reference guides for full implementation)

参考指南

references/ 目录中的详细实现：

指南内容
功能需求功能需求
非功能需求非功能需求
数据库架构数据库架构
API 数据模型API 数据模型
身份验证端点身份验证端点
速率限制速率限制
阶段 1：核心身份验证阶段 1：核心身份验证（第 1–2 周）、阶段 2：电子邮件验证（第 3 周）、阶段 3：社交登录（第 4 周）、阶段 4：安全功能（第 5 周）（另有 1 项）

最佳实践

✅ 应该做
  • 为每项需求制定验收标准
  • 提供架构图
  • 记录 API 契约
  • 明确性能要求
  • 列出风险和缓解措施
  • 包含实施时间表
  • 添加成功指标
  • 记录安全注意事项
  • 为规范进行版本管理
  • 邀请利益相关方评审
❌ 不应该做
  • 对需求含糊其辞
  • 忽略非功能需求
  • 忘记安全问题
  • 忽视替代方案
  • 跳过测试策略
  • 忘记监控和可观测性
  • 留下未解答的问题

评论

支持 Markdown