agentleFS
Sign inStart free
alexeyleshchenkoalexeyleshchenko/fast-mcp-telegram/.cursor/rules/docs-plain-language.mdc

fast-mcp-telegram / rules

Cursor rule2 starsChanged 4 months agoMITView on GitHub

Write clear, jargon-free documentation (README, docs, SECURITY, memory bank)

1 other project uses a version of this.

Adopted by

Most recently taken up by

  • Other versions1 project uses a version of this.

    Word for word · 1

    1. leshchenko1979/fast-mcp-telegram★ 50100% same

    Edited · 0

    None found.

    Wrote their own version · 0

    None found.

    How matches are found. Word for word: the exact same text. Edited: shares passages with this file (“99% same” means 99% of its five-word phrases also appear here; 10% or more counts). Their own version: similar meaning, or, weakest, the same name. We can’t tell which project had it first. Projects are counted among the 200 most-starred candidates, and mentions are links to the repository we found, up to 50 per site, so both counts are a floor.

  • Where files are headingNew Cursor rule files have more rules about planning and tracking tasks, and fewer about code style.

    Of the Cursor rule files we read, the 4,157 first seen in the last six months, against the older ones: the kind of rule that gained most share, and the kind that lost most. About files like this in general, not this one, and an estimate, since a kind is a pattern in the words.

  • In this repository11 other files it gives its agents.

The file

We split this docs-plain-language.mdc into the rules it gives an agent

2 rules. About 0 are common, 1 is distinctive, and 1 is very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈1

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 1

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    When editing Markdown (README, docs/, SECURITY.md, CONTRIBUTING.md, ADRs, memory bank, example YAML comments):

    line 9
  2. Distinctive:

    Prefer tables for profiles and flags.

    line 33

≈ “Common” is an estimate: at least 1 in 5 of the 6,668 Cursor rule files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
docs-plain-language.mdc
---
description: Write clear, jargon-free documentation (README, docs, SECURITY, memory bank)
globs: "**/*.md"
alwaysApply: false
---

# Plain-language documentation

When editing Markdown (README, `docs/`, `SECURITY.md`, `CONTRIBUTING.md`, ADRs, memory bank, example YAML comments):

## Goal

A new operator or contributor should understand **what to do** and **what happens** without decoding project slang.

## Keep (widely used or project-defined once)

- Standard product terms after a short gloss: **MCP**, **Bearer token**, **principal**, **principal identifier**, **http-auth**, **Telegram**, **MTProto**, **ACL**
- Env vars and YAML keys as literals: `ACL_ENABLED`, `allow_mtproto`, `chats`
- Linked internal names when they are the actual config surface (file paths, tool names)

## Avoid or replace

| Avoid | Prefer |
| --- | --- |
| Invented shorthand (`bot-like`, `power profile` without table context) | Names from `SECURITY.md` / examples: **bot**, **team_lane**, **analyst** |
| Phase/version jargon alone (“Phase 2 guardrails”) | What changed: “listed principals need `allow_mtproto: true` for raw MTProto” |
| Implementation slang without explanation (“synthetic rule”, “empty lane”) | Plain outcome: “principal not in `principals:` is denied” or “listed principal with no `chats` cannot use chat tools” |
| `-like`, `-style`, “footgun”, “blast radius” in operator runbooks | Direct risk: “teammates with the same principal identifier can read login codes” |
| Stacking nouns (“dual pre/post enforcement”) | One sentence: what is checked before the tool runs and what is filtered after |

## Style

- Prefer **tables** for profiles and flags; one row = one audience action.
- First mention of a restriction: **symptom → cause → fix** (troubleshooting), not error-code archaeology.
- Example tokens in tests/docs: use names from `acl.yaml.example` (`automation-token`), not cute internal labels.
- English only; short sentences; active voice (“Set `allow_mtproto: true`”) over passive stacks.

## Quick check before finishing doc edits

1. Would someone who only runs http-auth understand this without reading `session_acl.py`?
2. Did every coined phrase appear in a glossary table or get removed?
3. Are env vars and YAML keys copy-pasteable and spelled exactly as in code?

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

Check your setup, free