メニュー
This skill should be used when the user wants to evaluate documentation quality from multiple perspectives. Triggers on: Review 文档、评测文档、评估文档、doc eval、文档评价、文档质量、文档评测。
Codex または Claude でインストール この Prompt をコピーして Codex、Claude、または他のアシスタントに貼り付けると、Skill ページを確認してインストールできます。
SOC 職業分類に基づく
| name | doc-eval |
| description | This skill should be used when the user wants to evaluate documentation quality from multiple perspectives. Triggers on: Review 文档、评测文档、评估文档、doc eval、文档评价、文档质量、文档评测。 |
| version | 1.2.0 |
从不同用户角色视角评价技术文档质量，生成评分和改进建议。默认先输出本地 Markdown 产物，并将最终报告写入飞书；如果用户或调用方明确要求只输出本地 Markdown，则不写飞书。
references/rubric.md 的匹配矩阵。具体阅读规则、零经验开发者定位、MDX 复用处理、链接跟随、术语检查、准确性判断和问题写作要求见 references/evaluation-execution.md。
执行角色评测的 subagent 必须读取该文件。
6 个评测维度，详细评分标准见 references/rubric.md：
references/evaluation-execution.md。| 级别 | 标记 | 含义 |
|---|---|---|
| 阻塞 | 🔴 | 导致该角色无法完成目标，必须修复 |
| 体验差 | 🟡 | 可以完成但体验糟糕，建议修复 |
| 优化建议 | 🟢 | 锦上添花，可选择性改进 |
各角色的关注路径、模拟问题、评分权重详见 references/rubric.md。
| 角色 | 目标 | 评分侧重 |
|---|---|---|
| CTO / 技术决策者 | 评估产品是否满足业务需求 | 信息架构 > 内容完整性 > 准确性 |
| 产品经理 | 评估产品功能、定位、计费 | 内容完整性 > 信息架构 > 准确性 |
| ZEGO技术支持 | 用文档帮用户解答问题 | 内容完整性 > 准确性 > 参数/配置说明 |
| 客户端开发 | 按文档集成客户端 SDK | 参数/配置说明 > 内容完整性 > 前提条件 |
| 服务端开发 | 按文档集成服务端 | 参数/配置说明 > 内容完整性 > 前提条件 |
| 全栈开发 | 按文档集成客户端+服务端 | 参数/配置说明 > 内容完整性 > 前提条件 |
角色画像和阅读路径见对应文件：references/role-cto.md、references/role-support.md、references/role-client-dev.md、references/role-server-dev.md、references/role-fullstack-dev.md 等。
当用户要求评测文档时，按以下流程执行：
确认以下信息（用户可能已提供，未提供的用 AskUserQuestion 补充）：
YYYY-MM-DDstandalone-default: doc-eval 独立运行，默认写飞书local-only: 用户或调用方明确要求不写飞书，只输出本地 Markdownrun-name 固定格式：
{product}-{platform}-{scope}-{date}
报告输出目录：
doc-test-reports/{run-name}/doc-eval/
识别文档类型：根据目录名判断文档属于哪种类型（产品概述、快速开始、客户端API、服务端API、FAQ 等）。类型列表见 references/rubric.md 的文档类型定义表。
查匹配矩阵：在 references/rubric.md 的「文档类型 × 角色匹配矩阵」中查找该文档类型对应哪些角色。
确定参与角色：
告知用户：展示匹配结果，让用户确认参与角色。例如："这是快速开始文档，匹配到的角色是：客户端开发(⭐⭐⭐)、服务端开发(⭐⭐⭐)、全栈开发(⭐⭐⭐)、CTO(⭐⭐)、ZEGO技术支持(⭐⭐)。产品经理和计费说明不匹配，不参与评测。"
创建本地报告目录：
doc-test-reports/{run-name}/doc-eval/
阶段至少输出：
doc-test-reports/{run-name}/doc-eval/doc-eval-summary.md
doc-test-reports/{run-name}/doc-eval/role-*.md
run-index.md 如存在，由调用方维护；doc-eval 不负责更新总索引。
使用 Agent 工具启动 subagent，在独立上下文中完成角色评测和本地 Markdown 写入。所有角色报告和汇总报告的完整文本不返回主会话，只返回摘要文件路径、报告路径、综合评分和必要的飞书链接。
调用方式：使用 Agent 工具，参数如下：
subagent_type: "general-purpose"general-purpose agent 处理。多个角色并行。prompt: 告知 subagent 执行以下评测流程：Subagent 内部流程：
references/role-*.md）references/rubric.md）references/evaluation-execution.md）和报告格式（references/report-templates-role.md），按角色关注路径完整阅读目标文档并生成评测报告每个 agent 的 prompt 应包含：评测目标（文档路径列表、产品名称、目标平台、测试范围、文档类型、run-name、报告目录）和上述步骤指令。具体评测细节不要重复写在 prompt 中，要求 subagent 读取并遵循 references/evaluation-execution.md 和 references/report-templates-role.md。
每个 agent 还需在评测报告末尾生成集成验证输入（可选），包括：
每个角色评测完成后，写入：
doc-test-reports/{run-name}/doc-eval/role-{role-id}.md
不要把完整角色报告返回主会话。
所有角色报告都完成后，启动一个 general-purpose agent 生成汇总报告。该 agent：
references/role-report.md）references/report-templates.md）doc-test-reports/{run-name}/doc-eval/role-*.mddoc-test-reports/{run-name}/doc-eval/doc-eval-summary.md不要把所有角色完整报告塞进 prompt 或返回主会话；汇总 agent 必须从本地文件读取角色报告。
飞书写入策略：
| 模式 | 是否写飞书 | 说明 |
|---|---|---|
standalone-default | 是 | 默认就写入 |
local-only | 否 | 用户或调用方明确要求不写飞书 |
仅当需要写飞书时，读取 references/feishu-write.md 并按其中说明创建飞书文件夹、写入角色报告和汇总报告。
仅返回以下内容，不返回完整报告文本：
## Result
- status: completed / failed / blocked
- summary_file: doc-test-reports/{run-name}/doc-eval/doc-eval-summary.md
- detail_files:
- doc-test-reports/{run-name}/doc-eval/role-client-dev.md
- doc-test-reports/{run-name}/doc-eval/role-fullstack-dev.md
- document_link: {飞书汇总报告链接或本地 doc-eval-summary.md 路径}
- summary: 综合评分 X/5，发现 N 个问题，其中 M 个阻塞
- next_action: continue / stop / needs_user_input
如果已写飞书，可额外返回：
Subagent 完成后验证：
doc-eval-summary.md 已生成role-*.md 已生成注意：subagent 在独立上下文中运行，主会话不保留角色报告和汇总报告的详细内容。所有评测结果通过本地 Markdown 文件保存；飞书只是独立运行时的默认发布目标。
向用户展示：
doc-test-reports/{run-name}/doc-eval/doc-test-reports/{run-name}/doc-eval/doc-eval-summary.md| 文件 | 用途 |
|---|---|
references/rubric.md | 文档类型定义、角色匹配矩阵、评分标准、权重表、校准规则 |
references/evaluation-execution.md | subagent 执行评测时使用的阅读、链接、复用、术语、定位和问题写作细则 |
references/feishu-write.md | 需要写入飞书时使用的创建文件夹和写入文档说明 |
references/role-cto.md | CTO 角色画像、阅读路径、评分注意事项 |
references/role-support.md | ZEGO技术支持画像、阅读路径、评分注意事项 |
references/role-client-dev.md | 客户端开发画像、阅读路径、评分注意事项 |
references/role-server-dev.md | 服务端开发画像、阅读路径、评分注意事项 |
references/role-fullstack-dev.md | 全栈开发画像、阅读路径、评分注意事项 |
references/role-report.md | 汇总分析方法、交叉分析维度、优先级排序 |
references/report-templates-role.md | 角色报告输出格式 |
references/report-templates.md | 汇总报告输出格式 |
| Skill | 用途 |
|---|---|
url-to-mdx | 将文档 URL path（如 /real-time-video-web/...）解析为本地 MDX 文件 |
api-short-link-to-mdx | 将 API @ 短链（如 @startPublishingStream）解析为本地 API 参考 MDX 文件 |
Use this skill when the user wants to run the full ZEGO documentation access-test workflow: documentation evaluation, demo construction, automated demo testing, final cross-stage synthesis, and optional Feishu publication. Triggers on: "集成测试", "接入测试", "文档接入测试", "make-integration-test", "integration test", "run full integration test", or when the user explicitly asks to both evaluate docs and verify a runnable integration demo. Do not use this skill when the user only wants doc evaluation, only wants to build a demo, or only wants to run tests; use the narrower skill directly in those cases.
Use this skill when the user needs to publish a ZEGO documentation access-test run to Feishu: create fixed report documents under the access-test Feishu node, correct doc-eval reports using build and auto-test results, write build/test and corrected doc-eval summary reports, upload source/test artifacts and screenshots, and return Feishu links. Triggers on: "写入飞书接入测试报告", "发布接入测试报告", "report-doc-test-in-feishu", "飞书报告", "生成飞书报告", or when make-integration-test reaches its Feishu publishing stage.
This skill should be used when editing MDX files, writing MDX content, adding components to documentation, or formatting documentation in ZEGO docs. Triggers on "edit mdx", "write mdx", "add callout", "create tabs", "insert steps", "mdx component", "mdx syntax", "format documentation", "编写 MDX", "编辑 MDX", "添加组件".
This skill should be used when the user wants to test a demo project — designing test cases, executing automated tests, taking screenshots, and packaging the project. Also handles creating test-cases.json and test-cases.sh for example code projects. Triggers on: "test demo", "run tests", "test the project", "验证功能", "测试 demo", "run test cases", "截图打包", "create test cases", "write test cases", "generate test cases", "design test cases for the demo", "create test-cases.json", "create test-cases.sh". Applicable to document example demos, access test demos, and competitive test demos.
This skill should be used when the user wants to simulate a zero-experience developer following ZEGO documentation to build, code, compile, and verify a demo project. Triggers on: "构建集成测试项目", "按文档构建项目", "create integration demo", "构建验证", "模拟零经验开发者构建", "integration test build", "create-integration-demo". It can run standalone when the user provides documentation paths, and can optionally consume existing Markdown evaluation reports as background input.
This skill should be used when the user asks to "生成 GitHub 链接", "get GitHub link", "file to github link", "生成文件链接", "获取源码链接", or needs to convert a local file path + line number into a clickable GitHub URL. Also triggers when the user references a file and line number and wants a shareable link to that location in the repository. Do NOT trigger for general link checking, link fixing, or web URL tasks — this skill is specifically for local-to-GitHub path conversion.