可选模块

按需启用的附加模块。从 Core 开始,根据实际工作流需求添加模块。详见 templates/modules/docs/modules/

推荐启用顺序

  1. eval-harness — 显式评估结构和可重复评估循环
  2. multi-run — 多运行管理和比较
  3. tmux — 运维友好的长时间运行和监控
  4. browser-adapter — 浏览器/工具集成支持
  5. docs-dual-format — 双格式文档体系(md + HTML)

主要模块

eval-harness module

为项目提供显式的评估目录结构和可重复的回归路径。

包含:

  • docs/EVALS.md — 评估文档
  • evals/ — 评估目录

何时启用:项目需要专用评估目录和可重复回归路径时。

multi-run module

支持项目比较多次运行、跟踪运行组或导出跨命名运行的比较摘要。

要点

  • 每次运行应有稳定、描述性的名称
  • 比较摘要不应混入原始运行日志
  • 将导出报告放在专用的 compare 或 report 目录中

包含:docs/MULTI_RUN.mdreports/

何时启用:项目需要比较多轮运行或维护命名运行组时。

tmux module

为需要分离/重连同时保持终端可见性的长时间运行操作员提供 tmux 支持。

要点

  • 使用包含项目或运行名称的稳定描述性会话名
  • 将规范日志持久化在运行时工作空间下,即使在 tmux 中启动运行
  • 记录如何附加、分离和关联 tmux 会话与运行目录

包含:docs/TMUX_OPERATIONS.mdscripts/launch_in_tmux.sh

何时启用:项目需要分离式长时间终端观察时。

专用模块

browser-adapter specialized

集成浏览器自动化或浏览器支持工具,产生 traces、screenshots、transcripts 等会话制品。

运行时输出规则

  • 浏览器制品应落在活动运行时工作空间下
  • 操作员应能看到运行了什么浏览器任务、哪个运行触发了它、输出写在哪里
  • 失败时立即暴露输出目录和调试制品

包含:docs/BROWSER_ADAPTER.mdartifacts/browser/

何时启用:仅在项目明确需要时启用。

docs-dual-format new

为项目建立双格式文档体系:docs/md/(Markdown 源码)+ docs/html/(HTML 多页展示),内容完全对等,共享暗色主题 CSS + 统一导航。

约束

  • 内容对等:md 和 html 描述的信息必须一致
  • 导航一致性:所有 HTML 页面共享同一个 <nav>
  • 共享 CSS:所有 HTML 页面引用同一个 style.css

包含:docs/md/(OVERVIEW, ARCHITECTURE, USAGE, DESIGN_DECISIONS),docs/html/(index, architecture, usage, design-decisions + style.css)

何时启用:项目需要同时支持 CLI 快速查阅和浏览器展示时。

参考模块(仅文档)

以下模块有参考文档但尚未有独立模板 — 其指导已融入 Core:

文档内容
advanced-eval-isolation更严格的隔离:每运行工作空间副本、锁范围、子进程清理、构建/运行日志持久化
context-and-working-agreements持久项目上下文、运行时会话上下文、交接笔记、决策记录、不应提交的内容
tool-integration-contracts工具形状、操作员可见性、超时与重试策略、输出位置规则、故障暴露要求
delivery-rhythm-and-evals阶段分离、最低评估期望、回归检查、里程碑标准