Technical Specification

by secondsky88378361314fMIT227 starsListed Oct 8, 2026Updated Oct 8, 2026Repository updated 10 days ago

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-generated overview

Guides creation of technical specifications for software projects, covering requirements, architecture, APIs, testing and risks.

What it does
Provides a structured template and best practices for writing technical specifications for software projects. The template covers metadata, executive summary, goals and non-goals, functional and non-functional requirements, technical design, API design, database schema, implementation plan, testing strategy, risks and success criteria. It also points to a fuller copy-paste template in a reference file with additional sections such as security threat analysis, monitoring, rollout and rollback plans, dependencies and open questions.
When to use it
Use when planning a feature, documenting system design, or drafting an architecture decision record. It suits teams that need a consistent, reviewable specification before implementation begins.
Requirements
No scripts or tools are required; it is instructions and a reference template only. Reading the bundled reference file is optional.

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

Source and attribution

Source:secondsky/claude-skillsinplugins/technical-specification/skills/technical-specificationat commit8837836

License: MIT

Content belongs to its original authors. SourceWeft indexes it from a public repository.

Report or request removal