12-documentation-standards

12-documentation-standards is a cursor rule for Cursor from sfc-gh-cconner/support-rules-mcp. It costs 1,688 tokens per session, scanned A, original, Apache-2.0.

A set of rules for writing and maintaining technical documentation, including READMEs, code comments, usage examples, setup instructions, and troubleshooting notes.

In plain words
What is it for?
Use it when creating README files, documenting rules and technical decisions, adding public-function docstrings, or recording common mistakes and solutions.
Why use it?
It gives developers a consistent structure so others can understand, install, use, and fix each component.

Cursor rule for Cursor

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

Good fit Use it when creating README files, documenting rules and technical decisions, adding public-function docstrings, or recording common mistakes and solutions.

Compare 6 cursor rules from other repositories ↓
Install with agentmods
npx agentmods add rules/sfc-gh-cconner/support-rules-mcp/12-documentation-standards
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/sfc-gh-cconner/support-rules-mcp

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 12-documentation-standards

README.md
[![agentmods](https://agentmods.dev/badge/rules/sfc-gh-cconner/support-rules-mcp/12-documentation-standards.svg)](https://agentmods.dev/rules/sfc-gh-cconner/support-rules-mcp/12-documentation-standards)
Your own site
<a href="https://agentmods.dev/rules/sfc-gh-cconner/support-rules-mcp/12-documentation-standards"><img src="https://agentmods.dev/badge/rules/sfc-gh-cconner/support-rules-mcp/12-documentation-standards.svg" alt="Measured on agentmods" height="20"></a>
Per session 1,688 This file is loaded in full into every session.
When invoked 1,688 The same file — it is already loaded in full.
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.01688 $0.01688
Opus 5 $0.00844 $0.00844
Sonnet 5 $0.00338 $0.00338
Haiku 4.5 $0.00169 $0.00169

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

Security

Grade A, and why

12-documentation-standards 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 7d 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.

rules/core/12-documentation-standards.mdc · 282 lines

How it starts

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

Documentation Standards

PURPOSE: Documentation requirements and knowledge management best practices.

📚 Documentation Requirements

Mandatory Documentation

  • README files must include purpose, usage examples, and troubleshooting
  • Rules should have clear PURPOSE statements and examples
  • Code should have docstrings for public functions
  • Technical decisions should be documented

README Structure

Every component should include a comprehensive README with:

# Component Name

## Purpose
Brief description of what this component does

## Usage
Basic usage examples with code snippets

## Installation/Setup
Step-by-step setup instructions

## Configuration
Configuration options and environment variables

## Examples
Practical usage examples

## Troubleshooting
Common issues and their solutions

## Related Rules
Links to relevant rules or documentation

📝 Rule Documentation Standards

Rule File Structure

# Rule Title

**PURPOSE**: One-sentence description of when to use this rule

## Core Concept
High-level explanation of the rule's purpose

## Key Patterns
Main patterns or practices

## Examples
Concrete examples with code

## Common Mistakes
Anti-patterns to avoid

## Related Rules
Cross-references to other rules

PURPOSE Statement

Every rule must start with a clear PURPOSE:

  • **PURPOSE**: When to use this rule and what it provides
  • Be specific and actionable
  • Focus on the user's goal

Examples in Rules

  • Include working code examples
  • Use realistic scenarios
  • Show both correct and incorrect patterns
  • Test examples before committing

📖 Knowledge Management

Rule Organization

  • Core Rules: Fundamental patterns used across all work
  • Connector Rules: Specific to individual drivers/connectors
  • SPCS Rules: Snowpark Container Services specific
  • Workflow Rules: End-to-end processes and standards
  • Meta Rules: Complete workflows that include multiple rules

Cross-References

## Related Rules
- **GitHub MCP Integration**: See `01-github-mcp.mdc`
- **DPO Mappings**: See `04-dpo-mappings.mdc`
- **Snowflake CLI**: See `06-snowflake-cli.mdc`

Read the full file on GitHub · 282 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. 7d ago First seen · 282 lines · 1,688 tokens per session scan A 9f475e655a68

Subscribe to this mod's changes

12-documentation-standards is a cursor rule published in the GitHub repository sfc-gh-cconner/support-rules-mcp (0 stars, last pushed 11mo ago), licensed Apache-2.0. It adds 1,688 tokens to every session, about $0.0084 per session on Opus 5. 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.