agentleFS
Sign inStart free
saffron-healthsaffron-health/libretto/.agents/skills/technical-writing/SKILL.md

technical-writing

Skill883 starsChanged 3 months agoMITView on GitHub

Guide for writing effective technical documentation, specs, and markdown files. Use when creating or editing specs, documentation, READMEs, AGENTS.md files, or any markdown content in the codebase.

We split this skill into the rules it gives an agent

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

  • 0

    Common

    Most of the 104 edited versions we read keep these.

  • 5

    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:

    Write concise, complete sentences using active voice and present tense.

    line 15
  2. Distinctive:

    Do not use emojis.

    line 19
  3. Distinctive:

    Do not use bold or italics.

    line 20
  4. Distinctive:

    Use headings, lists, and code blocks only when they add clarity.

    line 21
  5. Distinctive:

    Use fenced code blocks with language identifiers.

    line 22
  6. Very specific:

    Always use relative file paths: docs/testing.md, not /Users/name/project/docs/testing.md.

    line 26

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

Audience

Assume readers are at least as smart as you, so do not over-explain. State information once and move on.

Style

Write concise, complete sentences using active voice and present tense. Each paragraph or bullet should express a single idea.

Formatting

  • Do not use emojis.
  • Do not use bold or italics.
  • Use headings, lists, and code blocks only when they add clarity.
  • Use fenced code blocks with language identifiers.

Paths

Always use relative file paths: docs/testing.md, not /Users/name/project/docs/testing.md.

Do Not Repeat

Link to existing resources instead of duplicating content. Reference other docs, web pages, or files rather than restating their information.

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