documentation-user-guide

A set of rules for keeping a product's user guide up to date. The guide should explain major features, smaller how-to tasks, terminology, access steps, and user workflows.

In plain words
What is it for?
Use it whenever adding, changing, removing, or integrating user-facing functionality. It guides whether to update a feature section or add a concise task-based instruction.
Why use it?
It prevents documentation from becoming inaccurate after user-facing behavior changes and helps users complete tasks without relying on the developers.

Cursor rule for Cursor

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add rules/romkey/i2c-directory/documentation-user-guide
Clone the repo
git clone --depth 1 https://github.com/romkey/I2C-Directory

Made for: Cursor.

Per session 0 Nothing until a file matches its globs; then the whole rule loads.
When invoked 246 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.00000 $0.00246
Opus 5 $0.00000 $0.00123
Sonnet 5 $0.00000 $0.00049
Haiku 4.5 $0.00000 $0.00025

Measured 2d ago against content hash bdd24d0c14b1, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

documentation-user-guide scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 2d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

.cursor/rules/documentation-user-guide.mdc · 36 lines

What it actually says

User Guide Maintenance

Update docs/USER_GUIDE.md whenever user-facing functionality is added or changed.

Structure

The guide has two types of sections:

Major Feature Sections

Dedicated sections for large functional areas. Each should cover:

  • What the feature does
  • How to access it
  • Key concepts and terminology
  • Step-by-step workflows with screenshots or descriptions

How-To Section

A collection of focused, task-oriented entries for small things users need to do. Each entry should:

  • Have a clear action-oriented title (e.g., "How to link a Ko-fi payment to a member")
  • Be self-contained — a user can follow it without reading other sections
  • Be concise — numbered steps, no unnecessary background

When to Update

  • New feature: Add a major section or how-to entry depending on scope
  • Changed feature: Update the existing section to reflect the new behavior
  • Removed feature: Remove or mark as deprecated
  • New integration: Add a section explaining setup and usage from the user's perspective
Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 2d ago First seen · 36 lines · 0 tokens per session scan A bdd24d0c14b1

Subscribe to this mod's changes

documentation-user-guide is a cursor rule published in the GitHub repository romkey/I2C-Directory (11 stars, last pushed 21d ago), licensed MIT. It costs nothing until one of its globs matches a file; then it loads 246 tokens. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.