documentation-best-practices-rules

documentation-best-practices-rules is a cursor rule for Cursor from holtwood/awesome-cursorrules-zh. It costs 0 tokens per session (218 once invoked), scanned A, original, MIT.

Kubernetes documentation rules define how Markdown guides should be organized and maintained. They require clear definitions, complete YAML examples, diagrams, warnings, version details, and change records.

In plain words
What is it for?
They help write Kubernetes guides with headings, contents lists, configuration examples, architecture diagrams, update dates, and migration notes.
Why use it?
They reduce documentation that is difficult to follow, outdated, or incomplete for people deploying applications.

Cursor rule for Cursor

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

Good fit They help write Kubernetes guides with headings, contents lists, configuration examples, architecture diagrams, update dates, and migration notes.

Compare 6 cursor rules from other repositories ↓
Install with agentmods
npx agentmods add rules/holtwood/awesome-cursorrules-zh/documentation-best-practices-rules
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/holtwood/awesome-cursorrules-zh

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 documentation-best-practices-rules

README.md
[![agentmods](https://agentmods.dev/badge/rules/holtwood/awesome-cursorrules-zh/documentation-best-practices-rules/github.svg)](https://agentmods.dev/rules/holtwood/awesome-cursorrules-zh/documentation-best-practices-rules)
Your own site
<a href="https://agentmods.dev/rules/holtwood/awesome-cursorrules-zh/documentation-best-practices-rules"><img src="https://agentmods.dev/badge/rules/holtwood/awesome-cursorrules-zh/documentation-best-practices-rules/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 documentation-best-practices-rules

Your own site · 80×15
<a href="https://agentmods.dev/rules/holtwood/awesome-cursorrules-zh/documentation-best-practices-rules"><img src="https://agentmods.dev/badge/rules/holtwood/awesome-cursorrules-zh/documentation-best-practices-rules.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 218 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.00218
Opus 5 $0.00000 $0.00109
Sonnet 5 $0.00000 $0.00044
Haiku 4.5 $0.00000 $0.00022

Measured 6d ago against content hash fc89e8bf6ece, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-09, from the pricing page.

Security

Grade A, and why

documentation-best-practices-rules 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 6d 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.

docs/rules/devops/kubernetes/kubernetes-mkdocs-documentation/documentation-best-practices-rules.mdc · 21 lines

What it actually says

  • 文档结构
    • 使用H2标题组织主要章节
    • 每个Markdown文件不超过2000字(约5分钟阅读量)
    • 长文档必须包含目录(TOC)
  • 内容规范
    • 每章节开头提供简要概述
    • 技术概念首次出现时需明确定义
    • 配置示例必须包含完整Yaml和注释
  • 格式要求
    • 使用Mermaid/PlantUML生成架构图
    • 重要警告使用> [!WARNING]语法突出
    • 代码块标注语言类型和适用环境
  • 版本管理
    • 文档头部包含最后更新时间
    • 重大变更记录在CHANGELOG中
    • 废弃内容标注替代方案
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. 6d ago First seen · 21 lines · 218 tokens per session scan A fc89e8bf6ece

Subscribe to this mod's changes

documentation-best-practices-rules is a cursor rule published in the GitHub repository holtwood/awesome-cursorrules-zh (233 stars, last pushed 1mo ago), licensed MIT. It costs nothing until one of its globs matches a file; then it loads 218 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.