technical-specification

Generate technical specification documents covering architecture, data contracts, and integration patterns.

35|1|Updated Nov 6, 2011

Search Tags:#design #architecture #data-contracts #system-contracts #api-specs

Ready to run

npx skills add https://github.com/steveclarke/dotfiles --skill technical-specification-steveclarke

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: technical-specification
Source: https://github.com/steveclarke/dotfiles/tree/main/ai/skills/technical-specification
Command: npx skills add https://github.com/steveclarke/dotfiles --skill technical-specification-steveclarke

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Helps teams define architecture, system contracts, data contracts, and integration patterns without getting bogged down in implementation details.

Core Features & Use Cases

Architecture Overview: Core decisions and system structure.
System Components: Roles and contracts of each piece.
Data Contracts: Type definitions, DB schemas, API contracts.
Configuration Architecture: How the system is configured at high level.
Integration Patterns: How it fits with existing systems.
Quality Attributes: Performance, reliability, maintainability.

Quick Start

Start a technical specification for a feature using the 3- to 4-phase process.

Frequently Asked Questions about technical-specification

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

How do I write a technical specification for system architecture?▼

A technical specification formalizes architectural decisions by documenting the WHAT (system structure, components, contracts) and WHY (rationale behind choices) without implementation details. It covers architecture overview, data contracts, API specs, and integration patterns to align teams on system design before development begins.

What should a data contract specification include?▼

Data contracts in technical specifications define type definitions, database schemas, and API payload structures that establish agreements between system components. They ensure consistent data flow across services and reduce integration errors by making data expectations explicit.

Can I use technical specifications for API design?▼

Yes. Technical specifications document API contracts by defining endpoints, request/response structures, and integration patterns. This approach clarifies system boundaries and allows teams to validate architectural decisions before implementing backend or frontend code.

What's the difference between a technical specification and implementation documentation?▼

Technical specifications focus on WHAT the system does and WHY architectural decisions were made—covering contracts, components, and quality attributes. Implementation documentation describes HOW to build it. Specifications guide design; implementation docs guide coding.

When do I need system contracts in a specification?▼

System contracts are essential in full-stack, backend, and integration contexts where multiple components or services must coordinate reliably. They formalize expectations for data flow, API behavior, and configuration, reducing ambiguity and integration failures.

How do technical specifications help with system integration?▼

Specifications document integration patterns and system component roles, making clear how new services fit with existing systems. This prevents duplicate effort, clarifies data ownership, and enables teams to design compatible interfaces before implementation.