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".
When & Why to Use This Skill
This Claude skill streamlines the creation of professional technical documentation, including design docs, specifications, and project proposals. By emphasizing a 'problem-first' approach and data-driven decision-making, it helps engineers and product managers transform complex technical ideas into structured, persuasive, and actionable documents that ensure stakeholder alignment.
Use Cases
- Software Architecture Design: Drafting comprehensive design documents (design docs) for new features or system overhauls to ensure technical feasibility and team consensus.
- Project Proposals: Creating structured proposals that clearly articulate the 'why' behind a project, addressing stakeholder concerns and resource constraints.
- Technical Specifications: Writing detailed '仕様書' (specifications) for API development or hardware integration to provide clear guidance for implementation teams.
- Standardizing Documentation: Utilizing predefined templates to maintain consistency and high quality across all internal technical communications and engineering records.
| name | technical-writing |
|---|---|
| description | Write technical design documents (design docs, specs, proposals). Use when creating design documents, technical specifications, project proposals, or similar structured technical content. |
Technical Writing
Workflow
- Understand context: Problem, stakeholders, constraints
- Choose template: Based on document type
- Write: Section by section
Document Templates
See references/templates.md for:
- Design Doc
Key Principles
Data-Driven Decision Making
Base design decisions on real data, not assumptions.
Problem First
- Start with the problem, not the solution
- Make the "why" compelling before the "how"