frappe/skills

technical-writing

Write prose in "Simplified Technical English". This applies to documentation, READMEs, commits, pull request, plans and release notes. It does not apply to code, identifiers, marketing copy, essays, or anything that needs a voice.

Trending #7294 First seen Jul 28, 2026

Installation

$ npx skills add frappe/skills --skill technical-writing

Similar popular skills

Related neighbors and high-traction skills in the same topics — useful to compare before installing.

Also in this package

Other skills from frappe/skills.

npx skills add frappe/skills

Browse all from frappe/skills

More details

Agent compatibility

Declared targets from SKILL.md / docs. Unmarked agents are not listed — the skill may still install via the CLI.

Claude Code Not declared
Cursor Not declared
Codex Not declared
GitHub Copilot Not declared
Windsurf Not declared
Gemini CLI Not declared
Cline Not declared
OpenCode Not declared

Repository health

Stars 116
Default branch main
Open issues 4
Status Active

Package contents

Files included with this skill beyond the listing page.

  • skill md SKILL.md 1,746 B
  • docs SUMMARY.md 1,718 B

History

  1. First seen on skills.sh
  2. First recorded snapshot · 217 installs

SKILL.md

Rules

WORDS

  • Use one name for one thing. Do not call the same item by two different names.
  • Use the short common word: start (not begin/commence/initiate), use (not utilize/leverage), help (not facilitate), make sure (not ensure), before (not prior to), after (not subsequent to), about (not regarding/concerning), get (not obtain/acquire), show (not demonstrate), also (not additionally/furthermore/moreover).
  • Give each word one meaning. "fall" means to move down, not to decrease.
  • No marketing adjectives: seamless, robust, powerful, cutting-edge, effortless, world-class, next-generation, revolutionary.
  • American spelling.

VERBS

  • Active voice. "the parser reads the file", not "the file is read by the parser".
  • Use a verb for an action. "analyze the log", not "perform an analysis of the log".
  • No stacked auxiliaries. Not "it is important to note that this may help to improve". Write "this improves X".
  • No "-ing" main verb where a simple tense works.

SENTENCES

  • One instruction per sentence. Max 20 words (instruction), max 25 (descriptive).
  • No contractions. Use articles: a, an, the, this, these.

PUNCTUATION

  • No semicolons. Write two sentences. STE bans the semicolon, not the em dash.

STRUCTURE

  • One topic per paragraph, max six sentences. For steps, use a numbered vertical list, one action per item, imperative form. Put a condition before its command.

Write only the requested text. No preamble, no summary, no closing remarks.