technical-writing

Applies Diátaxis, Google style, STE, and Global English rules to technical documentation.

3|2|Updated Aug 28, 2026
One-click install
npx skills add https://github.com/adjohn/pstack --skill technical-writing-adjohn
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: technical-writing
Source: https://github.com/adjohn/pstack/tree/main/skills/technical-writing
Command: npx skills add https://github.com/adjohn/pstack --skill technical-writing-adjohn

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Technical docs often fail readers: mixed document types, passive voice, ambiguous sentences, and jargon make them hard to parse on the first read. This Skill gives you a four-layer review standard so docs, RFCs, READMEs, PR descriptions, and commit messages are clear to a tired engineer. ## Core Features & Use Cases - Diátaxis mode selection: Classify each document as tutorial, how-to, reference, or explanation, and keep modes from mixing. - Sentence-level rules: Apply Google developer style (active voice, commands, condition-first), STE limits (one instruction per sentence, ~20-word cap), and Global English disambiguation (pronoun clarity, no slashes, no noun strings). - Review checklist: Run an 8-point checklist covering mode purity, instruction structure, word economy, naming consistency, and factual accuracy of symbols and counts. - Use Case: You draft a README for a CLI tool. The Skill rewrites passive configuration prose into direct commands, breaks up a five-noun string, moves the failure condition before the step, and replaces invented metaphors with real symbol names. ## Quick Start Use the technical-writing skill to review and rewrite my README.md following the four-layer standard.

Frequently Asked Questions about technical-writing

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

FAQPage Schema
How do I structure technical documentation with Diátaxis?▼

Diátaxis splits docs into four modes by two questions: does content serve action or understanding, and learning or work. The result is tutorial, how-to, reference, or explanation. Keep one mode per document and link between them instead of mixing.

How to write clearer instructions in developer docs?▼

Write each instruction as a direct command with its condition in front, such as "To delete the document, click Delete." Keep one instruction per sentence, split sentences over about 20 words, and use active voice with a named actor.

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

A tutorial teaches a beginner by doing, with visible results at every step and a teacher responsible for success. A how-to solves a specific problem for a competent user, skipping teaching and allowing forks like "If you want x, do y."

Does this writing standard apply to PR descriptions and commit messages?▼

Yes. Every layer except Diátaxis applies to PR descriptions and commit messages: cut filler words, use active voice, keep sentences unambiguous, and name real symbols. Product UI strings are excluded and follow product copy guidelines instead.

Why should documentation avoid words like simply and easily?▼

Words like "simply", "easy", and "quickly" in procedures frustrate readers who are stuck; if the task were simple, they would not be reading. Google developer style prohibits them in instructions along with "please" and figurative language.