technical-writing

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

Updated Jul 29, 2026
One-click install
npx skills add https://github.com/mmdmcy/fluttAIrbar --skill technical-writing-mmdmcy
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: technical-writing
Source: https://github.com/mmdmcy/fluttAIrbar/tree/main/plugins/pstack/skills/technical-writing
Command: npx skills add https://github.com/mmdmcy/fluttAIrbar --skill technical-writing-mmdmcy

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Technical docs often fail readers because they mix document types, bury instructions in passive voice, and leave sentences open to multiple readings. This Skill gives writers and reviewers a single layered standard so docs, RFCs, readmes, PR descriptions, and commit messages are understood on the first read. ## Core Features & Use Cases - Four-layer writing standard: Pick the right Diátaxis mode (tutorial, how-to, reference, explanation), write reader-focused sentences per Google developer style, load one idea per sentence per STE rules, and eliminate ambiguity per Global English guidelines. - Review checklist: An 8-point checklist covering mode purity, command-style instructions, sentence splitting, word economy, pronoun clarity, consistent naming, plain vocabulary, and factual accuracy of symbols and counts. - Use Case: When reviewing a README that says "Configuration of the ratchet budget parameters is performed via budget.json", apply the skill to rewrite it as "budget.mjs reads the committed budget from budget.json", fixing passive voice, jargon, and noun strings in one pass. ## Quick Start Use $technical-writing to review and rewrite this documentation file so it follows the layered technical-writing standard.

Frequently Asked Questions about technical-writing

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

FAQPage Schema
How do I choose between a tutorial, how-to, reference, and explanation document?▼

Use the Diátaxis compass with two questions: does the content inform action or understanding, and does it serve learning or work. Action plus learning is a tutorial, action plus work is a how-to, understanding plus work is reference, and understanding plus learning is explanation.

How do I write better technical documentation for developers?▼

Apply four layers: pick one Diátaxis mode per document, address the reader as "you" in present tense with active voice, keep one instruction or thought per sentence, and remove any wording that allows two readings. Cut every word that does no work.

What is the difference between Google developer style and STE rules?▼

Google developer style governs how sentences address the reader: second person, present tense, active voice, and conditions before instructions. STE rules govern sentence load: one instruction per sentence, roughly 20-word limits for procedures, and consistent word meanings.

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

Yes. Every layer except Diátaxis applies to PR descriptions and commit messages, since they are not standalone documents. Product UI strings are excluded and should follow the product's own copy guidelines instead.

When should I not follow a writing rule?▼

When a rule makes a sentence worse, fix the sentence another way or leave it alone. The rules serve the reader, so a sentence that follows every rule but reads like machine output has failed its purpose.