agentleFS
hugobatistahugobatista/agent-skills/skills/docs/ste100/SKILL.md

ste100

Skill1 starsChanged 55 days agoMITView on GitHub

Use when writing or editing technical documentation (manuals, procedures, work instructions, warnings, cautions, notes, maintenance guides, user guides). Applies ASD-STE100 Simplified Technical English Issue 9 rules.

10 other projects use a version of this.

Adopted by

Most recently taken up by

The file

We split this skill into the rules it gives an agent

2 rules. 0 are common, 1 is distinctive, and 1 is very specific to this project.

  • 0

    Common

    Most of the 10 edited versions we read keep these.

  • 1

    Distinctive

    This author's own choices. Worth a look.

  • 1

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Use approved words only (start ✓, begin/commence ✗).

    line 22
  2. Very specific:

    Articles: Use a/an/the consistently.

    line 26

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

Apply ASD-STE100 Simplified Technical English Issue 9 rules to technical documentation.

Scope: manuals, procedures, work instructions, warnings, cautions, notes, maintenance guides, user guides. For Markdown formatting, load markdown-style as well.

Rules

  • Classify text type: Procedural = step-by-step commands in imperative mood. Descriptive = explanations in present tense, active voice.
  • Sentences: Max 20 words (procedural) / 25 words (descriptive). One topic per sentence.
  • Voice: Active only. Exception: passive allowed in descriptive writing when the receiver of the action is the topic.
  • Verb forms: Imperative for procedures. Present tense for descriptions. No "-ing" forms unless part of an approved noun.
  • Vocabulary: Each word has one meaning, one part of speech. No synonyms. Use approved words only (start ✓, begin/commence ✗). Define technical jargon on first use.
  • Noun clusters: Max 3 nouns in sequence. "API rate limit" ✓, "User authentication token validator" ✗ → "Token validator for user authentication"
  • Articles: Use a/an/the consistently. Do not omit.
  • Lists: Each procedural step is one action in imperative mood.

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.