Technical Specification

作者 secondsky88378361314fMIT227 个星标收录于 2026年10月8日更新于 2026年10月8日仓库10天前更新

Creates detailed technical specifications for software projects covering requirements, architecture, APIs, and testing strategies. Use when planning features, documenting system design, or creating architecture decision records.

AI 生成的概览

指导编写软件项目技术规格说明,涵盖需求、架构、API、测试与风险。

功能
提供结构化模板与最佳实践,用于编写软件项目的技术规格说明。模板涵盖元数据、执行摘要、目标与非目标、功能与非功能需求、技术设计、API 设计、数据库结构、实施计划、测试策略、风险与成功标准。它还指向参考文件中的完整可复制模板,其中包含安全威胁分析、监控、上线与回滚计划、依赖项和待解决问题等额外章节。
适用场景
适用于规划功能、记录系统设计或起草架构决策记录。适合需要在实施前形成一致且可评审的规格说明的团队。
运行要求
无需脚本或工具,仅为说明文档与参考模板。阅读随附的参考文件为可选。

Technical Specification

Create comprehensive technical specifications for software projects.

Specification Template

markdown
# Technical Specification: [Feature Name]
## Metadata- **Status**: Draft | In Review | Approved- **Author**: [Name]- **Reviewers**: [Names]- **Last Updated**: [Date]
## Executive Summary[2-3 sentences: What problem does this solve? What's the proposed solution?]
## Background & Context- Current pain points- Why now?- Related work
## Goals### Primary Goals1. [Measurable goal]
### Non-Goals- [What this spec explicitly does NOT cover]
## Functional Requirements| ID | Requirement | Priority ||----|-------------|----------|| FR-1 | [Description] | P0 || FR-2 | [Description] | P1 |
## Non-Functional Requirements- **Performance**: Response time < 200ms- **Scalability**: Support 10K concurrent users- **Availability**: 99.9% uptime- **Security**: [Requirements]
## Technical Design
### Architecture[Diagram or description]
### API Design

POST /api/v1/resource Request: { "field": "value" } Response: { "id": "123", "field": "value" }


### Database Schema```sqlCREATE TABLE resources (  id UUID PRIMARY KEY,  field VARCHAR(255));

Implementation Plan

PhaseTimelineDeliverables
1Week 1-2Core functionality
2Week 3API endpoints
3Week 4Testing & docs

Testing Strategy

  • Unit tests: 80% coverage
  • Integration tests: API endpoints
  • E2E tests: Critical flows

Risks & Mitigations

RiskProbabilityImpactMitigation
[Risk]MediumHigh[Plan]

Success Criteria

  • All P0 requirements implemented
  • Tests passing
  • Performance targets met
  • Documentation complete

## Full Template
See [references/template.md](references/template.md) for a comprehensive copy-paste template including:- Complete metadata section- Success metrics tables- Architecture diagrams- Detailed API design sections- Security threat analysis- Monitoring & observability- Risk assessment matrix- Rollout and rollback plans- Dependencies tracking- Open questions section
## Best Practices
**Do:**- Include measurable acceptance criteria- Add architecture diagrams- Define explicit API contracts- Quantify performance targets- Document risks and mitigations- Get stakeholder review before implementation- Include security considerations- Define rollback procedures
**Don't:**- Use vague requirements ("fast", "scalable")- Skip non-functional requirements- Ignore security considerations- Leave alternatives unexplored- Omit testing strategy- Forget dependencies and risks

来源与署名

来源:secondsky/claude-skills位于plugins/technical-specification/skills/technical-specification提交8837836

许可证: MIT

内容归原作者所有。SourceWeft 从公开仓库中收录这些内容。

举报或申请下架