agentleFS
Sign inStart free
EffortlessMetricsEffortlessMetrics/demo-swarm/.claude/skills/docs/SKILL.md

docs

Skill0 starsChanged 9 months agoApache-2.0View on GitHub

Documentation work using the Diataxis framework. Organize documentation into four categories. This repo's own docs/ follows Diataxis. Priority: Preserve existing URLs over clean file organization. When auditing existing docs:

We split this skill into the rules it gives an agent

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

  • 0

    Common

    Most of the 129 edited versions we read keep these.

  • 8

    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:

    Always work when followed exactly

    line 19
  2. Distinctive:

    No explanation of concepts

    line 31
  3. Distinctive:

    Prefer redirects over moves: - add redirect, don't delete

    line 45
  4. Distinctive:

    Update internal links: - when moving, fix all references

    line 46
  5. Distinctive:

    Validate after changes: - run link checker

    line 47
  6. Distinctive:

    When auditing existing docs:

    line 51
  7. Distinctive:

    Does not write code; writes documentation about code

    line 84
  8. Distinctive:

    Never orphan a URL

    line 88

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

Docs Skill

Documentation work using the Diataxis framework.

Diataxis Framework

Organize documentation into four categories. This repo's own docs/ follows Diataxis.

TypePurposeUser Need
TutorialsLearning-oriented"Help me get started"
How-To GuidesTask-oriented"Help me solve a problem"
ReferenceInformation-oriented"Help me find facts"
ExplanationUnderstanding-oriented"Help me understand"

Tutorials

  • Step-by-step lessons for beginners
  • Focus on learning, not accomplishing
  • Always work when followed exactly
  • Location: docs/tutorials/

How-To Guides

  • Recipes for specific tasks
  • Assume basic competence
  • Focus on results, not learning
  • Location: docs/how-to/

Reference

  • Technical descriptions
  • Accurate and complete
  • No explanation of concepts
  • Location: docs/reference/

Explanation

  • Conceptual discussions
  • Why things work the way they do
  • Background and context
  • Location: docs/explanation/

Link Stability Rules

Priority: Preserve existing URLs over clean file organization.

  1. Never break existing links - external references matter
  2. Prefer redirects over moves - add redirect, don't delete
  3. Update internal links - when moving, fix all references
  4. Validate after changes - run link checker

Documentation Audit

When auditing existing docs:

| File | Current Category | Suggested Category | Links In | Links Out |
|------|------------------|-------------------|----------|-----------|

Workflow

  1. Audit - Map existing docs to Diataxis categories
  2. Plan - Identify moves needed, redirect strategy
  3. Execute - One file at a time, validate links after each
  4. Verify - Full link check, manual spot check

Output Format

## Documentation Change

### Files Modified
| File | Action | Category |
|------|--------|----------|

### Redirects Added
| Old Path | New Path |

### Link Validation
- Internal links: ✓/✗
- External links: ✓/✗
- Broken links found: <count>

Rules

  • Does not write code; writes documentation about code
  • Link stability over file organization
  • One category per document
  • Cross-reference between categories
  • Never orphan a URL

Download now (ZIP)

  • Other versions160 projects use a version of this.

    Word for word · 0

    None found.

    Edited · 0

    None found.

    Wrote their own version · 160

    1. remotion-dev/remotion★ 70ksame name
    2. jlowin/fastmcp★ 28ksame name
    3. PrefectHQ/fastmcp★ 28ksame name
    4. ryoppippi/ccusage★ 19ksame name
    5. ccusage/ccusage★ 19ksame name
    6. micronaut-projects/micronaut-core★ 6.4ksame name
    7. latitude-dev/latitude-llm★ 4.7ksame name
    8. samuelgursky/davinci-resolve-mcp★ 3.9ksame name
    9. TanStack/ai★ 3.3ksame name
    10. patrykandpatrick/vico★ 3.2ksame name

    150 more not listed

    How matches are found. Word for word: the exact same text. Edited: shares passages with this file (“99% same” means 99% of its five-word phrases also appear here; 10% or more counts). Their own version: similar meaning, or, weakest, the same name. We can’t tell which project had it first. Projects are counted among the 200 most-starred candidates, and mentions are links to the repository we found, up to 50 per site, so both counts are a floor.

  • Used alongsideProjects with it also use build-fix, work and 7 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.
    • diego-tobalinaSkill

      build-fix

      Fix build and compilation errors systematically. Run when build fails.

      Also in 3 projects that use this

    • vbrevikSkill

      work

      Use when the user says 'plan', 'todo', 'copy plan', 'append plan', 'resume plan', 'priorities', or 'what's next'.

      Also in 8 projects that use this

    • MicrosoftSkill

      perf

      Speed and memory performance rules for Rust crates, the Node addon, webui-framework, and webui-router.

      Also in 3 projects that use this

    • AWSSkill

      issue

      Implement a GitHub issue end-to-end — branch, code, test, docs, and commit.

      Also in 5 projects that use this

    • Microsoft AzureSkill

      test

      Also in 12 projects that use this

    • synaptiaiSkill

      gate

      Create a BDSK review_gate artifact. Defines a checkpoint that controls whether generated output may proceed toward acceptance. Use when defining quality, security, or scope gates for execution plans.

      Also in 3 projects that use this

  • In this repository21 other files it gives its agents.

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