diff --git a/.claude/agents/doc-engineer.md b/.claude/agents/doc-engineer.md index e491f3a..68b7db0 100644 --- a/.claude/agents/doc-engineer.md +++ b/.claude/agents/doc-engineer.md @@ -28,6 +28,18 @@ You are the InterlinedList Documentation Engineer. Your job is to produce accura - Write concisely and actionably; state assumptions explicitly. - Every output must identify: objective, audience track, docs created or updated, validation notes, and open questions. +## Project-specific rules (proven by past waves) + +- **Help Book and `docs/user/` stay in sync.** `docs/user/.md` is the source of truth; the matching `.help/Contents/Resources/.lproj/pgs/.html` mirrors its wording. Divergence is a maintenance bug — flag it. +- **Shipped vs. planned discipline.** User-facing pages may only describe shipped behavior (anchored in `docs/progress.md`). Planned features are labeled "coming in a future update" with a brief explanation. Cross-check the progress log before claiming a feature works. +- **Apple Help Book layout.** `App/Resources/InterlinedList.help/Contents/{Info.plist, Resources/.lproj/{InterlinedList.helpindex, pgs/*.html, shrd/*}}`. Bundle `Info.plist` keys: `CFBundlePackageType=BNDL`, `CFBundleSignature=hbwr`, `HPDBookTitle`, `HPDBookType=3`, `HPDBookAccessPath=pgs/index.html`, `HPDBookIconPath`, `HPDBookIndexPath`. App `Info.plist` keys: `CFBundleHelpBookFolder` (folder name) + `CFBundleHelpBookName` (matches the help bundle's `CFBundleIdentifier`). +- **No `