skills.rest
chavangorakh1999
chavangorakh1999COMMUNITY
Explore all skills by this author →
Website𝕏@grc_jrGitHub

tech-spec-writing

Generate technical specification documents with requirements, design options, and implementation plans.

1|Updated Mar 6, 2026
Search Tags:#documentation#software design#project planning#technical specification#rfc#design doc
One-click install
npx skills add https://github.com/chavangorakh1999/sde-skills --skill tech-spec-writing
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: tech-spec-writing
Source: https://github.com/chavangorakh1999/sde-skills/tree/main/sde-career/skills/tech-spec-writing
Command: npx skills add https://github.com/chavangorakh1999/sde-skills --skill tech-spec-writing

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill helps you create detailed technical specifications (design docs, RFCs) for significant technical projects, ensuring clarity on problem statements, requirements, design options, trade-offs, and decisions.

Core Features & Use Cases

  • Structured Template: Provides a comprehensive template covering problem statement, goals, requirements, design, alternatives, implementation, testing, and observability.
  • Guidance on When to Spec: Offers clear criteria for when a technical spec is necessary versus when it can be skipped.
  • Writing Best Practices: Includes tips for effective spec writing, such as focusing on the problem first, considering alternatives, and making decisions explicit.
  • Use Case: When starting a new microservice that will impact multiple teams, use this skill to generate a detailed technical specification that outlines the API, data model, and rollout plan.

Quick Start

Use the tech-spec-writing skill to draft a technical specification for a new user authentication service.

Frequently Asked Questions about tech-spec-writing

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

FAQPage Schema
How do I draft a technical specification for a new software project?▼

To draft a technical specification, define the problem statement, outline functional and non-functional requirements, evaluate design options with trade-offs, and detail the implementation, testing, and observability plans. This structured approach ensures clarity for significant software projects.

When do I need to write a design doc or RFC for software development?▼

You need to write a design doc or RFC when starting significant technical projects that impact multiple teams, such as introducing a new microservice. It ensures clarity on requirements, design decisions, and rollout plans before implementation begins.

What is the best way to structure a technical specification document?▼

The best way to structure a technical specification is to follow a comprehensive template covering the problem statement, goals, requirements, design alternatives, implementation plan, testing strategy, and observability considerations for clear project planning.

What should I include in the testing and observability sections of a technical spec?▼

In the testing and observability sections of a technical spec, include strategies for validating functional requirements and plans for monitoring system behavior post-deployment. This ensures the software design maintains reliability throughout the implementation plan.

Can I use this to document design alternatives and trade-offs for an API?▼

Yes, you can document design alternatives and trade-offs for an API. The specification process guides you to make decisions explicit by comparing different software design options and their impacts on the overall project planning and data model.

Related Skills

Explore More Software Engineering Skills→
stharroldstharrold

bmad-planner

Generate requirements, architecture, and epics documents via interactive Q&A.

Community
Intermediate
Eigo-Mt-FujiEigo-Mt-Fuji

database-schema-designer

Design database schemas, ER diagrams, and DDL for relational and NoSQL databases.

Community
Advanced
ValorVieValorVie
5

spec-driven-dev

Execute end-to-end Spec-Driven Development planning with traceable proposals, reviews, and verifications.

Community
Advanced
sunnypatneedisunnypatneedi
11

software-architecture

Design scalable software architectures with pattern guidance, ADR templates, and trade-off analyses.

Community
Basic