Frontend · Any coding agent
Vue 3 & Nuxt 4 ARCHITECTURE.md
An ARCHITECTURE.md for Vue 3 & Nuxt 4: module responsibilities, data flow and the boundaries code changes must keep.
- Path
- ARCHITECTURE.md
- Loads
- Read when referenced
- Format
- Markdown (.md)
- Used by
- Any coding agent
What this file tells the agent
ARCHITECTURE.md describes module responsibilities, state boundaries and data flow, so a coding agent knows where code belongs before it changes anything. Point to it from CLAUDE.md or AGENTS.md so agents read it.
- Always use `<script setup lang='ts'>` and the Composition API; ban legacy Options API.
- Use `useFetch` or `useAsyncData` for server-side data fetching with unique cache keys.
- Colocate server endpoints under `server/api/` with `defineEventHandler`.
- Rely on Nuxt auto-imports; avoid manual import statements for standard Vue and Nuxt composables.
Install it in one command
- 01
Go to your project root
The file goes at ARCHITECTURE.md, relative to the root.
- 02
Download the file
Run the command on the right. It downloads this preset and writes the file.
- 03
Make sure it gets used
Agents read it when your CLAUDE.md or AGENTS.md points to it. Add a line such as "Read ARCHITECTURE.md before structural changes".
$ curl -fsSL "https://www.devscratchpad.tech/api/raw/architecture-md/vue-nuxt" -o "ARCHITECTURE.md"
writes ARCHITECTURE.md
ARCHITECTURE.md
To write the file from your own code instead, use Read your code or Convert Legacy Rules in the editor above.
More for Vue 3 & Nuxt 4
Other formats
Other ARCHITECTURE.md presets
Questions
- What belongs in ARCHITECTURE.md?
- How the main modules relate, how state and data flow, and the boundaries every change must keep.
- How does ARCHITECTURE.md help AI agents?
- It tells them where code belongs and which boundaries to keep, so they are less likely to add circular dependencies or skip layers. Point to it from CLAUDE.md or AGENTS.md so they read it.