technical-writing

Write technical design documents (design docs, specs, proposals). Use when creating design documents, technical specifications, project proposals, or similar structured technical content. Trigger on "design doc", "デザインドック", "設計書", "仕様書", "proposal".

⭐5stars🔀1forks📁View on GitHub🕐Updated Jan 11, 2026

When & Why to Use This Skill

This Claude skill streamlines the creation of professional technical documentation, including design documents, specifications, and project proposals. It leverages a structured, data-driven workflow to help engineers and product managers articulate complex technical architectures, quantify problem impacts, and define clear project scopes with measurable KPIs, ensuring high-quality and actionable technical content.

Use Cases

  • Architectural Design: Drafting comprehensive design documents for new software systems, incorporating real-world data and SQL queries to justify technical decisions.
  • Project Proposals: Creating compelling technical proposals that quantify business impact, such as cost reduction or performance improvements, to gain stakeholder buy-in.
  • Technical Specifications: Writing detailed specifications for features or APIs, ensuring clear boundaries between in-scope and out-of-scope requirements to prevent project creep.
nametechnical-writing
descriptionWrite technical design documents (design docs, specs, proposals). Use when creating design documents, technical specifications, project proposals, or similar structured technical content. Trigger on "design doc", "デザインドック", "設計書", "仕様書", "proposal".

Technical Writing

Workflow

  1. Context Gathering: Understand the problem, stakeholders, constraints
  2. Structure Selection: Choose appropriate template based on document type
  3. Data Collection: Gather metrics, run queries, collect evidence
  4. Drafting: Write section by section, starting with unknowns
  5. Verification: Validate all data and queries are accurate

Document Templates

See references/templates.md for:

  • Design Doc (問題解決型)
  • Report Design (レポート設計型)

Key Principles

Data-Driven

  • Include real data, not hypotheticals
  • Show SQL queries with actual results
  • Define measurable KPIs with baselines and targets

Scope Clarity

  • Explicit "スコープ外" section
  • Document what you're NOT doing and why
  • Prevents scope creep and sets expectations

Problem First

  • Start with the problem, not the solution
  • Quantify the impact (件数, コスト, 時間)
  • Make the "why" compelling before the "how"