写文档

Guidance for writing project and code documentation, including README files, code comments, API references, and migration instructions. A README explains how a project is used, while API documentation explains how other code can call it.

In plain words
What is it for?
Use it to structure README files, decide when comments are needed, document APIs, and describe upgrade or migration steps.
Why use it?
It helps keep documentation useful, consistent, and available when users or maintainers need it.

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/bamboogap/skills-orchestrator/documentation
Clone the repo
git clone --depth 1 https://github.com/BambooGap/skills-orchestrator

Made for: Cursor.

Per session 0 Nothing until a file matches its globs; then the whole rule loads.
When invoked 95 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.00095
Opus 5 $0.00000 $0.00048
Sonnet 5 $0.00000 $0.00019
Haiku 4.5 $0.00000 $0.00010

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

Security

Grade A, and why

写文档 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 3d 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 · 13 lines

What it actually says

写文档

README 规范、代码注释时机、API 文档格式、迁移文档模板

如需完整内容,请使用 skills-orchestrator sync --full 导出

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. 3d ago First seen · 13 lines · 0 tokens per session scan A 92b7c2c5686c

Subscribe to this mod's changes

写文档 is a cursor rule published in the GitHub repository BambooGap/skills-orchestrator (4 stars, last pushed 6d ago), licensed MIT. It costs nothing until one of its globs matches a file; then it loads 95 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.