skills.rest
Shtian
ShtianCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

technical-writing

Reviews and rewrites technical documentation using Diátaxis, Google style, STE, and Global English rules.

4|1|Updated Dec 16, 2023
Search Tags:#documentation#editing#technical writing#style guide#readme#diataxis#prose review
One-click install
npx skills add https://github.com/Shtian/AuthentiClash --skill technical-writing-shtian
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: technical-writing
Source: https://github.com/Shtian/AuthentiClash/tree/main/.claude/skills/technical-writing
Command: npx skills add https://github.com/Shtian/AuthentiClash --skill technical-writing-shtian

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Technical docs often fail readers: mixed document types, passive voice, ambiguous sentences, and machine-sounding prose. This Skill applies four layered writing standards so engineers understand documentation on the first read. ## Core Features & Use Cases - Diátaxis mode selection: Classifies each document as tutorial, how-to, reference, or explanation and enforces mode purity. - Sentence-level rules: Applies Google developer style, STE instruction rules, and Global English disambiguation to every sentence. - Review checklist: Provides an 8-item checklist covering mode purity, command-form instructions, word economy, and factual accuracy of symbols and counts. - Use Case: You drafted a README or RFC that reviewers call confusing. Run this Skill to rewrite it with one clear mode, direct commands, and unambiguous sentences. ## Quick Start Use the technical-writing skill to review and rewrite my README.md following the Diátaxis and Google developer style rules.

Frequently Asked Questions about technical-writing

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

FAQPage Schema
What is the Google developer documentation style guide?▼

The Google developer style guide requires addressing readers as "you" in present tense, writing instructions as commands, putting conditions before steps, and using sentence-case headings that carry the point. It also bans words like "simply" and "click here" in procedures.

How to write clear step-by-step instructions in docs?▼

Write each instruction as a direct command with one action per sentence, and place the condition before the step: "To delete the document, click Delete." Split instructions longer than about 20 words and keep articles like "the" so sentences parse one way.

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

Yes, every layer except Diátaxis applies to PR descriptions and commit messages. A PR body should read as a briefing a reviewer finishes in under a minute, linking logs and metric tables instead of pasting them.

When should I not mix documentation modes?▼

Never mix modes within one document: no reference tables inside tutorials, no tutorial hand-holding inside reference, and no opinion inside how-tos. Split the content into separate documents and link them where the modes meet.

Related Skills

Explore More Content & Communication Skills→
samcdavidsamcdavid
4

prove-it

Inventory conversation claims and categorize each as verified fact or unverified assumption.

Community
Intermediate
VMAFxVMAFx
3

regen-docs

Rebuild mkdocs-material sites and detect broken links and ADR drift.

Official
Intermediate
JoeyMckenzieJoeyMckenzie
27

stop-slop

Apply Stop Slop guidelines to remove filler phrases, hedges, and passive voice from prose.

Community
Intermediate
elasticelastic
71

docs-check-style

Validate documentation content against the Elastic style guide with Vale.

Official
Intermediate