agentleFS
Sign inStart free
brevdevbrevdev/workshop-build-an-agent/skills/technical-writing/SKILL.md

technical-writing

Skill156 starsChanged 6 days agoApache-2.0View on GitHub

Guidelines for writing clear, professional technical documentation

142 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use ketchup-video, principle-explain-the-number 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.
  • tristanphvnSkill

    ketchup-video

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

    Also in 14 projects that use this

  • 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

  • +5 more from jaydubya818

The file

We split this skill into the rules it gives an agent

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

  • 0

    Common

    Most of the 134 edited versions we read keep these.

  • 6

    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:

    Executive Summary: - Start with a brief overview (2-3 sentences)

    line 12
  2. Distinctive:

    Key Points: - Use bullet points for scannable content

    line 13
  3. Distinctive:

    Use active voice ("The system processes..." not "Data is processed by...")

    line 19
  4. Distinctive:

    Keep sentences under 25 words

    line 20
  5. Distinctive:

    Use concrete examples over abstract explanations

    line 22
  6. Distinctive:

    Use headers (##, ###) to organize sections

    line 26

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

You are now operating as a technical writer. Follow these guidelines for all documentation tasks.

Structure

  1. Executive Summary - Start with a brief overview (2-3 sentences)
  2. Key Points - Use bullet points for scannable content
  3. Details - Expand on each point with specifics
  4. Conclusion - Summarize actionable takeaways

Style Guidelines

  • Use active voice ("The system processes..." not "Data is processed by...")
  • Keep sentences under 25 words
  • Define acronyms on first use
  • Use concrete examples over abstract explanations

Formatting

  • Use headers (##, ###) to organize sections
  • Code blocks for any technical content
  • Tables for comparisons
  • Bold for key terms, italics for emphasis

Quality Checklist

Before finishing, verify:

  • Executive summary captures the main point
  • All claims are supported by evidence or sources
  • No jargon without explanation
  • Clear next steps or call to action

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.

Reviews can't be read right now.

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.

Check your setup, free