how-to-documentation-cursorrules-prompt-file

how-to-documentation-cursorrules-prompt-file is a cursor rule for coding agents from PatrickJS/awesome-cursorrules. It costs 0 tokens per session (986 once invoked), scanned A, original, CC0-1.0.

A set of Cursor rules for writing step-by-step software guides for people who may not be technical.

In plain words
What is it for?
Use it to create how-to articles with clear titles, numbered actions, expected results, troubleshooting, and platform notes.
Why use it?
It helps turn technical details, tests, and screenshots into instructions that are easier to follow and verify.

Cursor rule

About the project

PatrickJS/awesome-cursorrules is a collection of Markdown rule files that give Cursor AI editor project-specific instructions about code, frameworks, workflows, and standards. Developers use it to find reusable guidance for shaping Cursor’s behavior in different kinds of software projects.

PatrickJS/awesome-cursorrules · 40,722 stars · on GitHub

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/patrickjs/awesome-cursorrules/how-to-documentation-cursorrules-prompt-file
Clone the repo
git clone --depth 1 https://github.com/PatrickJS/awesome-cursorrules

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 how-to-documentation-cursorrules-prompt-file

README.md
[![agentmods](https://agentmods.dev/badge/rules/patrickjs/awesome-cursorrules/how-to-documentation-cursorrules-prompt-file.svg)](https://agentmods.dev/rules/patrickjs/awesome-cursorrules/how-to-documentation-cursorrules-prompt-file)
Your own site
<a href="https://agentmods.dev/rules/patrickjs/awesome-cursorrules/how-to-documentation-cursorrules-prompt-file"><img src="https://agentmods.dev/badge/rules/patrickjs/awesome-cursorrules/how-to-documentation-cursorrules-prompt-file.svg" alt="Measured on agentmods" height="20"></a>
Per session 0 Nothing until a file matches its globs; then the whole rule loads.
When invoked 986 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.00986
Opus 5 $0.00000 $0.00493
Sonnet 5 $0.00000 $0.00197
Haiku 4.5 $0.00000 $0.00099

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

Security

Grade A, and why

how-to-documentation-cursorrules-prompt-file 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.

rules/how-to-documentation-cursorrules-prompt-file.mdc · 119 lines

How it starts

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

Persona

You are an expert technical writer tasked with creating "How To" documentation for software features to help non-technical users understand how to use them.

Documentation Focus

Create clear, step-by-step instructions that non-technical users can follow Convert technical information, test scripts, or screenshots into user-friendly guides Use simple language and avoid technical jargon Focus on user actions and expected outcomes for specific features

Best Practices

1 Clear Title: Use action-oriented titles like "How To Log In" or "How To Export Reports" 2 Brief Introduction: Begin with a short explanation of the feature's purpose and value 3 Numbered Steps: Present instructions as numbered steps in a logical sequence 4 Visual Cues: Reference UI elements as they appear to users (buttons, fields, menus) 5 Expected Results: Clearly describe what users should see after each action 6 Troubleshooting Tips: Include common issues and their solutions 7 Related Features: Mention related features or next steps when appropriate 8 Platform Compatibility: Note any differences between devices or platforms

Document Format

The document should follow this structure:

  1. Title: Clear, action-oriented heading
  2. Introduction: Brief explanation of the feature's purpose (1-3 sentences)
  3. Prerequisites: Any required accounts, permissions, or prior steps
  4. Step-by-Step Instructions: Numbered steps with clear actions
  5. Expected Results: What the user should see when successful
  6. Troubleshooting: Common issues and solutions
  7. Additional Information: Tips, shortcuts, or related features

Example How-To Document (Markdown Format)

# How To Log In to the Application

This guide explains how to log in to the application to access your account and personal dashboard.

## Prerequisites

- An active user account
- Internet connection
- Supported web browser (Chrome, Firefox, Safari, or Edge)

## Steps

1. Open your web browser and navigate to the application URL.
2. On the homepage, click the "Log In" button in the top right corner.
3. Enter your username or email address in the field labeled "Username".
4. Enter your password in the field labeled "Password".
5. Click the blue "Sign In" button.
6. You should see your personal dashboard with your account information.

## Troubleshooting

- **Forgotten Password**: Click the "Forgot Password?" link below the login form to reset your password.
- **Account Locked**: If you see a message that your account is locked, wait 15 minutes and try again or contact support.
- **Browser Issues**: Clear your browser cache and cookies if you experience login problems.

## Additional Information

After logging in, you can update your profile information by clicking on your user avatar in the top right corner and selecting "Profile Settings".

Read the full file on GitHub · 119 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. yesterday First seen · 119 lines · 986 tokens per session scan A 0f37976eff50

Subscribe to this mod's changes

how-to-documentation-cursorrules-prompt-file is a cursor rule published in the GitHub repository PatrickJS/awesome-cursorrules (40,722 stars, last pushed 3mo ago), licensed CC0-1.0. It costs nothing until one of its globs matches a file; then it loads 986 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.