006-project-documentation

A set of rules for project documentation, including README files, API references, and architecture notes. It explains how to organize documents and record a system's purpose, usage, design decisions, and trade-offs.

In plain words
What is it for?
Use it when writing README files, documenting public APIs with OpenAPI, explaining architecture, or maintaining feature documentation.
Why use it?
Clear documentation helps new developers get started and keeps written guidance aligned with the software.

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/cmnemoi/cursor-rules/006-project-documentation
Clone the repo
git clone --depth 1 https://github.com/cmnemoi/cursor-rules

Made for: Cursor.

Per session 0 Nothing until a file matches its globs; then the whole rule loads.
When invoked 421 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.00421
Opus 5 $0.00000 $0.00211
Sonnet 5 $0.00000 $0.00084
Haiku 4.5 $0.00000 $0.00042

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

Security

Grade A, and why

006-project-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.

emush/.cursor/rules/006-project-documentation.mdc · 68 lines

What it actually says

Project Documentation Standards

1.0.0

Context

  • These rules apply to all project documentation
  • They ensure documentation is clear, complete, and maintainable
  • They promote consistency across all documentation
  • They help new team members onboard efficiently

Requirements

Documentation Structure

  • Organize documentation by domain/feature
  • Use a consistent structure across similar documents
  • Include a table of contents for documents longer than 500 lines
  • Maintain a clear hierarchy with proper heading levels
  • Document the "why" more than the "how"

README Files

  • Each project/module must have a README.md
  • Include purpose, installation, and usage instructions
  • Document environment requirements
  • Provide quick start examples
  • Link to more detailed documentation

API Documentation

  • Document all public APIs using OpenAPI
  • Include parameters, return values, and error responses
  • Provide usage examples
  • Document authentication requirements
  • Keep API documentation in sync with implementation

Architecture Documentation

  • Document system architecture with diagrams
  • Explain key design decisions and trade-offs
  • Document integration points with external systems
  • Keep architecture documentation up-to-date with implementation

User Documentation

  • Write in clear, non-technical language
  • Include step-by-step instructions
  • Provide screenshots for UI-related instructions
  • Organize by user tasks rather than system features
  • Include troubleshooting sections for common issues

Language and Style

  • Write in English
  • Use present tense
  • Use active voice
  • Be concise and specific
  • Define technical terms and acronyms on first use

Critical Rules

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 · 68 lines · 421 tokens per session scan A 3e7ac72f6698

Subscribe to this mod's changes

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