skills.rest
jpoutrin
jpoutrinCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

technical-specification

Generates comprehensive technical specification documents for implementation-ready projects.

14|1|Updated Dec 5, 2025
Search Tags:#documentation#system design#technical writing#schema#data model#implementation guide#api specification
One-click install
npx skills add https://github.com/jpoutrin/product-forge --skill technical-specification
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: technical-specification
Source: https://github.com/jpoutrin/product-forge/tree/main/plugins/devops-data/skills/technical-specification
Command: npx skills add https://github.com/jpoutrin/product-forge --skill technical-specification

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

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.

Frequently Asked Questions about technical-specification

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

FAQPage Schema
When should I write a technical specification versus an RFC?▼

A technical specification documents implementation details after a design decision is made, while an RFC is for decision-making before that choice. Use a tech spec to guide developers building the approved solution—for API contracts, database schemas, or system integration details—once the RFC is approved.

What sections should a technical specification document include?▼

A comprehensive technical specification should include Header Metadata, Executive Summary, Design Overview, Detailed Specifications, Data Model, API Specification, Security, Performance, Testing, Deployment, and Migration plans. This structure ensures implementers have all required context for accurate, maintainable execution.

How do I ensure my technical specification is complete and implementable?▼

Follow quality checklists and writing guidelines that enforce specificity, clarity, and actionability. A complete spec includes precise details for each section, avoids ambiguity, and provides enough context that developers can build without re-designing or making assumptions.

Can I use a technical specification template for microservices, databases, and components?▼

Yes. The technical specification template applies across API contracts for microservices, database schemas for features, implementation guides for complex components, and system integration specifications. The same structured sections adapt to different implementation domains.

What are the status transitions for a technical specification document?▼

Technical specifications progress through defined lifecycle statuses: DRAFT (in progress), APPROVED (ready for implementation), REFERENCE (active and stable), and ARCHIVED (superseded or deprecated). Clear status tracking ensures teams know which specs are current and actionable.

Related Skills

Explore More Software Engineering Skills→
garochee33garochee33
3

design

Coordinate drafting, review, and revision of design documents until consensus.

Community
Advanced
N0K0N0K0

spec-issue

Generate structured specification documents as GitHub Issues or local markdown files.

Community
Advanced
rm2thaddeusrm2thaddeus
4

architecture-diagram-creator

Generate HTML architecture diagrams with SVG data flow visualization.

Community
Intermediate
keremtoker468-dotcomkeremtoker468-dotcom

prd

Generate Product Requirements Documents through guided discovery and templated creation.

Community
Advanced