structured-output

结构化输出

适用场景

• 完成任何审查或分析时。
• 以统一格式呈现发现，并明确列出具体后续步骤。
• 向利益相关者展示结果或将结果写入文档前。

不适用场景

• 在分析过程中收集证据——使用 proof-of-work
• 审查更改——先使用 diff-analysis 或 review-core

激活模式

触发关键词：格式、结构、交付物、报告、整理、呈现、统一 上下文线索：

• “将其格式化为报告”或“构建输出结构”
• “创建交付物”或“呈现这些发现”
• “以统一方式整理”或“统一格式”
• “使其具有可执行性”或“为利益相关者做好准备”

自动加载时机：完成任何分析交付物，或收到统一格式要求时。

必需的 TodoWrite 项

1. structured-output:template-selected
2. structured-output:findings-formatted
3. structured-output:actions-assigned
4. structured-output:appendix-attached

完成相应步骤后，将每项标记为已完成。

步骤 1：选择模板（structured-output:template-selected）

• 根据交付物类型选择输出格式：
  • 审查报告：摘要、发现、建议、证据。
  • PR 描述：摘要、更改、测试计划、备注。
  • 发行说明：亮点、重大变更、修复、致谢。
  • 事件报告：时间线、影响、根本原因、补救措施。
• 确认受众和所需的详细程度。

步骤 2：格式化发现（structured-output:findings-formatted）

• 使用统一的发现结构：

  ### [SEVERITY] Finding Title
  **Location**: file.rs:123
  **Anchor**: `verbatim source text copied from line 123`
  **Category**: Security | Performance | Correctness | Style
  **Description**: Brief explanation of the issue.
  **Evidence**: [E1, E2] - Reference to evidence log.
  **Recommendation**: Specific remediation steps.
  

  **验证：**使用 --help 标志运行命令，以确认其是否可用。
• 严重级别：CRITICAL、HIGH、MEDIUM、LOW、INFO。
• 按严重级别排序，再按文件位置排序。
• **锚点为必填项，可为发现提供依据。**在 Location 处复制精确的 源文本（不得改写）。第二轮检查会重新阅读这段文本，以确认发现属实。 如果引用行中没有出现锚点，则该发现会被视为幻觉并删除。 检查过程是机械化的：imbue:review-core 的步骤 5 会对这些发现运行 plugins/imbue/scripts/citation_verifier.py。

步骤 3：分配操作项（structured-output:actions-assigned）

• 将发现转化为操作项，并指定负责人和优先级：

  ## Action Items
  - [ ] [HIGH] Fix SQL injection in auth.py:45 (@security-team, P1)
  - [ ] [MEDIUM] Add input validation to API endpoint (@backend, P2)
  - [ ] [LOW] Update deprecated dependency (@devops, P3)
  

  **验证：**使用 --help 标志运行命令，以确认其是否可用。
• 在已知的情况下指定负责人。
• 添加优先级标记（P1/P2/P3）以便分类处理。
• 注明操作项之间的依赖关系。

步骤 4：附上附录（structured-output:appendix-attached）

• 汇编支持材料：

  ## Appendix
  ### A. Commands Run
  [Full evidence log from imbue:proof-of-work]
  
  ### B. External References
  [Citations and documentation links]
  
  ### C. Raw Data
  [Large outputs, full diffs, or data exports]
  

  **验证：**使用 --help 标志运行命令，以确认其是否可用。
• 保持主报告简洁；详细内容放在附录中。
• 验证附录易于浏览，且章节标题清晰。

输出质量检查清单

定稿前：

• 每项发现都有经引用验证器解析的逐字 Anchor（不得提交未经验证的发现）。
• 所有发现都有证据引用。
• 严重级别均有合理依据。
• 建议具体，并明确指出下一步。
• 不存在孤立章节或占位文本。
• 格式在目标平台（GitHub、Confluence 等）中正确呈现。

完成标准

• 所有 Todo 均已完成，且交付物已格式化。
• 输出遵循所选模板结构。
• 利益相关者无需澄清即可根据发现采取行动。