From 12da6e4f95ff23f85fa98c4340200798e8606db6 Mon Sep 17 00:00:00 2001 From: Matt Bruce Date: Tue, 10 Feb 2026 16:07:34 -0600 Subject: [PATCH] docs: require new chat repo summary --- Agents.md | 5 ++++- PRD.md | 2 ++ README.md | 4 +++- 3 files changed, 9 insertions(+), 2 deletions(-) diff --git a/Agents.md b/Agents.md index 58159b1..ac66366 100644 --- a/Agents.md +++ b/Agents.md @@ -7,11 +7,12 @@ It is internal guidance for the assistant, not reader-facing documentation. ## Audience And Tone Rules Assume the reader is new to AI and needs detailed, step-by-step guidance. +- Read the PRD.md and README.md to understand this project. +- On the first response in a new chat, read this file and summarize the repo purpose in 1-2 sentences before proceeding. - Be specific and explicit. Avoid shorthand. - Explain terms in plain language. - Provide an example whenever possible. - Format chat or code examples consistently: use "Example prompt:" with a fenced ```text``` block for chat prompts, and "Example code:" with the right language for code. -- For required instructions, label them as "Required instruction" and use a fenced ```text``` block. - Prefer checklists, short steps, and concrete outcomes. - Assume the reader is an expert engineer but a beginner at AI. @@ -46,6 +47,8 @@ When using AI to add or change docs in this repo: ## When A New Chat Starts If you had to restart a chat and re-explain the goal, add a short reminder so the assistant places content in the reader-facing docs instead of workflow files. +Also, the first response in a new chat must confirm it read Agents.md and briefly state what this repo is about at a high level. + ### What To Say (Plain English) - "Treat this repo like a book for developers. Put reader-facing guidance in docs/ai, not in Agents.md." - "If placement is unclear, ask where the content should live before editing." diff --git a/PRD.md b/PRD.md index 3ccf396..042b416 100644 --- a/PRD.md +++ b/PRD.md @@ -64,6 +64,8 @@ Teams need a clear, zero-knowledge onboarding path for AI tools, setup, and usag ## Documentation Sync When scope, workflows, or structure change, update PRD, README, and Agents together. +New chat starts should read Agents.md and state the repo purpose at a high level before proceeding. + ## Risks and Mitigations - Outdated instructions: set a review cadence. - Unclear ownership: assign section owners. diff --git a/README.md b/README.md index 7a078f5..fd6b138 100644 --- a/README.md +++ b/README.md @@ -17,9 +17,11 @@ These docs assume the reader is new to AI. Be explicit, explain terms, and inclu 3. Follow the iOS or Android setup guide. 4. Review skills and token usage guidance. +When a new chat starts, the assistant should read Agents.md and state the repo purpose at a high level before proceeding. + ## Local Workflow - Edit files in docs/ai. -- Keep sections short and scannable. +- Keep sections short but very detailed and scannable. - Avoid vendor-specific step details that change frequently. - Keep Agents, PRD, and README in sync when scope or structure changes.