SuperAPI AI 工具集

external-mindstudio-document-ux-review

写作与研究

查看项目

更新于 10-15 17:19

技能介绍

用途:把审查者当作第一次接触项目的新人,在尽量接近真实的环境里按 README 及其直接引用的安装、快速开始、运行文档逐步执行,找出真正阻塞上手的问题,并给出可落地的改进建议。输入通常是 Git 仓库链接或本地仓库路径,范围限于 README 加其直接指向的文档,不做无边界通读。

主要能力:执行前确认操作系统、Shell、CPU 架构、GPU/NPU、CUDA/CANN/Docker 等已有环境,以及隔离方式、网络权限、密钥与资源限制;优先用 Docker、uv、venv、conda 等隔离手段避免污染宿主环境;严格按文档顺序原样执行命令、路径、环境变量,记录每步的文档依据与真实输出;以新手视角检查先决条件、命令可复制性、占位符解释、预期输出、失败排查;体验至能启动或被阻塞为止,遇到需真实账号、密钥、付费资源、高风险改动、root 权限或超长训练等超出范围时停止并记为阻塞。

审查维度:易用性、正确性、可读性、完整性、环境友好性与最佳实践,并检查支持平台矩阵、前置环境与版本、安装指南、快速开始、配置说明、故障排查、小白指引、安全隔离建议等开源关键章节。若需读源码、脚本、CI、Dockerfile、Makefile 才能继续,应记为文档完整性缺陷。

输出:默认中文标准化报告,含审查对象、总体评分(100 分制)与结论(须写明评审分支与 commit)、体验流程图、执行摘要、关键问题概览、详细问题、新手友好度、正向观察、优先修复建议与附录;每项问题尽量给出文档位置、原文摘录、实际命令与输出、是否偏离执行。最终交付物为 HTML 报告,放在同一独立文件夹;样式应与 scripts/render_report_html.py 定义一致,优先使用该 bundled script 渲染。报告须基于真实执行证据或明确假设,不得把私下修复伪装成文档可用,不得默认接受全局安装、root 权限或系统污染;多页面时集中一个报告目录,并在回复中说明文件路径。评分区间为 90-100 可直接走通、75-89 主流程可用但有短板、60-74 需较多人工判断、40-59 明显阻塞、0-39 主流程无法执行。