with-documentation

A set of writing rules for technical answers and documentation.

In plain words
What is it for?
Use it when writing, editing, reviewing, or proposing technical documentation.
Why use it?
It provides consistent guidance for using clear words, short sentences, active voice, and useful structure.

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/zackiles/cursor-config/with-documentation
Clone the repo
git clone --depth 1 https://github.com/zackiles/cursor-config

Made for: Cursor.

Per session 0 Nothing until a file matches its globs; then the whole rule loads.
When invoked 928 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.00928
Opus 5 $0.00000 $0.00464
Sonnet 5 $0.00000 $0.00186
Haiku 4.5 $0.00000 $0.00093

Measured yesterday against content hash 50690b1aa9cb, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

with-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 yesterday.

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.

Origin

Copies of this mod

1 near-identical copy found in the catalogue:

.cursor/rules/global/with-documentation.mdc · 105 lines

How it starts

The opening of the file, as written. The whole thing — 105 lines — stays where its author put it; the contents beside it link to each section on GitHub.

How to Write Documentation

DANGER: You must follow the rules in Style and Prose, and Format and Output when doing the following:

  1. Writing or editing documentation
  2. Responding technically or on a technical topic to the user
  3. Reviewing or proposing changes to documentation

Style and Prose

  • Sentences using the dependency grammar framework instead of phrase structure grammar
  • Sentences should be brief and action-oriented
  • Sentence-style capitalization and serial commas consistently
  • Subject-verb-object order for clarity and rhythm
  • Clear and active constructions
  • Verbs instead of nominalized nouns
  • Specific nouns and clear referents to eliminate ambiguity
  • Plain language or clearly explains necessary jargon
  • Consistent grammatical structure across headings, instructions, and examples
  • Parallel structure in lists to improve scanability and comprehension
  • Words connected in close proximity to each other improve comprehension
  • Concise language, active voice, and consistent structure
  • Second person ("you") to address readers
  • Imperative verbs for clear instructions
  • Place conditions before actions
  • Numbered lists for sequential steps
  • Bullet lists for non-sequential items
  • Instructions are task-oriented and start with verbs, such as "Click," "Select," or "Enter."
  • Descriptive and informative link text rather than generic terms like "click here" or "more information."
  • Consistent and precise terminology
  • Prefer familiar terms over ambiguous or novel ones
  • Define new or complex terms when first used
  • Introduce abbreviations and acronyms before using them
  • Use abbreviations consistently and sparingly
  • Keep spelling, capitalization, and hyphenation uniform
  • Format code and commands in monospace
  • Keep code lines under 80 characters
  • Show user input, system output, and examples clearly
  • Use sentence case for headings
  • Use clear subheadings and indent lists properly
  • Break steps into short, clear actions
  • Use tested, realistic technical examples
  • Most important information at the beginning of each sentence

Read the full file on GitHub · 105 lines

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. yesterday First seen · 105 lines · 0 tokens per session scan A 50690b1aa9cb

Subscribe to this mod's changes

with-documentation is a cursor rule published in the GitHub repository zackiles/cursor-config (17 stars, last pushed 1y ago), licensed MIT. It costs nothing until one of its globs matches a file; then it loads 928 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.