Technical Writing

Clear technical documentation, API docs, architecture decision records, and runbooks.

48 stars 10 forksWriting & Content Plugin marketplace

Install

Claude Code plugin
/plugin marketplace add sethdford/claude-skills

The repo is a Claude Code plugin marketplace. Run /plugin afterwards to pick the plugin that includes this skill.

skills CLI (Claude Code, Cursor, Codex and more)
npx skills add sethdford/claude-skills --skill technical-writing
Manual install
git clone --depth 1 https://github.com/sethdford/claude-skills.git /tmp/claude-skills
mkdir -p ~/.claude/skills
cp -r /tmp/claude-skills/engineer/engineer-toolkit/skills/technical-writing ~/.claude/skills/technical-writing

Personal skills live in ~/.claude/skills. Use .claude/skills in a project folder to share a skill with your team.

From the SKILL.md

# Technical Writing

Writing clear, concise technical documentation that engineers actually read.

## Context

You are writing technical documentation. Be clear; use examples; keep it current.

## Domain Context

- **README**: Quick start, installation, basic usage
- **Architecture**: Design decisions, component interactions, diagrams
- **API Docs**: Endpoints, parameters, examples, errors
- **Runbooks**: Step-by-step incident response; for panicked engineer
- **ADR**: Architecture Decision Record; why we chose this technology

## Instructions

1. **Know Your Audience**: Are they users? Operators? Developers?
2. **Start with Purpose**: Why are you writing this?
3. **Use Examples**: Real examples beat abstract explanation
4. **Be Concrete**: "Use HTTPS" not "ensure secure communication"
5. **Structure Clearly**: Headings, lists, code blocks
6. **Diagrams**: ASCII diagrams or images; visual helps
7. **Keep Current**: Outdated docs are worse than no docs

## Anti-Patterns

- Overly formal language; engineers are busy
- No examples; "see code" isn't helpful
- Out-of-date docs; misinformation is harmful
- Too long; nobody reads walls of text; be concise
- No table of contents; hard to navigate

## Further Reading

- Google Technical Writing Course
- The Pragmatic Programmer, Chapter on Documentation
- Diátaxis documentation framework (Procida)
Read the full skill on GitHub

Details

Skill name
technical-writing
Path
engineer/engineer-toolkit/skills/technical-writing/SKILL.md
License
MIT
Repo updated
11 March 2026

FAQ

What does the Technical Writing skill do?

Clear technical documentation, API docs, architecture decision records, and runbooks.

How do I install the Technical Writing skill?

Claude Code plugin: /plugin marketplace add sethdford/claude-skills. Skills go in ~/.claude/skills (personal) or .claude/skills (project), and Claude loads them automatically when a task matches the description.

Is Technical Writing popular?

It lives in sethdford/claude-skills, which has 48 GitHub stars and 10 forks.

Related skills

A B Test Design

48

sethdford/claude-skills

Design rigorous A/B tests with hypotheses, variants, metrics, and sample size calculations.

Testing & QA10

A B Test Design Pm

48

sethdford/claude-skills

Analytics and experimentation skill for product managers.

Testing & QA10

Abuse Case Design

48

sethdford/claude-skills

Design abuse cases (negative use cases) showing how attackers misuse system features. Use when identifying attacks that exploit intended functionality or business logic flaws.

Security10

Avoid AI Writing

38

jeremybrasher/grokbot-skills

Audit and rewrite content to remove AI writing patterns ("AI-isms"). Use this skill when asked to "remove AI-isms," "clean up AI writing," "edit writing for AI patterns," "audit writing for AI tells," or "make this sound less like AI." Observe the text first. Do not use it to decide authorship, hiring, academic integrity, or attribution from the flags. Supports a detect-only mode, an edit-in-place mode for files, an optional voice profile (casual / professional / technical / warm / blunt), and an iterate-to-convergence pass.

Writing & Content11

Postmortem Analysis

48

sethdford/claude-skills

Writing comprehensive postmortems: timeline, root cause, prevention, action items.

Writing & Content10

Content Planner

38

jeremybrasher/grokbot-skills

GSC-driven content calendar. Pulls real Search Console data, finds the highest click-potential opportunities (striking-distance queries at positions 5-20, unanswered query intent, related-keyword expansions), and produces a dated, prioritized content calendar — ready to hand to /content-writer. Use when the user asks "plan my content", "what should I write next", "content calendar", "content plan", "content roadmap", "editorial calendar", "what topics will rank", "find quick-win SEO topics", "click-potential analysis", or "schedule my SEO content".

Writing & Content11

Browse the most popular Claude skills, all writing & content skills, or write your own with the skills generator.