technical-specification

What problem does it solve?

Documenting the "how" of a technical solution with sufficient detail for implementers is critical for clarity, successful execution, and future maintenance, especially after a design decision has been made. This Skill provides a structured approach to technical specification writing.

Core Features & Use Cases

• RFC vs. Tech Spec: Clear distinction between when to use an RFC (decision-making) versus a Tech Spec (implementation details).
• Tech Spec Document Structure: A comprehensive template including sections for Executive Summary, Detailed Specifications, Data Model, API Specification, Security, Testing, and Deployment.
• Tech Spec Lifecycle: Guidance on status transitions (DRAFT, APPROVED, REFERENCE, ARCHIVED) and their definitions.
• Quality Standards: Checklists and writing guidelines for completeness, specificity, and implementability, ensuring high-quality documentation.
• Use Case: Documenting the API contract for a new microservice, defining a database schema for a new feature, creating an implementation guide for a complex component, or specifying system integration details.

Quick Start

Use the technical-specification skill to generate a template for a new technical specification for a user authentication API.