Technical Specification

secondsky/claude-skills/plugins/technical-specification/skills/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 從公開儲存庫中收錄這些內容。

檢舉或申請下架