document

Cursor rule "document" from flyeric0212/cursor-history-links, covering 文档规范, 通用要求, 目录结构, readme.md 内容规范 and 版本记录规范.

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/flyeric0212/cursor-history-links/document
Clone the repo
git clone --depth 1 https://github.com/flyeric0212/cursor-history-links

Made for: Cursor.

Per session 0 Nothing until a file matches its globs; then the whole rule loads.
When invoked 350 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.00350
Opus 5 $0.00000 $0.00175
Sonnet 5 $0.00000 $0.00070
Haiku 4.5 $0.00000 $0.00035

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

Security

Grade A, and why

document 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 today.

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/document.mdc · 46 lines

What it actually says

文档规范

通用要求

  • 所有文档使用Markdown格式
  • 使用简洁、清晰的语言
  • 文档内容应保持最新
  • 避免拼写和语法错误
  • 使用中文作为主要语言

目录结构

  • README.md:项目根目录,提供项目概述
  • docs/:存放详细文档
    • guide/:使用指南
    • api/:API文档
    • examples/:示例代码文档

README.md 内容规范

  • 项目名称和简短描述
  • 技术栈说明
  • 项目结构说明
  • 使用说明
  • 许可证信息

版本记录规范

  • 使用 CHANGELOG.md 记录版本变更
  • 遵循语义化版本(Semantic Versioning)规范
  • 每个版本应包含:新增功能、修复问题、破坏性变更

文档内容组织

  • 从整体到局部,从简单到复杂
  • 重要信息放在前面
  • 相关内容应当放在一起
  • 使用小标题和列表增强可读性
  • 避免过长段落,保持内容简洁

代码示例规范

  • 提供完整可运行的示例
  • 代码应当简洁且易于理解
  • 添加适当的注释解释关键部分
  • 说明代码的预期输出或行为
  • 更新示例以匹配最新API
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. today First seen · 46 lines · 350 tokens per session scan A eaf2cc2bb06d

Subscribe to this mod's changes

document is a cursor rule published in the GitHub repository flyeric0212/cursor-history-links (258 stars, last pushed 5d ago), licensed MIT. It costs nothing until one of its globs matches a file; then it loads 350 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-01.