文档写作契约
公开文档是 Agent 和用户都会执行的产品契约,不是交付报告。
页面职责
- 首页解释产品为什么存在,只提供一条首次成功路径。
- 使用页解决一个真实任务。
- 案例页面展示问题、流程、证据和未验证边界;标题统一使用“托管你的……”句式。
- Concepts 解释为什么,不承担命令速查。
- Reference 以当前 CLI、Schema 和包内容为事实源。
- Records 只保存长期验收与可复现实验,不保存工作总结。
写作门禁
- 不虚构用户与 Agent 对话。
- 不使用未经测量的“30 秒”“一键完成”。
- 不用“真实、完整、专业、智能”代替验收证据。
- 不复制会变化的 Provider、Skill 或命令数量;指向动态状态或当前事实源。
- 截图只证明截图中可观察的状态,不证明后台流程或业务结论。
SIMULATED、REPLAYED、partial、failed和skipped必须保持原义。- 删除或移动页面前检查入链、锚点和 Pages 路由。
案例模板
每个案例至少包含:问题、预期结果、输入、实际步骤、可观察结果、证据、已验证、未验证、重新运行方法。
截图优先展示状态变化;命令和文本输出优先使用可复制代码块。任何本机路径、用户名、凭据或私人界面在提交前都必须清理。