README.md.tmpl
1.4 KB55 lines
---type: readmescope: project-roottags:- readme- metacreated: [YYYY-MM-DD]updated: [YYYY-MM-DD]---<!--README.md: High-level project overview. One screen max.Audience: a future you, or a collaborator opening this folder cold.Goal: in 60 seconds they understand what this is and where to go next.--># [PROJECT NAME][ONE-SENTENCE PURPOSE]## What this is[2-3 sentences. Plain prose. What problem this project solves and what it produces. No marketing voice.]## Who uses it[Just you / you + named collaborators / client-facing.]## Mode[Interactive / agentic / hybrid. One sentence on what that means here.]## Cadence[Daily / weekly / project-bounded / on-demand. Include rough volume if known.]## Where to look- **Project navigation (humans)** → [[00-Index]]- **Claude instructions** → [[CLAUDE]]- **What Claude needs to remember** → [[MEMORY]]- **Which model when** → [[MODEL_GUIDE]]- **Setup** → [[SETUP]]- **Knowledge base** → [[01-Knowledge/KNOWLEDGE_INDEX]]- **What's currently in flight** → [[HEARTBEAT]]- **Recent changes** → [[CHANGELOG]]- **Why it's built this way** → [[DECISIONS]]## Success criteria[2-4 bullets describing what "this project is working" looks like. Concrete, observable.]## Opening this vaultThis folder is structured as an Obsidian vault. To open in Obsidian: File → Open folder as vault → select this folder. To use as a Cowork project: see [[SETUP]].