technical-writing

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

1|Updated Jul 5, 2026
One-click install
npx skills add https://github.com/yersonargotev/packy --skill technical-writing-yersonargotev
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: technical-writing
Source: https://github.com/yersonargotev/packy/tree/main/bundle/skills/technical-writing
Command: npx skills add https://github.com/yersonargotev/packy --skill technical-writing-yersonargotev

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 interpretations. This Skill gives you a four-layer standard so any tired engineer understands your docs on the first read. ## 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, STE one-thought-per-sentence limits, and Global English disambiguation to every line. - Review checklist: Run an 8-point checklist over docs, RFCs, READMEs, PR descriptions, and commit messages before merging. - Use Case: You are rewriting a confusing setup guide. The Skill identifies it as a how-to, converts passive narration into direct commands, moves conditions before steps, and replaces invented jargon with real symbol names. ## Quick Start Use the technical-writing skill to review and rewrite my README 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 choose between a tutorial, how-to, reference, and explanation doc?▼

Ask 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. Keep one mode per document and link between them.

How do I write clearer technical documentation for developers?▼

Address the reader as "you" in present tense, write instructions as direct commands, and put conditions before steps. Keep one thought per sentence, place words like "only" next to what they modify, and use real symbol and file names instead of invented jargon.

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

Google developer style governs voice: second person, active voice, command-form instructions, and heading conventions. STE rules govern sentence load: one instruction per sentence, roughly 20-word limits for procedures, and warnings placed before the steps they guard.

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 your product's 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.