external-mindstudio-document-ux-review
Installation
SKILL.md
Document UX Review
这个 skill 的目标不是“读一遍 README 然后提几点意见”,而是把自己当成第一次接触该项目的用户,在尽量真实的环境里按文档一步一步操作,尽可能覆盖文档里面的每一个环节,找出真正会阻塞上手的问题,并给出可落地的改进建议。
适用范围
- 输入通常是一个 Git 仓库链接,也可以是本地仓库路径。
- 默认审查范围是:
README+README直接指向的安装、快速开始、运行相关文档。 - 如果 README 把关键步骤跳转到
docs/、脚本、示例目录或其他 Markdown 文件,要继续跟进这些直接依赖的文档。 - 不要无边界地通读所有文档;保持“为了完成 README 指导流程而必须阅读什么,就读什么”的范围感。
开始前先确认执行边界
在真正执行前,先尽量确认下面这些信息,避免把环境问题误判成文档问题,也避免重复安装用户已经具备的基础组件: