SKILL.md
soia-dev-project-scaffold
客户可读说明
这个技能可以做什么
为一个新建或空白的 Git 项目创建一套最小、可编辑的 AI 协作基线:AGENTS.md、文档导航、项目概览、变更记录和 AI 工作记录目录。它不生成应用框架、云服务模块或组织内部治理结构。
客户如何使用
提供目标项目的绝对路径,并明确允许创建文件。先运行帮助或检查目录;目标已有同名文件时,先展示差异并取得覆盖确认。
bash skills/soia-dev-project-scaffold/shells/init-project-baseline.sh <project-path>
依赖与安装
claude plugin marketplace add soia-team/soia-open-skills
claude plugin install soia-dev@soia
只要这一个技能时,可用 npx 路线。注意技能会落进共享真源 ~/.agents/skills;若同时装了插件,同一技能会出现两份索引且各自漂移,建议二选一:
npx skills add soia-team/soia-open-dev-skills -g -a '*' -s soia-dev-project-scaffold -y
依赖 POSIX shell、mkdir 和 git(仅用于检查,不初始化仓库)。不需要私有配置;项目特定规则应由客户在生成后的 AGENTS.md 中补充。
WorkBuddy 的装载单位是角色化专家而不是插件,npx skills add -a '*' 覆盖不到它,需要单独安装,见 docs/install/workbuddy.md。
私密信息与中间数据
- 本技能只读取目标目录是否存在及同名文件状态,不扫描目标项目之外的文件,也不收集账号、凭据或项目正文。
- 正式产物仅是下方列出的基线文件,写入客户明确指定的项目路径;发现同名文件时停止,不创建隐式备份、不覆盖。
- 脚本不建立持久 state、cache、私有配置或独立日志,也不需要 Provider 凭据。帮助和预览结果只输出到 stdout。
- 如实现过程中需要临时检查文件,使用操作系统临时目录并在完成后清理;不得把客户绝对路径或项目内容复制进公共模板。
- 回执仅列目标路径、创建/跳过的相对文件和验证结果,不打印无关目录内容。
日志与完成回执
完成:<已创建或预览的基线>。
日志摘要:
- target: <绝对路径>
- created/updated: <文件列表>
- skipped/failed: <原因或无>
验证:<git status、文件清单和读取检查>
问题与下一步:<需要填充的项目规则或无>
适用与边界
适用于“新建 Git 项目”“补 AGENTS.md”“建立 docs/ 导航”等请求。不用于已有项目的大规模重构、语言/框架脚手架,或需要组织专属目录模板的项目。
最小流程
- 确认绝对目标路径和写入授权。
- 检查是否已存在
AGENTS.md或将生成的 docs 文件;存在时先停下并询问是否覆盖。 - 运行脚本,或按同一文件清单手动创建。
- 用
git -C <project-path> status --short和find/sed复核生成结果。 - 回执列出创建项、验证证据及仍需客户填写的项目规则。
输出
脚本生成:
AGENTS.mddocs/navigation.mddocs/project-overview.mddocs/product/README.mddocs/changelog/README.mddocs/ai-workspace/README.mddocs/templates/README.md
验证
bash skills/soia-dev-project-scaffold/shells/init-project-baseline.sh --help
bash -n skills/soia-dev-project-scaffold/shells/init-project-baseline.sh