agentleFS
grimoire-rsgrimoire-rs/grimoire/.claude/skills/docs/SKILL.md

docs

Skill15 starsChanged 17 days agoApache-2.0View on GitHub

Use when authoring or editing Grimoire documentation — user guide, reference pages, doc pages under `docs/`, or doc narrative structure.

165 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use import-memory, perf 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.
  • amirbironSkill

    import-memory

    Import a memory export from another AI assistant into Claude's memory — conversationally, additively, and with the content treated as data.

    Also in 3 projects that use this

  • MicrosoftSkill

    perf

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

    Also in 4 projects that use this

  • diego-tobalinaSkill

    build-fix

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

    Also in 3 projects that use this

  • JkudjoSkill

    incident

    Production incident response — structured triage, hypothesis tree, safe remediation, incident record

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

  • mbwsimsSkill

    impact

    This skill should be used when the user asks to "check the impact", "what will break if I change this", "blast radius", "impact analysis", "what depends on this", "who imports this", "is it safe to change this", mentions "/impact", or wants to understand the consequences of modifying a specific file or function before making changes.

    Also in 3 projects that use this

The file

We split this skill into the rules it gives an agent

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

  • 0

    Common

    Most of the 129 edited versions we read keep these.

  • 2

    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:

    NEVER inline links — reference-style only

    line 39
  2. Distinctive:

    ALWAYS read source before documenting.

    line 40

“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

Grimoire Documentation

Role: write user-facing docs for Grimoire (Markdown under docs/).

Workflow

  1. Read source code — no memory docs
  2. Read product context — .claude/rules/product-context.md before user-facing writing
  3. Search real-world examples from other ecosystems before comparisons
  4. Identify problem feature solves before solution
  5. Draft narratively — idea → problem → solution → depth
  6. Verify internal links point to existing sections with content

Narrative Standards

  • Idea → problem → solution, then depth — never start "Grimoire is a..."
  • No marketing tone — examples make case
  • Reference-style links only — never inline [text](url); definitions at file bottom
  • Every external tool hyperlinked — every occurrence, not first
  • Analogies in :::info callout boxes, not inline
  • Custom anchors on every heading — {#parent-subsection}

Relevant Rules (load explicitly for planning)

  • .claude/rules/docs-style.md — narrative + linking + anchor conventions
  • .claude/rules/product-context.md — positioning and product identity

Tool Preferences

  • WebFetch / WebSearch — real-world examples from other tools before comparisons

Constraints

  • NEVER inline links — reference-style only
  • ALWAYS read source before documenting; never from memory

Handoff

  • To /hex-architect — docs revealing design ambiguity
  • To Builder — code changes uncovered while writing docs

$ARGUMENTS

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.