MUXAI Wiki

MUXAI Wiki

Templates

Copy-paste starter files for AGENTS.md, design.md, PRODUCT.md, and Cursor rules.

Copy these into new projects during Setup Harness (Workflow Stage 3). Replace bracketed placeholders. Commit to the repo so every agent session reads the same context.

PRODUCT.md

# [Product or feature name]

## Goal
[One paragraph: what we're building and for whom.]

## Audience
[Primary users and their context.]

## Scope (this slice)
- In: [e.g. settings nav, empty states]
- Out: [e.g. backend save, auth]

## Done when
- [ ] [Measurable outcome 1]
- [ ] [Measurable outcome 2]

## References
- Figma: [link]
- Inspiration: [links or notes]

design.md

# Design principles — [Project name]

## Brand and tone
[Adjectives, voice, what to avoid — e.g. no purple-gradient heroes.]

## Typography
- Display: [font / scale]
- Body: [font / scale]

## Color and tokens
- Primary: [token or hex]
- Surface: [token]
- Use CSS variables / Tailwind theme — do not invent one-off colors.

## Spacing and layout
- Base unit: [e.g. 8px grid]
- Max content width: [e.g. 720px]

## Components
- Reuse: Button, Card, Input from [design system / shadcn]
- Do not create duplicate nav or button styles per screen.

## States
Design and implement: default, hover, focus, disabled, loading, empty, error.

## Review criteria
Run design-review before merge. Fix drift to this file, not agent taste.

AGENTS.md

# Agent instructions — [Project name]

## Stack
- [e.g. Vite, React, TypeScript, Tailwind, shadcn/ui]

## Your role
Implement UI from design.md and PRODUCT.md. Reuse components. Ask before adding new dependencies.

## Boundaries
- Do not change backend or API routes unless asked.
- Do not commit secrets or .env values.
- Do not push to main without explicit request.

## Files to read first
- PRODUCT.md
- design.md
- [Link to Figma if applicable]

## Commands
- Dev server: `npm run dev`
- Build: `npm run build`

Cursor rule (.cursor/rules/project.mdc)

---
description: Project design and harness rules
alwaysApply: true
---

- Follow design.md tokens and components.
- No AI slop: avoid generic purple gradients, centered-everything layouts, duplicate button styles.
- Prefer editing existing components over creating new ones.
- Run design-review when the user asks to check design quality.

Brief template (Discovery output)

# Brief — [Feature name]

**Problem:** [What user pain are we solving?]
**Success:** [How we'll know it worked]
**Constraints:** [Timeline, platform, brand, a11y]
**Out of scope:** [Explicit nos]
**Open questions:** [List for grill-me or team sync]

Checklist before first agent build

  • PRODUCT.md and design.md committed
  • AGENTS.md and Cursor rules in place
  • MUXAI setup skill run (if greenfield)
  • design-review skill installed
  • Figma or references linked in repo
  • .env in .gitignore if using API keys

Next: Setup checklist · Collaboration PR flow