Ascend/msagent / skills/minos/document-ux-review
document-ux-review
Verified当用户希望你像第一次接触项目的人一样,真实按仓库的 README、安装文档或 quick start 跑一遍,并判断“新人能不能走通”“文档是否可用”“哪里会卡住”“安装/启动说明是否对新手友好”时,使用这个 skill。它适用于 repo onboarding audit、documentation UX review、quickstart validation、README walkthrough、按文档验证安装与运行并输出问题报告的场景;即使用户只是说“按 README 试一下”“帮我检查这个仓库文档能不能跑通”“看看 quick start 为什么带不动新人”,也应触发。不要用于纯翻译、润色、摘要、风格对比、治理项检查,或只想直接修环境/修单个报错而不做完整文档体验审查的请求。
| File | Kind | Size |
|---|---|---|
| README.md | markdown | 5.9 KB |
| SKILL.md | skill md | 16.4 KB |
| evals/evals.json | config | 5.2 KB |
| scripts/render_report_html.py | script | 57.7 KB |
evals/evals.json
View on GitHub{
"skill_name": "document-ux-review",
"evals": [
{
"id": 1,
"prompt": "请帮我审查这个仓库的文档体验:https://gitcode.com/Ascend/msmonitor 。我希望你站在第一次接触这个项目的新手视角,严格按 README 和 README 直接关联的安装/快速开始文档一步步体验。环境是 Linux,只有 Python 基础环境,Docker 可用,uv 和 conda 可用,默认不允许全局安装。请尽量使用隔离环境,不要自己脑补缺失步骤,并输出中文 Markdown 报告,重点看 Linux 用户是否能按文档完成安装并进入可运行状态。",
"expected_output": "生成一份中文 Markdown 文档体验审查报告,覆盖 README 与直接关联安装文档的真实执行过程,说明 Linux 场景下是否能按文档完成安装、哪些步骤被全局安装要求阻塞、报告对应的评审分支与 commit id,以及具体问题位置和修改建议。",
"expectations": [
"报告在审查对象或总体结论中明确记录评审分支和 commit id。",
"报告把“需要读源码、脚本、配置或 CI 才能继续”的情况记为文档完整性问题,而不是把这类补全视为文档已覆盖。",
"如果最终生成 HTML 交付物,报告路径说明应体现它们位于同一个独立目录,而不是零散的单文件。"
],
"files": []
},
{
"id": 2,
"prompt": "我要你对这个仓库做一个 README onboarding review:https://gitcode.com/Ascend/msmonitor 。请严格按文档体验,不要自动帮作者补足缺失步骤。环境是 macOS,只有 Python,Docker 可用,uv 和 conda 可用,不允许全局安装。已知当前没有可直接提供给 macOS 的安装包,如果文档提供源码编译二进制和 plugin whl 包的方法,请按文档继续;如果文档没有说清楚,就把它记为阻塞问题。请输出中文为主的 Markdown 报告。",
"expected_output": "生成一份中文 Markdown 报告,重点覆盖 macOS 场景是否有清晰可执行的安装路径,是否需要用户自行猜测源码编译方式,以及 README 与安装文档在平台支持、前置条件和可读性上的问题。",
"expectations": [
"报告明确说明 macOS 场景下文档流未完全走通,并给出整体走通状态。",
"报告指出至少一个源码构建的具体平台阻塞点,例如 GNU realpath、Rust toolchain 前提、sys/prctl.h 或 AppleClang 兼容问题。",
"报告包含至少一个精确文档位置,用来定位问题发生在 README 或安装文档的哪里。",
"报告给出至少两条可执行的文档修改建议,而不是只描述问题。",
"报告包含 100 分制总体评分,且解释评分依据。",
"报告包含完整的体验流程图或流程表,明确标出 OK / 阻塞 / 未执行 等状态。",
"报告在审查对象或总体结论中明确记录评审分支和 commit id。",
"如果为了继续执行必须阅读源码、脚本、配置、CI 或 Dockerfile,报告把它记为文档完整性问题。",
"如果最终生成 HTML 交付物,报告路径说明应体现它们位于同一个独立目录。"
],
"files": []
},
{
"id": 3,
"prompt": "请审查这个仓库的文档上手体验:https://gitcode.com/Ascend/msmonitor 。当前机器已经具备基础 Python 环境,并且用户说明 CUDA / CANN 相关基础环境已经 OK,不需要重复安装 toolkit;如果 README 或安装文档里出现这些步骤,请先验证现有环境是否满足,再从下一步继续。要求尽量不影响宿主机其他用户,优先用 docker、uv、conda 或其他隔离方式。请按 README 和 README 直接链接的文档逐步执行,并输出完整 Markdown 报告,列出每个可能导致用户走不通的问题点、具体位置、影响和改进建议。",
"expected_output": "生成一份完整 Markdown 文档体验审查报告,明确写出用户已具备环境、哪些步骤因此被跳过或仅验证、文档是否支持这类已有环境场景,以及哪些问题会让普通用户无法顺利走通。",
"expectations": [
"报告明确记录了用户已具备环境,以及因此跳过、仅验证或无法验证的步骤。",
"报告指出 README 或快速入门里的证书路径示例不能直接运行,或者等价地指出最小可运行路径没有前置说明。",
"报告指出缺失训练脚本、缺失最小 runnable example,或等价的主流程闭环阻塞问题。",
"报告包含精确文档位置,并给出至少两条可执行的修改建议。",
"报告包含 100 分制总体评分,且解释评分依据。",
"报告包含完整的体验流程图或流程表,明确标出 OK / 阻塞 / 未执行 等状态。",
"报告在审查对象或总体结论中明确记录评审分支和 commit id。",
"如果为了继续执行必须阅读源码、脚本、配置、CI 或 Dockerfile,报告把它记为文档完整性问题。",
"如果最终生成 HTML 交付物,报告路径说明应体现它们位于同一个独立目录。"
],
"files": []
}
]
}
Related skills
| Skill | Stars | Updated | Works with | Status | Install |
|---|---|---|---|---|---|
| rea-analysis-optimizationmorluto/reaOptimize REA providers and shared analysis workflows for agent context, latency, CPU, and memory while preserving correctness and Evidence. Use for analysis bottlenecks and cache or query design; CI/test-suite optimization belongs to rea-ci-tests-audit. | Stars: 471k | Updated | Claude CodeCodex | Verified | Install |
| rea-ci-tests-auditmorluto/reaAudit REA CI and test suites for correctness, fixture drift, false passes, and measured performance; use for suite or workflow investigations and efficiency changes, rather than ordinary feature testing or a single test failure. | Stars: 471k | Updated | Claude CodeCodex | Verified | Install |
| rea-tool-designmorluto/reaAudit, investigate, design, or change REA investigation tools, CLI/MCP contracts, provider capabilities, and Evidence semantics. | Stars: 471k | Updated | Claude CodeCodex | Verified | Install |
| ponytail-auditDietrichGebert/ponytailQuality audit of the whole repo: bugs, security, real load, missing tests, speed, and what to delete. Most important first. | Stars: 194k | Updated | Claude CodeCodex | Verified | Install |