secondsky/claude-skills / plugins/technical-specification/skills/technical-specification
technical-specification
VerifiedCreates 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.
| File | Kind | Size |
|---|---|---|
| SKILL.md | skill md | 2.9 KB |
| references/template.md | markdown | 4.6 KB |
references/template.md
View on GitHub# Technical Specification Template
Copy and customize this template for your feature specifications.
---
# Technical Specification: [Feature Name]
## Metadata
| Field | Value |
|-------|-------|
| **Status** | Draft / In Review / Approved / Implemented |
| **Author** | [Name] |
| **Reviewers** | [Names] |
| **Created** | YYYY-MM-DD |
| **Last Updated** | YYYY-MM-DD |
| **Target Release** | [Version/Sprint] |
## Executive Summary
[2-3 sentences: What problem are we solving? What's the proposed solution? What's the expected impact?]
## Background & Context
### Current State
[Describe the current situation and pain points]
### Why Now?
[What's driving this work? Business drivers, user feedback, technical debt, etc.]
### Related Work
- [Link to related specs]
- [Previous relevant decisions]
## Goals
### Primary Goals
1. [Specific, measurable goal]
2. [Another goal]
### Success Metrics
| Metric | Current | Target |
|--------|---------|--------|
| [Metric name] | [Value] | [Value] |
### Non-Goals
- [What this spec explicitly does NOT cover]
- [Out of scope items]
## Requirements
### Functional Requirements
| ID | Requirement | Priority | Acceptance Criteria |
|----|-------------|----------|---------------------|
| FR-1 | [Description] | P0 | [How to verify] |
| FR-2 | [Description] | P1 | [How to verify] |
| FR-3 | [Description] | P2 | [How to verify] |
### Non-Functional Requirements
| Category | Requirement | Target |
|----------|-------------|--------|
| Performance | Response time | < 200ms p99 |
| Scalability | Concurrent users | 10,000 |
| Availability | Uptime | 99.9% |
| Security | Authentication | JWT tokens |
## Technical Design
### Architecture Overview
```
┌─────────────┐ ┌─────────────┐ ┌─────────────┐
│ Client │────▶│ API │────▶│ Database │
│ (React) │◀────│ (Node.js) │◀────│ (Postgres) │
└─────────────┘ └─────────────┘ └─────────────┘
```
### Component Design
#### Component A
- **Purpose**: [What it does]
- **Dependencies**: [What it needs]
- **Interfaces**: [How it communicates]
### Data Model
```sql
CREATE TABLE feature_table (
id UUID PRIMARY KEY DEFAULT gen_random_uuid(),
name VARCHAR(255) NOT NULL,
status VARCHAR(50) DEFAULT 'active',
created_at TIMESTAMP DEFAULT NOW(),
updated_at TIMESTAMP DEFAULT NOW()
);
```
### API Design
#### Create Resource
```
POST /api/v1/resources
Content-Type: application/json
Request:
{
"name": "string",
"description": "string"
}
Response (201):
{
"id": "uuid",
"name": "string",
"createdAt": "datetime"
}
```
## Implementation Plan
### Phase 1: Foundation (Week 1-2)
- [ ] Set up database schema
- [ ] Implement core API endpoints
- [ ] Add basic validation
### Phase 2: Features (Week 3-4)
- [ ] Implement main feature logic
- [ ] Add authentication
- [ ] Create admin interface
### Phase 3: Polish (Week 5)
- [ ] Performance optimization
- [ ] Documentation
- [ ] Testing
## Testing Strategy
| Type | Coverage Target | Tools |
|------|-----------------|-------|
| Unit | 80% | Jest |
| Integration | Key flows | Supertest |
| E2E | Critical paths | Playwright |
## Security Considerations
### Threat Analysis
| Threat | Likelihood | Impact | Mitigation |
|--------|------------|--------|------------|
| [Threat] | Medium | High | [Strategy] |
### Security Checklist
- [ ] Input validation implemented
- [ ] Authentication required
- [ ] Authorization checks in place
- [ ] Audit logging enabled
- [ ] Data encrypted at rest
## Monitoring & Observability
### Key Metrics
- Request latency (p50, p95, p99)
- Error rate by endpoint
- Active users
### Alerts
| Condition | Threshold | Action |
|-----------|-----------|--------|
| Error rate | > 1% | Page on-call |
| Latency p99 | > 1s | Slack alert |
## Risk Assessment
| Risk | Probability | Impact | Mitigation |
|------|-------------|--------|------------|
| [Risk description] | Low/Med/High | Low/Med/High | [Plan] |
## Dependencies
### External Dependencies
- [Service/API name] - [Purpose]
### Team Dependencies
- [Team name] - [What we need]
## Rollout Plan
1. **Staging** - Internal testing
2. **Canary** - 5% of traffic
3. **Progressive** - 25% → 50% → 100%
### Rollback Plan
[How to rollback if issues arise]
## Open Questions
- [ ] [Question 1]
- [ ] [Question 2]
## Appendix
### References
- [Link to design docs]
- [Link to research]
### Glossary
| Term | Definition |
|------|------------|
| [Term] | [Definition] |
Related skills
| Skill | Stars | Updated | Works with | Status | Install |
|---|---|---|---|---|---|
| finishing-a-development-branchobra/superpowersUse when implementation is complete, all tests pass, and you need to decide how to integrate the work | Stars: 322k | Updated | Claude CodeCodex | Verified | Install |
| systematic-debuggingobra/superpowersUse when encountering any bug, test failure, or unexpected behavior, before proposing fixes | Stars: 322k | Updated | Claude CodeCodex | Verified | Install |
| test-driven-developmentobra/superpowersUse when implementing any feature or bugfix, before writing implementation code | Stars: 322k | Updated | Claude CodeCodex | Verified | Install |
| skill-creatoranthropics/skillsCreate new skills, modify and improve existing skills, and measure skill performance. Use when users want to create a skill from scratch, edit, or optimize an existing skill, run evals to test a skill, benchmark skill performance with variance analysis, or optimize a skill's description for better triggering accuracy. | Stars: 198k | Updated | Claude CodeCodex | Verified | Install |