using-technical-writer

これはレビュー時に保存された抜粋です。完全で最新の内容は外部ソースを確認してください。

---
name: using-technical-writer
description: Use when writing or improving documentation - ADRs, APIs, runbooks, READMEs, architecture docs, security/compliance docs, post-mortems, register review or translation (technical/policy/government/public-facing/executive/academic), fact-checking research papers, or surgical edits on large (>=2000 line) files
---

# Using Technical Writer

## Overview

This meta-skill routes you to the right technical writing skills based on your documentation task. Load this skill when you need to create, improve, or organize documentation but aren't sure which specific writing skill to use.

**Core Principle**: Different document types and audiences require different skills. Match your situation to the appropriate skill, load only what you need.

## When to Use

Load this skill when:
- Starting any documentation task
- User mentions: "document", "write docs", "README", "API docs", "ADR", "runbook"
- Creating technical content for any audience
- Improving or reorganizing existing documentation

**Don't use for**: Non-technical writing (marketing copy, blog posts, creative content)

---

## How to Access Reference Sheets

**IMPORTANT**: All reference sheets are located in the SAME DIRECTORY as this SKILL.md file.

When this skill is loaded from:
  `skills/using-technical-writer/SKILL.md`

Reference sheets like `documentation-structure.md` are at:
  `skills/using-technical-writer/documentation-structure.md`

NOT at:
  `skills/documentation-structure.md` ← WRONG PATH

When you see a link like `[documentation-structure.md](documentation-structure.md)`, read the file from the same directory as this SKILL.md.

---

## Routing by Document Type

### Architecture Decisions (ADRs)

**Symptoms**: "Document why we chose X", "Record this architectural decision", "Explain technology choice"

**Route to**: [documentation-structure.md](documentation-structure.md)

**Key Pattern**: ADRs document Context → Decision → Consequences

**Example**: "Document why we chose PostgreSQL over MongoDB" → Load [documentation-structure.md](documentation-structure.md)

---

### API Documentation

**Symptoms**: "Document this API", "Create API reference", "Explain endpoints"

**Route to**:
1. [documentation-structure.md](documentation-structure.md) (API reference pattern)
2. [clarity-and-style.md](clarity-and-style.md) (examples, precision)

**Example**: "Document REST API for user management" → Load both skills

---

### Runbooks & Procedures

**Symptoms**: "Write deployment procedure", "Create incident runbook", "Document how to..."

**Route to**:
1. [documentation-structure.md](documentation-structure.md) (runbook pattern)
2. [clarity-and-style.md](clarity-and-style.md) (step-by-step clarity)

**Example**: "Create deployment runbook" → Load both skills

---

### README Files

**Symptoms**: "Add a README", "Quick start guide", "Installation instructions"

**For Complex Projects**:
Route to: [documentation-structure.md](documentation-structure.md) (README pattern)

**For Simple Utilities**:
Route to: **NONE** - basic technical writing sufficient

**Decision Point**: Complex (>100 lines, multiple features, deployment) vs Simple (script, single function)

---

### Security Documentation

**Symptoms**: "Document threat model", "Security controls", "Document security decisions"

**Route to (Cross-Faction)**:
1. `ordis/security-architect/documenting-threats-and-controls` (security content)
2. [documentation-structure.md](documentation-structure.md) (ADR format, organization)
3. [clarity-and-style.md](clarity-and-style.md) (explain to non-experts)

**Key Insight**: Security docs need BOTH content expertise (Ordis) AND writing skills (Muna)

**Example**: "Document authentication security decisions" → Load all three skills

---

## Routing by Audience

**Audience vs Register**: Audience (who-receives) and register (how-text-operates) are orthogonal. A document has both. Audience determines what information to include; register determines h