mattrguerra/meridian-skillsmainPrivate on GitHub, published here in full

README.md.tmpl

1.4 KB55 lines

skills/cowork-project-architect/templates/README.md.tmpl

  1. ---
  2. type: readme
  3. scope: project-root
  4. tags:
  5. - readme
  6. - meta
  7. created: [YYYY-MM-DD]
  8. updated: [YYYY-MM-DD]
  9. ---
  10. <!--
  11. README.md: High-level project overview. One screen max.
  12. Audience: a future you, or a collaborator opening this folder cold.
  13. Goal: in 60 seconds they understand what this is and where to go next.
  14. -->
  15. # [PROJECT NAME]
  16. [ONE-SENTENCE PURPOSE]
  17. ## What this is
  18. [2-3 sentences. Plain prose. What problem this project solves and what it produces. No marketing voice.]
  19. ## Who uses it
  20. [Just you / you + named collaborators / client-facing.]
  21. ## Mode
  22. [Interactive / agentic / hybrid. One sentence on what that means here.]
  23. ## Cadence
  24. [Daily / weekly / project-bounded / on-demand. Include rough volume if known.]
  25. ## Where to look
  26. - **Project navigation (humans)** → [[00-Index]]
  27. - **Claude instructions** → [[CLAUDE]]
  28. - **What Claude needs to remember** → [[MEMORY]]
  29. - **Which model when** → [[MODEL_GUIDE]]
  30. - **Setup** → [[SETUP]]
  31. - **Knowledge base** → [[01-Knowledge/KNOWLEDGE_INDEX]]
  32. - **What's currently in flight** → [[HEARTBEAT]]
  33. - **Recent changes** → [[CHANGELOG]]
  34. - **Why it's built this way** → [[DECISIONS]]
  35. ## Success criteria
  36. [2-4 bullets describing what "this project is working" looks like. Concrete, observable.]
  37. ## Opening this vault
  38. This 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]].