agentleFS
Sign inStart free
MCamnerMCamner/mq-image-analyze/skills/docs-maintainer/SKILL.md

docs-maintainer

Skill1 starsChanged 22 days agoMITView on GitHub

Use when keeping mq-image-analyze README, docs, examples, CLI docs, MCP docs, schema docs, release docs, or integration docs consistent with code.

3 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

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

  • 0

    Common

    Most of the 3 edited versions we read keep these.

  • 3

    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:

    Keep documentation synchronized with code and tests.

    line 8
  2. Distinctive:

    Document only behavior that exists or is intentionally added in the same change.

    line 67
  3. Distinctive:

    Treat output contracts and safety docs as part of the public API.

    line 68

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

Keep documentation synchronized with code and tests.

Evals

Should trigger

  • "sync the README after a CLI change"
  • "the examples in docs are stale"
  • "update the MCP integration docs"
  • "do documented commands still exist?"

Should not trigger

  • "change CLI behavior" → use cli-maintainer
  • "change the JSON output schema" → use json-contract-maintainer
  • "is it ready to release?" → use release-readiness

Docs Surfaces

  • README.md
  • SKILLS.md
  • docs/architecture.md
  • docs/cli.md
  • docs/json-schema.md
  • docs/mcp-tools.md
  • docs/tool-safety.md
  • docs/model-setup.md
  • docs/integration.md
  • docs/release.md
  • docs/content-policy.md
  • CHANGELOG.md
  • ROADMAP.md

Common Drift

  • Skill status mismatch between SKILLS.md, README, and skill frontmatter.
  • CLI docs missing a new flag or mode.
  • JSON docs missing a new field.
  • MCP tool docs missing a tool argument or safety note.
  • Model setup docs naming an invalid OpenAI/Ollama model.
  • README examples not matching actual command output.

Verification

rg "visual-reasoning|reverse-prompt|screenshot-ui-review" \
  README.md SKILLS.md skills
rg "image-quality-audit" README.md SKILLS.md skills
python -m pytest tests/test_version_consistency.py -q

For broader docs-related changes:

bash scripts/validate.sh

Editing Guidance

Document only behavior that exists or is intentionally added in the same change. Treat output contracts and safety docs as part of the public API.

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.

Check your setup, free