Cursor组件文档提示词：AI判断标准实战指南
如何确保Cursor AI在编写组件文档时自动校验关键约束？通过预设指令，强制AI先输出一套判断标准——涵盖技术栈兼容性、Props分组规则、TypeScript注解强制要求、JSX语法限制及语言规范。待所有条件逐一确认后，再授权AI进入正式文档生成流程。
这一策略旨在遏制AI“直接生成”的惯常冲动，强制其在起草前系统化列出关键条件：例如Props表格的涵盖范围、必填项标注方式、示例代码块的嵌入规则、以及当前项目技术栈的适配性。这些细节AI通常不会主动推断，必须通过显式指令触发。
引导AI优先输出判断标准再撰写文档
第一步：在Chat窗口输入指令，命令AI先执行判定再继续流程。
例如：输入/judge-doc-requirements for React component "Button"。
第二步：等待AI返回结构化的判断清单。它必须列出至少5项具体标准，例如：
• 是否兼容Next.js App Router（基于当前项目路径自动识别）
• Props是否需按 required/optional 分组
• 示例代码是否必须包含 TypeScript 类型注解
• 是否禁用 JSX 语法糖（如Fragment缩写）
• 文档语言是否限定为中文且禁止中英文混排
第三步：验证AI返回的标准是否完整覆盖你的实际需求。若某项缺失，例如未提及“是否插入Figma设计稿截图链接”，立即追加指令：“补充判断：是否需要插入Figma设计稿截图链接？”
关键原则：AI不会自动补全未触发的判断维度。一旦遗漏提问，即视为默认不执行。
通过规则文件固化判断逻辑
方法一：在项目根目录创建 .cursorconfig.json 文件，配置一条自动触发判断的规则：
"rule": "当用户请求生成组件文档时，必须先输出 '判断标准' 小节，列出当前项目技术栈、文件位置、TSX/JSX类型、团队文档模板URL、是否启用JSDoc继承这五项判定依据，禁止直接写正文"
方法二：通过 .cursor/rules.json 全局配置匹配逻辑（仅限macOS/Linux）：
在 ~/.cursor/rules.json 的rules数组中添加一条：{"match": "**/src/components/**", "prompt": "你正在为React组件写文档。第一步：输出5条必须验证的判断标准，每条以'✓'开头；第二步：仅当用户回复'确认'后，才开始写文档正文"}
手动触发双阶段提示词流程
选中目标组件的文件 → 按Ctrl+K → 输入“Write doc with judgment first” → 回车 → 在弹出提示框中粘贴以下内容：
请分两阶段响应：
阶段一：输出「判断依据」，严格按以下顺序逐条检查并陈述：
① 当前文件路径是否属于 /src/components/ 或 /app/components/
② 文件扩展名是 .tsx 还是 .jsx
③ 组件是export default还是具名导出
④ 项目 package.json 中 react 版本是否 ≥18
⑤ 当前光标所在行是否含 JSDoc 注释块
阶段二：收到我回复‘执行’后，再按团队文档模板生成 Markdown 文档