810-documentation

810-documentation is a cursor rule for Cursor from d-padmanabhan/agent-engineering-handbook. It costs 0 tokens per session (858 once invoked), scanned A, original, MIT.

A set of rules for planning and writing useful project documentation, including documentation websites and Markdown files.

In plain words
What is it for?
It guides documentation structure, page types, navigation, tutorials, how-to guides, references, and explanations.
Why use it?
It helps readers find the right kind of information and prevents tutorials, task instructions, reference material, and explanations from becoming mixed together.

Cursor rule for Cursor

Written for Cursor: a Cursor rule (.mdc).

Good fit It guides documentation structure, page types, navigation, tutorials, how-to guides, references, and explanations.

Compare 6 cursor rules from other repositories ↓
Install with agentmods
npx agentmods add rules/d-padmanabhan/agent-engineering-handbook/810-documentation
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.

Clone the repo
git clone --depth 1 https://github.com/d-padmanabhan/agent-engineering-handbook

Made for: Cursor.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for 810-documentation

README.md
[![agentmods](https://agentmods.dev/badge/rules/d-padmanabhan/agent-engineering-handbook/810-documentation/github.svg)](https://agentmods.dev/rules/d-padmanabhan/agent-engineering-handbook/810-documentation)
Your own site
<a href="https://agentmods.dev/rules/d-padmanabhan/agent-engineering-handbook/810-documentation"><img src="https://agentmods.dev/badge/rules/d-padmanabhan/agent-engineering-handbook/810-documentation/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

agentmods 80×15 button for 810-documentation

Your own site · 80×15
<a href="https://agentmods.dev/rules/d-padmanabhan/agent-engineering-handbook/810-documentation"><img src="https://agentmods.dev/badge/rules/d-padmanabhan/agent-engineering-handbook/810-documentation.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 0 Nothing until a file matches its globs; then the whole rule loads.
When invoked 858 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.
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.1 $0.00000 $0.00858
Opus 5 $0.00000 $0.00429
Sonnet 5 $0.00000 $0.00172
Haiku 4.5 $0.00000 $0.00086

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

Security

Grade A, and why

810-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.

rules/810-documentation.mdc · 63 lines

How it starts

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

Documentation Engineering Gates

This rule owns mandatory documentation policy only. Use the documentation standards skill (${HANDBOOK_ROOT}/skills/documentation-standards/SKILL.md) for workflows, templates, Docusaurus, ADRs, and technical-writing guidance. Use the Markdown rule (${HANDBOOK_ROOT}/rules/800-markdown.mdc) for Markdown structure, links, alerts, generated PNG diagrams, and accessibility. Use the utilities rule (${HANDBOOK_ROOT}/rules/120-utilities.mdc) for external documentation research and tool selection.

Purpose and Structure

  • Identify the audience, task, prerequisite knowledge, and desired outcome before writing.
  • Give each page one primary Diataxis mode: tutorial, how-to guide, reference, or explanation. Split pages that mix incompatible purposes without a clear reason.
  • Keep navigation and information architecture proportional to the documentation set. Do not add a documentation site, versioning system, search service, or generated portal when a README and a few guides are sufficient.
  • Keep documentation close to its source of truth and assign ownership for content that must remain operationally current.

Correctness and Currency

  • Ground technical claims in current code, configuration, command output, schemas, or authoritative documentation.
  • Verify current vendor terminology, service names, versions, defaults, limits, and compatibility before publishing them. Do not present estimates or unsupported percentages as measured facts.
  • Make examples complete, safe, and runnable as shown. Pin tools and dependencies where reproducibility matters, and update the lockfile when dependencies change.
  • Document prerequisites, failure behavior, validation steps, rollback or recovery when relevant, and the supported version or environment boundary.
  • Remove stale examples and contradictory guidance instead of preserving them for completeness.

Security and Trust Boundaries

  • Treat MDX as executable code. Do not compile untrusted JSX, imports, exports, raw HTML, or plugins in a privileged documentation build.
  • Keep credentials, private incident data, customer data, internal identifiers, and sensitive production configuration out of examples, screenshots, generated images, logs, and build artifacts.
  • Use synthetic acme.com examples and clearly distinguish placeholders from values that can be copied safely.
  • Give documentation builds least privilege, bounded network access, immutable dependency installation, and no production mutation authority unless the workflow explicitly requires and protects it.

Read the full file on GitHub · 63 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 Changed · -567 lines · -13 tokens per session 497f6fa7929a
  2. 5d ago First seen · 630 lines · 13 tokens per session scan A 8cb4e7694517

Subscribe to this mod's changes

810-documentation is a cursor rule published in the GitHub repository d-padmanabhan/agent-engineering-handbook (16 stars, last pushed 2d ago), licensed MIT. It costs nothing until one of its globs matches a file; then it loads 858 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-09-03.