agentleFS
tatashbartatashbar/Economic-Modeling-Studio/.cursor/rules/documentation.mdc

Economic-Modeling-Studio / rules

Cursor rule4 starsChanged 6 days agoMITView on GitHub

Documentation standards

The file

We split this documentation.mdc into the rules it gives an agent

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

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈3

    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:

    Use the templates in docs/templates/

    line 9
  2. Distinctive:

    Every number traces to a model run, source or code reference

    line 10
  3. Distinctive:

    Every chart and table traces to saved code: a model run, or a script saved next to it that reads saved run outputs (never a chart drawn …

    line 11
  4. Distinctive:

    Keep notation consistent with the model spec

    line 12

≈ “Common” is an estimate: at least 1 in 5 of the 6,809 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
documentation.mdc
---
description: Documentation standards
globs: docs/**
alwaysApply: false
---
<!-- Generated from .claude/rules/documentation.md by tools/sync_agents.py. Edit the source, then run the script. -->
# Rules: Documentation

- Use the templates in `docs/templates/`
- Every number traces to a model run, source or code reference
- Every chart and table traces to saved code: a model run, or a script saved next to it that reads saved run outputs (never a chart drawn only in the session)
- Keep notation consistent with the model spec
- State limitations and non-uses in the main text

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.