agentleFS
dev-ikdev-ik/ai-design-rules/AGENTS.md

ai-design-rules

AGENTS.md3 starsChanged 37 days agoMITView on GitHub

AI Design Context is an AI-first knowledge base for teaching coding agents how to design modern consumer products. Do not treat this repository as a documentation dump. Treat it as a knowledge graph. Follow this order: Never skip upstream evidence. Never generate UI from taste alone. Read docs/KNOWLEDGE_ENGINE.md before changing repository structure, adding object types, or changing relationships. Use it as the source of truth for: Before planning or changing a user-facing product, UX, UI, accessibility, motion, or prompt task,…

The file

Show its rules and text

We split this AGENTS.md into the rules it gives an agent

25 rules. About 0 are common, 20 are distinctive, and 5 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈20

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 5

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  • could be automatic: a setting could enforce it
  1. Distinctive:

    Do not treat this repository as a documentation dump.

    line 5
  2. Distinctive:

    Never skip upstream evidence.

    line 15
  3. Very specific:

    Read docs/KNOWLEDGE_ENGINE.md before changing repository structure, adding object types, or changing relationships.

    line 19
  4. Distinctive:

    Use it as the source of truth for:

    line 21
  5. Distinctive:

    Prefer improving existing knowledge over creating parallel files.

    line 35
  6. Distinctive:

    Keep every object connected to upstream sources and downstream usage.

    line 36
  7. Distinctive:

    Use schema-compatible YAML front matter for new knowledge objects.

    line 37
  8. Distinctive:

    Use typed relationships only.

    line 39
  9. Distinctive:

    Treat manual indexes as transitional context pages.

    line 40
  10. Distinctive:

    Use generated indexes as the preferred navigation layer for the migrated minimal chain.

    line 41
  11. Distinctive:

    Do not add rules without research.

    line 42
  12. Distinctive:

    Do not add patterns without required rules and related research.

    line 43
  13. Distinctive:

    Do not add prompts that invent design advice outside rules and patterns.

    line 44
  14. Distinctive:

    Do not treat reference projects as demos.

    line 45
  15. Distinctive:

    Before planning or changing a user-facing product, UX, UI, accessibility, motion, or prompt task, resolve focused graph context:

    line 49
  16. Very specific:

    Add --platform mobile when narrow-screen behavior matters.

    line 55
  17. Very specific:

    Read the returned research and rules before making product decisions.

    line 61
  18. Distinctive:

    Use them when the task matches their role:

    line 79
  19. Very specific:

    Use the relationship types defined in docs/KNOWLEDGE_ENGINE.md:

    line 104
  20. Distinctive:

    Every new object should be traceable.

    line 117
  21. Very specific:

    When changing research/, rules/, patterns/, prompts/, examples/, registry/objects.json, or registry/relationships.json:

    line 123
  22. Distinctive:

    Keep front matter and registry records aligned.

    line 125
  23. Distinctive:

    Keep relationship targets typed and resolvable.

    line 126
  24. Distinctive:

    Do not edit generated indexes manually.

    line 130
  25. Distinctive:

    Every architectural decision should support:

    line 153

≈ “Common” is an estimate: at least 1 in 5 of the 40,246 AGENTS.md 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
AGENTS.md

AI Design Context Agent Guide

AI Design Context is an AI-first knowledge base for teaching coding agents how to design modern consumer products.

Do not treat this repository as a documentation dump. Treat it as a knowledge graph.

Core Flow

Follow this order:

observation -> research -> knowledge -> rules -> patterns -> prompts -> reference projects -> reviews

Never skip upstream evidence. Never generate UI from taste alone.

Architecture Source

Read docs/KNOWLEDGE_ENGINE.md before changing repository structure, adding object types, or changing relationships.

Use it as the source of truth for:

  • schema-first object metadata;
  • global IDs, aliases, and slugs;
  • object metadata;
  • relationship types;
  • registry records;
  • navigation;
  • DesignLint readiness;
  • long-term scalability.

Working Rules

  • Improve architecture before adding volume.
  • Prefer improving existing knowledge over creating parallel files.
  • Keep every object connected to upstream sources and downstream usage.
  • Use schema-compatible YAML front matter for new knowledge objects.
  • Preserve schema-compatible YAML front matter on every migrated research, rule, pattern, prompt, and reference project.
  • Use typed relationships only.
  • Treat manual indexes as transitional context pages.
  • Use generated indexes as the preferred navigation layer for the migrated minimal chain.
  • Do not add rules without research.
  • Do not add patterns without required rules and related research.
  • Do not add prompts that invent design advice outside rules and patterns.
  • Do not treat reference projects as demos; use them to validate the graph.

Agent Context Retrieval

Before planning or changing a user-facing product, UX, UI, accessibility, motion, or prompt task, resolve focused graph context:

npm run context -- --task <task-slug-or-phrase> --intent implement

Add --platform mobile when narrow-screen behavior matters. Before reviewing an implementation, reference fixture, benchmark artifact, or prompt output, use:

npm run context -- --review <path-or-object-id> --intent qa

Read the returned research and rules before making product decisions. Treat draft and seed objects as bounded guidance. If no context resolves, record an observation or research need rather than inventing a rule. Skip the command for backend-only, infrastructure-only, or unrelated maintenance tasks.

Knowledge Objects

  • Observation
  • Research
  • Rule
  • Pattern
  • Prompt
  • Skill
  • Checklist
  • Review
  • Reference Project

Local Skill Specs

The current reusable agent skills live in skills/*/SKILL.md.

Use them when the task matches their role:

  • skills/product-designer/SKILL.md for product direction, primary action, object model, and pattern selection.
  • skills/ux-reviewer/SKILL.md for journey clarity, usability, state coverage, and user friction.
  • skills/information-architect/SKILL.md for object model, navigation, hierarchy, labels, and status language.
  • skills/mobile-ux-expert/SKILL.md for touch-first mobile behavior, capture flows, primary actions, and context preservation.
  • skills/interaction-designer/SKILL.md for flow mechanics, feedback, recovery, previews, and state transitions.
  • skills/design-system-architect/SKILL.md for semantic tokens, reusable state behavior, and pattern/component boundaries.
  • skills/visual-designer/SKILL.md for visual hierarchy, spacing, typography, color meaning, and polish.
  • skills/motion-designer/SKILL.md for purposeful motion and reduced-motion behavior.
  • skills/accessibility-reviewer/SKILL.md for labels, focus, target size, contrast, errors, and reduced motion.
  • skills/performance-reviewer/SKILL.md for perceived performance, loading behavior, responsiveness, and layout stability.
  • skills/design-reviewer/SKILL.md for design QA, traceability checks, and rule/pattern coverage review.
  • skills/prompt-architect/SKILL.md for graph-backed prompt structure and output contracts.
  • skills/knowledge-graph-architect/SKILL.md for schema, registry, generated indexes, relationships, and validation scope.
  • skills/agent-context/SKILL.md for focused graph retrieval before implementation or review.
  • skills/design-understand/SKILL.md for understanding an existing screen before UI changes.
  • skills/visual-qa/SKILL.md for browser/screenshot evidence and scoped visual QA.
  • skills/responsive-check/SKILL.md for executing viewport and responsive interaction checks.
  • skills/accessibility-check/SKILL.md for executing semantic and keyboard/state checks.

These skill files are not registered knowledge objects yet. Do not add them to registry/objects.json until skill metadata migration is explicitly requested.

Relationship Discipline

Use the relationship types defined in docs/KNOWLEDGE_ENGINE.md:

  • derived_from
  • cites
  • inspired_by
  • requires
  • validates
  • implements
  • related_to
  • supersedes
  • deprecated_by
  • replaced_by

Every new object should be traceable.

Validation Discipline

Research, rules, patterns, prompts, and reference projects are the first migrated chain.

When changing research/, rules/, patterns/, prompts/, examples/, registry/objects.json, or registry/relationships.json:

  1. Keep front matter and registry records aligned.
  2. Keep relationship targets typed and resolvable.
  3. Run npm run generate:indexes.
  4. Run npm run validate.

Do not edit generated indexes manually.

The validator is intentionally limited. It does not replace future DesignLint and does not enforce unmigrated object types yet.

Quality Bar

Progress means:

  • stronger relationships;
  • fewer duplicates;
  • better discoverability;
  • clearer specifications;
  • more reliable agent behavior.

Progress does not mean:

  • more pages;
  • more prompts;
  • more rules without evidence;
  • more disconnected examples.

Future Compatibility

Every architectural decision should support:

  • 1000+ rules;
  • 300+ patterns;
  • 200+ prompts;
  • multiple reference projects;
  • future DesignLint integration;
  • IDE and MCP integration.

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.