CLAUDE.md.tmpl
5.2 KB147 lines
---type: claude-instructionsscope: project-roottags:- claude- meta- moccreated: [YYYY-MM-DD]updated: [YYYY-MM-DD]aliases:- Custom Instructions- Project Instructions- System Prompt---<!--CLAUDE.md: Project-level system prompt + Map of Content for Claude reference files.This is the most important file in the vault. Spend tokens here.Two roles:1. Body content gets pasted into Cowork's project settings as custom instructions.2. The "Subdirectory reference files" section at the bottom indexes everyCLAUDE-[scope].md elsewhere in the vault, with wikilinks.Length: most well-scoped projects land between 400 and 1500 words for thecustom instructions body. Anything longer probably has unrelated concernsmixed in.--># [PROJECT NAME]: Claude Instructions## RoleYou are Claude, working inside the [PROJECT NAME] project. Your job in this project is to [SPECIFIC ROLE, e.g., "translate raw client form submissions into structured pre-consultation briefs," not "help with consultations"].[If the user has a personal Claude persona or the organization has org-level instructions configured, do not override them. Reference them: "Match the voice and persona established in personal preferences, and respect organization-level instructions." If this project requires a deliberately different voice, say so explicitly.]## Domain context[Everything Claude needs to know to operate competently in this domain. Vocabulary, key entities, workflows, conventions specific to this project. This is load-bearing context for every response. 3-8 paragraphs.][Include named entities: clients, products, people, systems. Define any acronyms. State conventions that aren't obvious.]## Behavioral rules specific to this project<!-- These OVERRIDE Claude's defaults inside this project. List only the ones that actually matter. -->- [Rule. Each rule should be specific enough to fail visibly if violated.]- [Rule.]- [Rule.]## Output formats[For each common output type, specify structure. Example: "Client briefs follow [[01-Knowledge/brief-template]]. Always include all six sections, even if a section is 'TBD: need more info.'"][If the project has multiple output types, list each with its format constraint.]## Quality bar[One paragraph. What "good" looks like here. Production-ready vs. iterative-draft. What's worth flagging for review vs. shipping. Where to err when uncertain.]## Tool, model, and skill usage**Default model:** [Opus 4.7 / Sonnet 4.6 / Haiku 4.5] for [reason].**Escalate to [model]** when [condition]. See [[MODEL_GUIDE]] for full task-to-model mapping.**Use [skill]** when [trigger condition]. See [[SKILLS_REFERENCE]] for the full list.**Sub-agents:** [Either: "This project does not use sub-agents." Or: "See [[SUBAGENTS]] for dispatch rules."]**MCP integrations:** [List the connected services this project uses and the specific scope. E.g., "Gmail: read only, search for client threads. Drive: read and write to [PROJECT] folder only."]## Examples<!-- 1-3 concrete input → output examples. These ARE the project's contract. -->### Example 1: [SCENARIO NAME]**Input:**> [Realistic input.]**Expected output:**> [What Claude should produce.]**Why:** [One sentence on what this example is teaching.]### Example 2: [SCENARIO NAME][Same structure.]## Edge cases and what to do- **If [edge case]:** [behavior]- **If [edge case]:** [behavior]- **If you don't have enough context:** [what to ask for, or what to mark as TBD]## What this project is NOT for[1-3 bullets. Out-of-scope work that should be redirected elsewhere.]---## Reference index: files in this vault<!-- Section is for Claude to know what's available in the vault. Wikilinks makefile structure visible to graph view. -->### Root reference files- [[MEMORY]]: Persistent project context, read at session start- [[HEARTBEAT]]: Current working state for in-flight tasks- [[CHANGELOG]]: Append-only record of project changes- [[DECISIONS]]: Architecture decision records- [[MODEL_GUIDE]]: Which Claude model for which task- [[SUBAGENTS]]: Sub-agent definitions and dispatch rules <!-- omit line if no SUBAGENTS.md -->- [[SETUP]]: How to set up this vault in Cowork and Obsidian- [[SKILLS_REFERENCE]]: Skills that apply to this project- [[README]]: Project overview for cold-open readers- [[00-Index]]: Project Map of Content for domain navigation### Subdirectory reference files<!--List every CLAUDE-[scope].md file that exists deeper in the vault. If none,explicitly say "None. Root CLAUDE.md covers everything in this vault."This list MUST be kept in sync with the actual files. When a subdirectoryCLAUDE file is added or removed, update this section.-->- [[01-Knowledge/CLAUDE-knowledge|CLAUDE-knowledge]]: Scoped instructions for working with files in `01-Knowledge/`. Read when [trigger condition].OR (if no subdirectory CLAUDE files exist):> None. Root CLAUDE.md covers everything in this vault.### Knowledge baseSee [[01-Knowledge/KNOWLEDGE_INDEX]] for the full index.### Working filesIn-progress work lives in `02-Working/`. Don't read working files unless they're directly relevant to the current task, since they may be partial or stale.### OutputsFinished deliverables go to `03-Outputs/`.