agentleFS
Yeachan-HeoYeachan-Heo/oh-my-claude-sisyphus/skills/technical-writing/SKILL.md

technical-writing

Skill41k starsChanged 7 days agoMITView on GitHub

One layered standard for shipping prose — docs, RFCs, readmes, PR descriptions, commit messages: outcome first, one meaning one home, checkable statements, no filler. Composes with minimal-prose-discipline.

142 other projects use a version of this.

Trending

Quiet since January.thin dataabout the whole repository

Dec 2025: 0 mentionsJan 2026: 3 mentionsFeb 2026: 0 mentionsMar 2026: 0 mentionsApr 2026: 0 mentionsMay 2026: 0 mentionsJun 2026: 0 mentionsJul 2026: 0 mentionsAug 2026: 0 mentionsSep 2026: 0 mentionsOct 2026: 0 mentionsNov 2026: 0 mentions
Dec 2025Jun 2026Nov 2026
Mentions a month of the Yeachan-Heo/oh-my-claude-sisyphus repository that our weekly crawl found: only 3 in all, so this is a hint, not a trend. There is no adoption data for this file yet.

Most recently taken up by

Used with

Projects with it also use principle-explain-the-number, make-bot-ui and 9 more.

Other files people use alongside this one.

Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
  • ianclearySkill

    principle-explain-the-number

    Apply before you trust, report, or act on a number you measured: a speedup, a regression, a throughput, a latency, or an eval result. Find what limits it, and rule out that it measured something other than the work you think.

    Also in 29 projects that use this

  • eryzerzSkill

    make-bot-ui

    Use when building a custom UI (page, dashboard, buttons) that should wake a Grok Bot over a webhook, when the user must provide a webhook sender key, or when exposing that UI on Tailscale.

    Also in 20 projects that use this

  • jaydubya818Skill

    principle-attack-the-premise

    Apply when repeated fixes fail and a shared assumption may be wrong.

    Also in 35 projects that use this

  • jaydubya818Skill

    principle-test-behavior-not-implementation

    Apply when tests mirror internals instead of asserting observable outcomes.

    Also in 36 projects that use this

  • ianclearySkill

    poteto-help

    Guides users through pstack setup, /poteto-mode, and picking the skill, playbook, or principle for a task. Type /poteto-help with a question.

    Also in 14 projects that use this

  • bnemaSkill

    setup-pstack

    Configure which Pi models pstack uses per role. Detects available provider/model specs and writes pstack's user configuration. Use for /setup-pstack, "configure pstack models", or changing pstack model choices.

    Also in 24 projects that use this

  • +5 more from jaydubya818

The file

We split this skill into the rules it gives an agent

5 rules. 0 are common, 3 are distinctive, and 2 are very specific to this project.

  • 0

    Common

    Most of the 133 edited versions we read keep these.

  • 3

    Distinctive

    This author's own choices. Worth a look.

  • 2

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Checkable statements: Prefer a statement the reader can verify with a command or a glance over an adjective.

    line 27
  2. Very specific:

    No filler: No restating the obvious, no throat-clearing, no AI tells (ai-slop-cleaner territory.

    line 31
  3. Distinctive:

    Write clean as you draft; a cleanup pass after drafting does not remove these patterns.

    line 47
  4. Distinctive:

    Every claim carries its evidence or its label in the same sentence.

    line 49
  5. Very specific:

    Delete more than you add; the reader's time is the budget (principles skill, Minimize reader load).

    line 50

“Common” is measured: kept by at least 6 in 10 of the 133 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Technical Writing

Prose that ships — docs, RFCs, readmes, PR descriptions, commit messages — follows one standard so readers can navigate any of them the same way.

The standard

  1. Outcome first. The first sentence says what changed for whom and what the reader can now do. Context comes after the reader knows why they care.
  2. One meaning, one home. Each fact lives in exactly one place; every other mention links there. Duplicated facts rot at different speeds.
  3. Checkable statements. Prefer a statement the reader can verify with a command or a glance over an adjective. "Builds in ~40s" beats "fast".
  4. Layered structure. Summary, then detail, then edge cases — each layer readable alone, each deeper layer skippable.
  5. No filler. No restating the obvious, no throat-clearing, no AI tells (ai-slop-cleaner territory; this skill composes with it).

Per surface

  • Commit message: subject says what changed in one line ≤72 chars; body says why, and the constraint that made the change necessary.
  • PR description: claim, evidence (before/after), reversibility — the pr skill owns the full template.
  • README: what it is, who it is for, the shortest working example, then everything else.
  • RFC/design doc: problem, constraints, options considered with why the losers lost (feeds from architect), decision, migration.

Rules

  • Write clean as you draft; a cleanup pass after drafting does not remove these patterns.
  • Every claim carries its evidence or its label in the same sentence.
  • Delete more than you add; the reader's time is the budget (principles skill, Minimize reader load).

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.