technical-writing

Write and review developer documentation using plain English and structured document modes.

2|Updated May 14, 2026
One-click install
npx skills add https://github.com/AnthonyPoschen/agent-skills --skill technical-writing-anthonyposchen
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: technical-writing
Source: https://github.com/AnthonyPoschen/agent-skills/tree/main/skills/technical-writing
Command: npx skills add https://github.com/AnthonyPoschen/agent-skills --skill technical-writing-anthonyposchen

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Documentation, READMEs, RFCs, and PR descriptions often end up wordy, ambiguous, or inconsistent, forcing readers to reread sentences to extract meaning. This Skill applies concrete plain-English rules and document structure patterns so developers and maintainers understand the text on the first read. ## Core Features & Use Cases - Plain English Rules: Cut filler words, use real symbol and path names, keep one name per concept, and prefer short ordinary words over jargon. - Four Document Modes: Choose between tutorial, how-to guide, reference, and explanation modes (based on Diátaxis) so each document has one clear purpose. - Sentence and Structure Guidance: Write active-voice instructions, organize headings for scanning, and format lists, links, and code spans consistently. - Review Checklist: Verify mode clarity, consistent naming, current paths and commands, and scannable headings before finishing. - Use Case: When drafting a README for a new CLI tool, apply the how-to guide mode with command-style instructions and real flag names so users can complete setup without guessing. ## Quick Start Use the technical-writing skill to review and rewrite my README.md so it follows plain English rules and a single clear document mode.

Frequently Asked Questions about technical-writing

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I write clearer developer documentation?▼

Cut words that do no work, use short ordinary words, and write the real symbol, path, or command instead of vague descriptions. Address the reader as "you", use active voice, and give each sentence one main thought.

What is the difference between a tutorial and a how-to guide?▼

A tutorial teaches a newcomer by guiding them through a visible result, while a how-to guide helps a capable reader complete one specific task. Pick one mode per document and split documents when their purposes conflict.

What documentation style guides does this follow?▼

The rules draw from the Diátaxis documentation framework, the Google developer documentation style guide, and pstack's technical writing skill. They cover plain English, sentence structure, document modes, and scanning-friendly organization.

Can I use this for product UI copy or marketing text?▼

No, this skill explicitly excludes product UI text, which should follow the product's own copy rules. It targets developer-facing documentation such as READMEs, RFCs, PR descriptions, and commit messages.

How do I review documentation before publishing?▼

Run the seven-point checklist: confirm one clear mode, one actor per instruction, one thought per sentence, consistent naming, ordinary words with real symbols, verifiable paths and commands, and scannable headings.