agentleFS
ScrapybaraScrapybara/agent-skills/skills/technical-writing/SKILL.md

technical-writing

Skill0 starsChanged 54 days agoMITView on GitHub

Writes or rewrites any prose (specs, docs, PR descriptions, replies, commit messages) with one Diátaxis mode per section, then applies Google developer style, ISO 24495-1 plain language, ASD-STE100 sentence limits, and Global English disambiguation. Describes the final state only, never the path to it. Use when someone asks to make text clearer, to rewrite a document, or whenever a document or reply must be clear on the first read.

155 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use setup-pstack, ketchup-video and 10 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.
  • 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 31 projects that use this

  • shiwenbin1617Skill

    ketchup-video

    Catch the user up like /ketchup, with a short subtitled video of slides for what happened and the waiting calls as text under it. Use for /ketchup-video.

    Also in 19 projects that use this

  • shiwenbin1617Skill

    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 17 projects that use this

  • jaydubya818Skill

    poteto-mode

    Use when non-trivial work should follow the smallest rigorous Jstack workflow.

    Also in 36 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 23 projects that use this

  • jaydubya818Skill

    principle-migrate-callers-then-delete-legacy-apis

    Apply when replacing an internal API without leaving ambiguous dual paths.

    Also in 47 projects that use this

  • +1 more from shiwenbin1617
  • +5 more from jaydubya818

The file

Show its rules and text

We split this skill into the rules it gives an agent

19 rules. 0 are common, 19 are distinctive, and 0 are very specific to this project.

  • 0

    Common

    Most of the 148 edited versions we read keep these.

  • 19

    Distinctive

    This author's own choices. Worth a look.

  • 0

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Write text that a tired engineer understands on the first read.

    line 17
  2. Distinctive:

    Use active voice with a named actor: "the worker retries", not "retries are performed".

    line 32
  3. Distinctive:

    Write instructions as commands: "Run the migration." Put the condition before the instruction: "To rebuild the image, run…".

    line 33
  4. Distinctive:

    Put the common case first and the exceptions after.

    line 34
  5. Distinctive:

    Write headings in sentence case, and make each heading carry the point.

    line 35
  6. Distinctive:

    Put code in code font and UI elements in bold.

    line 36
  7. Distinctive:

    Put the reader first: include what they need to act, and nothing else.

    line 40
  8. Distinctive:

    Write so that the reader can understand: use everyday words, the real symbol or file name, and one term per thing across the whole text.

    line 42
  9. Distinctive:

    Write one instruction per sentence.

    line 47
  10. Distinctive:

    Keep instructions under about 20 words.

    line 48
  11. Distinctive:

    Keep articles: "remove the backup file", not "remove backup file".

    line 49
  12. Distinctive:

    Use one word per action, the same way every time: "start", never "start" in one place and "initiate" in another.

    line 50
  13. Distinctive:

    Avoid "-ing" forms where a finite verb works.

    line 51
  14. Distinctive:

    Keep "only" and "not" next to the word they change.

    line 55
  15. Distinctive:

    Use periods, not semicolons.

    line 60
  16. Distinctive:

    Write the thing as it is now.

    line 64
  17. Distinctive:

    Do not layer decisions: no "A, superseded by B", no "previously", no "we tried X".

    line 66
  18. Distinctive:

    Do not refer to who got it wrong or what failed before.

    line 67
  19. Distinctive:

    Do not hedge about the future: no "we will soon", no "for now".

    line 68

“Common” is measured: kept by at least 6 in 10 of the 148 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

Write text that a tired engineer understands on the first read. Follow the five steps in order.

1. Pick one Diátaxis mode per section

Diátaxis is a sorting rule, not a heavy process. Each section answers one kind of question, and the reader can tell which from the first line.

  • Reference: facts for lookup. Describe. State facts, options, limits, and errors with no opinion and no instruction.
  • Explanation: the why. Design decisions, constraints, and alternatives. Opinion lives here and nowhere else.
  • How-to: steps to a goal that a competent reader already has. Action only, no background.

A document is usually one mode throughout: a spec is reference, a design note is explanation, and a runbook is a how-to. A chat reply often needs more than one mode, so give each mode its own section (a heading or a paragraph break) and keep each section pure. The failure to avoid is a paragraph that states a fact, argues for it, and tells the reader what to do in the same breath.

2. Apply Google developer style

  • Address the reader as "you" in the present tense.
  • Use active voice with a named actor: "the worker retries", not "retries are performed".
  • Write instructions as commands: "Run the migration." Put the condition before the instruction: "To rebuild the image, run…".
  • Put the common case first and the exceptions after.
  • Write headings in sentence case, and make each heading carry the point. Use numbered lists for sequences and bullets for parallel facts.
  • Put code in code font and UI elements in bold. Use serial commas. Do not write "simply", "easy", or "click here".

3. Apply ISO 24495-1 plain language

  • Put the reader first: include what they need to act, and nothing else.
  • Organize the text so that the reader can find things: the answer or verdict opens the text, and detail follows.
  • Write so that the reader can understand: use everyday words, the real symbol or file name, and one term per thing across the whole text.
  • Make the text usable: every paragraph or bullet states a claim and its consequence together.

4. Apply STE sentence limits

  • Write one instruction per sentence. Write one thought per sentence everywhere else.
  • Keep instructions under about 20 words. Keep other sentences under about 25 words.
  • Keep articles: "remove the backup file", not "remove backup file".
  • Use one word per action, the same way every time: "start", never "start" in one place and "initiate" in another.
  • Avoid "-ing" forms where a finite verb works.

5. Apply Global English disambiguation

  • Keep "only" and "not" next to the word they change.
  • Break noun strings longer than three words: "the script that checks the import budget", not "the import budget check script".
  • Make every "it", "this", and "they" point at one noun. Repeat the noun when in doubt. Never point "this" at a whole clause.
  • Give every clause its verb. Repeat the article in a series when the items are separate things.
  • Say what "and" or "or" joins when a sentence can group two ways.
  • Use periods, not semicolons. Start a new sentence instead of using an em dash. Do not use slashes, "(s)", idioms, or Latin abbreviations.

Describe the final state, never the path to it

Write the thing as it is now. Do not write the history of how it got there.

  • Do not layer decisions: no "A, superseded by B", no "previously", no "we tried X". Write B.
  • Do not refer to who got it wrong or what failed before. The failure is not part of the final state.
  • Do not hedge about the future: no "we will soon", no "for now".
  • In a spec, do not keep a decision log or a supersession trail. A spec states the design that holds at this commit. If the reader needs the rationale, move it to an explanation document.
  • In a reply, answer the question as it stands. Do not narrate the investigation unless the reader asked for the evidence.

Check before sending

  1. Is each section one mode, with a break where modes meet?
  2. Is every instruction a command with its condition in front?
  3. Does any sentence carry two thoughts? Split it.
  4. Can any word go without a loss of meaning? Cut it.
  5. Does every "only", "it", and "this" attach to one obvious word?
  6. Does each thing have exactly one name throughout?
  7. Does any sentence describe the past instead of the final state? Rewrite it.

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.