diff --git a/Agents.md b/Agents.md index 8525d8c..95291a5 100644 --- a/Agents.md +++ b/Agents.md @@ -31,6 +31,18 @@ Keep this file aligned with PRD and README when workflows, scope, or structure c 3. Ask for a plan, then approve before edits. 4. Ask for focused changes and verification steps. +## Contribution Workflow (Required) +When using AI to add or change docs in this repo: + +1. Point the AI to this file and PRD.md first. +2. Ask for a short plan before edits. +3. Require explicit examples and step-by-step language in outputs. +4. Update the index when adding new markdown files. +5. Verify formatting (bullets, code blocks, and links) before commit. + +### Example Request +"Read Agents.md and PRD.md first. Propose a plan, then update docs/ai/ios.md with step-by-step guidance and examples. If you add new files, update docs/ai/index.md." + ## Skills Sync This repo uses a skills manifest to standardize skills across developers. diff --git a/PRD.md b/PRD.md index 1ea3b96..0b103ab 100644 --- a/PRD.md +++ b/PRD.md @@ -43,6 +43,13 @@ Teams need a clear, zero-knowledge onboarding path for AI tools, setup, and usag - Use step-by-step instructions and plain language. - Provide examples for key workflows. +## Definition Of Done (Doc Updates) +- New markdown files are linked in docs/ai/index.md. +- Sections include at least one concrete example. +- Instructions are step-by-step and beginner-friendly. +- Formatting is clean (no stray diff markers or broken code blocks). +- Agents.md and README are updated if workflow or structure changes. + ## Assumptions - The org has a Copilot Enterprise subscription. - Editors are standard across teams (Xcode and VS Code).