tech-spec-writer

DCRepairCenter's avatarfrom DCRepairCenter

Technical specification writer. Use when creating detailed technical documentation, API specifications, or architecture documents.

⭐0stars🔀1forks📁View on GitHub🕐Updated Jan 1, 2026
[Technical Writing]

When & Why to Use This Skill

The Tech Spec Writer skill automates the creation of comprehensive technical documentation, API specifications, and system architecture designs. It ensures consistency across development teams by providing a standardized, bilingual template that covers critical aspects like data flow, error handling, and performance requirements, significantly improving the quality and clarity of software design documents.

Use Cases

  • Drafting detailed API specifications with clear interface definitions and code examples to facilitate seamless frontend-backend integration.
  • Designing system architecture documents for new software modules, outlining component relationships, data flows, and internal/external dependencies.
  • Standardizing technical documentation across international engineering teams using bilingual headers and predefined performance tier requirements.
  • Creating robust error-handling strategies and testing plans during the initial design phase to ensure system reliability and maintainability.
nametech-spec-writer
descriptionTechnical specification writer. Use when creating detailed technical documentation, API specifications, or architecture documents.

Tech Spec Writer Skill

Write detailed technical specifications and architecture documents.

Document Structure

# TECH-{ModuleName}: {模块名称}

## 1. 概述 / Overview
{模块职责和核心功能}

## 2. 架构 / Architecture
{分层设计、组件关系}

## 3. 接口定义 / Interface Definitions
{公共 API、数据类型}

## 4. 数据流 / Data Flow
{输入输出、处理流程}

## 5. 依赖 / Dependencies
{外部依赖、内部依赖}

## 6. 配置 / Configuration
{配置项、环境变量}

## 7. 错误处理 / Error Handling
{异常类型、处理策略}

## 8. 性能考量 / Performance Considerations
{响应时间、资源使用}

## 9. 测试策略 / Testing Strategy
{单元测试、集成测试}

Conventions

  • Use bilingual section headers (中文 / English)
  • Include code examples for interfaces
  • Reference contract types from core.contracts
  • Specify response tier requirements (Tier1: <50ms, Tier2: <100ms, Tier3: <3s)

Reference Documents

  • Main tech stack: .github/techstacks/TECH-Rainze.md
  • Module designs: .github/prds/modules/MOD-*.md
  • PRD: .github/prds/PRD-Rainze.md