# Technical Writing

> Create clear, accurate, and useful technical documentation. Use when this capability is needed.

- Skill: `tomevault-io/technical-writing-6` (Agent Skill, multi-file: 2 files)
- Install (CLI): `npx skillmds@latest add tomevault-io/technical-writing-6`
- Raw SKILL.md: https://api.skillmd.com/api/skills/tomevault-io/technical-writing-6/raw
- Safety review: pending (external: skill-scanner PASS, skillspector PASS)
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: Docs & Writing
- Author: tomevault-io (https://skillmd.com/u/tomevault-io)
- Updated: 2026-09-17
- Page: https://skillmd.com/skills/tomevault-io/technical-writing-6

---


# Technical Writing Skill

## Purpose
Create clear, accurate, and useful technical documentation.

## Core Principles

### 1. Know Your Audience
- Who will read this?
- What do they already know?
- What do they need to accomplish?

### 2. Be Clear and Concise
- Use simple, direct language
- One idea per sentence
- Avoid jargon unless necessary

### 3. Structure for Scanning
- Use headings and subheadings
- Include bullet points and lists
- Add code examples
- Use tables for comparisons

### 4. Show, Don't Just Tell
- Include working examples
- Add screenshots where helpful
- Provide step-by-step instructions

## Document Types

### Tutorials
Step-by-step learning guides for beginners.

### How-To Guides
Task-oriented guides for specific goals.

### Reference
Comprehensive technical details and API docs.

### Explanations
Background and conceptual information.

## Best Practices

1. **Test Your Instructions** - Follow your own docs
2. **Use Active Voice** - "Click the button" not "The button should be clicked"
3. **Be Consistent** - Same terms, formatting, style throughout
4. **Update Regularly** - Outdated docs are worse than none
5. **Get Feedback** - Have users test your documentation

## Checklist

- [ ] Accurate and up-to-date?
- [ ] Clear purpose stated upfront?
- [ ] Prerequisites listed?
- [ ] Examples are complete and working?
- [ ] Proofread for errors?

---
> Converted and distributed by [TomeVault](https://tomevault.io/claim/hffmnnj) — claim your Tome and manage your conversions.
<!-- tomevault:4.0:skill_md:2026-04-11 -->