---
name: technical-communication
description: Write clear technical communications including emails, reports, and status
  updates. Use when communicating technical information to stakeholders or team members.
metadata:
  source: nuday
  catalog: platform
  category: communication
  priority: '45'
---

# Technical Communication

## Overview
This skill helps write clear, effective technical communications.

## Communication Types

### Status Updates
Structure:
1. **Summary**: One-line overview
2. **Completed**: What was done
3. **In Progress**: Current work
4. **Blockers**: Issues needing resolution
5. **Next Steps**: Upcoming priorities

Example:
```
## Weekly Status - Project X

**Summary**: On track for Q1 release, API development 80% complete.

**Completed this week**:
- Implemented user authentication endpoints
- Added rate limiting middleware
- Completed unit tests for auth module

**In Progress**:
- Database schema optimization
- Integration tests

**Blockers**:
- Awaiting security review feedback (ETA: Tuesday)

**Next Week**:
- Complete integration tests
- Begin frontend integration
```

### Technical Proposals
Structure:
1. **Problem Statement**: What needs solving
2. **Proposed Solution**: Your recommendation
3. **Alternatives Considered**: Other options
4. **Trade-offs**: Pros and cons
5. **Implementation Plan**: How to execute
6. **Success Metrics**: How to measure success

### Incident Reports
Structure:
1. **Executive Summary**: Impact and resolution
2. **Timeline**: Chronological events
3. **Root Cause**: What went wrong
4. **Resolution**: How it was fixed
5. **Lessons Learned**: What to improve
6. **Action Items**: Preventive measures

## Writing Guidelines

### Clarity
- Lead with the most important information
- Use simple, direct language
- Avoid unnecessary jargon
- Define technical terms when needed

### Structure
- Use headers and bullet points
- Keep paragraphs short
- Include visual aids when helpful
- Provide executive summary for long documents

### Audience
- Consider technical level
- Anticipate questions
- Provide appropriate detail
- Include context