documentation

A set of rules for writing clear technical documentation. It covers tone, accuracy, structure, examples, links, accessibility, and consistent formatting.

In plain words
What is it for?
Use it when writing guides, reference pages, examples, troubleshooting sections, or documentation with images and links. It recommends active, concise language and descriptive link text.
Why use it?
It helps documentation stay factual and understandable for its intended readers. It also discourages vague marketing language and requires limits and existing behavior to be stated honestly.

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/m3au/playwright-bdd-cursor-template/documentation
Clone the repo
git clone --depth 1 https://github.com/m3au/playwright-bdd-cursor-template

Made for: Cursor.

Per session 0 Nothing until a file matches its globs; then the whole rule loads.
When invoked 225 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.00225
Opus 5 $0.00000 $0.00112
Sonnet 5 $0.00000 $0.00045
Haiku 4.5 $0.00000 $0.00022

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

Security

Grade A, and why

documentation 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.mdc · 39 lines

What it actually says

Documentation Standards

Language and Tone

  • A: professional, precise, approachable
  • A: active voice; concise
  • N: subjective descriptors - use measurable terms

Content Quality

  • A: honest, direct, factual; acknowledge limits
  • N: marketing/superlatives/buzzwords
  • A: technically accurate; verify claims; precise terms
  • A: audience-appropriate depth
  • A: document what exists (not future plans)
  • A: descriptive link text (N: "click here", "see this")
  • A: human-centered where relevant; concrete examples

Structure

  • Start with overview and purpose
  • Middle: implementation details and usage
  • End: examples and troubleshooting
  • A: logical flow, consistent terms

Accessibility

  • A: include alt text for images (WCAG requirement)

Consistency

  • A: consistent capitalization and punctuation across list items
  • A: consistent list formatting within same list
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 · 39 lines · 0 tokens per session scan A 9a414017692f

Subscribe to this mod's changes

documentation is a cursor rule published in the GitHub repository m3au/playwright-bdd-cursor-template (2 stars, last pushed 6mo ago), licensed MIT. It costs nothing until one of its globs matches a file; then it loads 225 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-31.