diff --git a/.agents/skills/draft_docs/SKILL.md b/.agents/skills/draft_docs/SKILL.md index a5425a9e..95138eda 100644 --- a/.agents/skills/draft_docs/SKILL.md +++ b/.agents/skills/draft_docs/SKILL.md @@ -95,6 +95,8 @@ These rules are frequently violated by agents. Apply them carefully during draft - **Bold per-segment for Settings paths** — Use `**Settings** > **AI** > **Knowledge**` not `` `Settings > AI > Knowledge` `` - **Screenshots for hard-to-describe UI** — When a page documents a visual surface (statusline chips, tab bars, settings panes, multi-control layouts), include a screenshot after the prose that introduces that surface. Do not rely on prose alone for chrome that reviewers cannot reconstruct from text. Prefer one well-placed figure over repeating the same surface. Always use descriptive alt text. ✅ a statusline screenshot after the paragraph that names the chips ❌ describing chip layout in a long paragraph with no image when humans keep asking "should we include a screenshot?" - **`VideoEmbed` requires a specific `title`** — Every `` must include a `title` prop that names the integration, workflow, feature, or task shown. ✅ `` ❌ `` or a generic title like `"video"` / `"demo"` +- **Disambiguate conditional and multi-clause wording** — If a sentence has two plausible readings (especially with "when", "if", "can", or stacked clauses), rewrite it so only one meaning remains. Prefer one idea per sentence. ✅ `Cloud handoff keeps your conversation's model only when that model is available in the cloud.` ❌ `Cloud handoff keeps your conversation's model when it can run in the cloud.` (keeps the model when it can? or only when cloud supports the model?) +- **Lead instructional sentences with the action or goal** — In steps, keyboard shortcuts, and "how to" sentences, put the action or goal first, then the control or condition. Readers should not need prior context to know what values or targets you mean. ✅ `To open the searchable environment and model selectors, press Ctrl+E.` ❌ `To change either value, press Ctrl+E.` (which values?) ### 7. Draft the doc Create the documentation using the appropriate template from `.agents/templates/`. Follow the structure for the identified content type and all rules in `AGENTS.md`. Each template includes visible bracketed instructions explaining what to put in each section. @@ -131,6 +133,8 @@ Before presenting the draft, verify against the quality checklist in `AGENTS.md` - [ ] Images have descriptive alt text - [ ] Visual UI surfaces that are hard to reconstruct from prose include a screenshot (or an explicit note that no screenshot is available yet) - [ ] Every `VideoEmbed` includes a specific `title` prop describing the workflow or feature shown +- [ ] Conditional or multi-clause sentences have only one clear reading (no ambiguous "when/if/can" stacking) +- [ ] Instructional sentences lead with the action or goal before the control, shortcut, or condition ### 10. Update navigation and redirects If this is a new page, remind the user to: diff --git a/.agents/templates/feature-doc.md b/.agents/templates/feature-doc.md index a7c0ed4d..b4e0347b 100644 --- a/.agents/templates/feature-doc.md +++ b/.agents/templates/feature-doc.md @@ -45,7 +45,9 @@ Keep the conceptual and procedural sections clearly separated.] Apply all procedural rules from AGENTS.md: - Motivate steps before giving instructions - Include expected outcomes after key steps -- Group related actions when they share the same UI context] +- Group related actions when they share the same UI context +- Lead instructional sentences with the action or goal, then the control (✅ "To open the selector, press `Ctrl+E`." ❌ "To change either value, press `Ctrl+E`.") +- Disambiguate conditionals and multi-clause sentences so only one reading remains] ### Prerequisites diff --git a/.agents/templates/procedural.md b/.agents/templates/procedural.md index fbb26174..21ba545b 100644 --- a/.agents/templates/procedural.md +++ b/.agents/templates/procedural.md @@ -35,6 +35,9 @@ Then numbered steps.] 2. Step description. 3. Step description. +[STEP WORDING: Lead each instructional sentence with the action or goal, then the control or condition. ✅ "To open the environment selector, press `Ctrl+E`." ❌ "To change either value, press `Ctrl+E`." +Disambiguate conditionals: one idea per sentence; avoid stacked "when/if/can" clauses that admit two readings. ✅ "The handoff keeps your model only when that model is available in the cloud." ❌ "The handoff keeps your model when it can run in the cloud."] + :::note [Optional: tip, clarification, or "good to know" context relevant to the steps above.]