关于 init-project
init-project 是用于搭建 Agent 化项目结构的工作流技能。它收集项目信息、检查已有文件,并通过模板创建通用、Python 或 Node.js 项目布局,同时保留现有内容。
主要功能
- 01收集项目需求
- 02检查已有文件后搭建结构
- 03使用模板生成文档
- 04支持通用、Python 和 Node.js 布局
- 05创建文件前请求确认
适用场景
- 01为新项目建立 Agent 化文档结构
- 02为现有项目补充缺少的结构
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ product-on-purpose/ pm-skills --skill init-project安装后在 Claude Code 中输入/init-project确认已加载。
包含的文件
除 SKILL.md 外,安装时一起下载的参考资料和脚本。
assets/CHANGELOG.template.mdCONTEXT.template.mdDECISIONS.template.mdLICENSE-Apache2.txtLICENSE-MIT.txtREADME.template.mdTODO.template.mdgitignore-general.txtreferences/project-types.md详细介绍
项目初始化工作流
搭建具有 Agent 编码结构的项目,以支持 AI 辅助开发。
执行步骤
1. 确定目标目录
- 默认:当前工作目录
- 如果用户指定路径,则使用该路径
- 如果目录不存在,询问是否创建
2. 收集需求
| 必需 | 问题 | 默认值 |
|---|---|---|
| 项目名称? | 目录名称 | |
| 项目类型? | general | |
| 许可证偏好? | MIT | |
| 简要描述? | “一个新项目” |
如果上下文中已有答案,则跳过提问。
3. 检查现有文件
创建前,检查已有内容:
| 如果存在 | 操作 |
|---|---|
| README.md | 跳过 — 保留现有文件 |
| CHANGELOG.md | 跳过 — 保留现有文件 |
| LICENSE | 跳过 — 保留现有文件 |
| .gitignore | 合并 — 追加缺少的条目 |
| _NOTES/ | 跳过 — 保留现有内容 |
| AGENTS/ | 仅创建缺少的部分 |
这样可以在现有项目中安全地重复运行,以添加 Agent 编码结构。
4. 创建前确认
向用户展示:
- 目标路径
- 将要创建的文件(注明跳过的文件)
- 选定的项目类型
等待确认。
5. 创建目录结构
<project-root>/
├── README.md
├── CHANGELOG.md
├── LICENSE
├── .gitignore
├── _NOTES/
│ └── .gitkeep
└── AGENTS/
└── claude/
├── CONTEXT.md
├── TODO.md
├── DECISIONS.md
└── SESSION-LOG/
6. 填充文件
使用 assets/ 文件夹中的模板,替换:
{{PROJECT_NAME}}— 项目名称{{DESCRIPTION}}— 项目描述{{DATE}}— 当前日期(YYYY-MM-DD){{YEAR}}— 当前年份
7. 添加类型专属文件
| 类型 | 附加结构 |
|---|---|
general | 仅基础结构 |
code-python | + src/、tests/、pyproject.toml |
code-node | + src/、package.json |
详情请参阅 references/project-types.md。
8. 确认完成
报告:
- 创建的完整路径
- 生成的文件
- 建议的后续步骤
模板资源
| 文件 | 来源 |
|---|---|
| README.md | assets/README.template.md |
| CHANGELOG.md | assets/CHANGELOG.template.md |
| LICENSE (MIT) | assets/LICENSE-MIT.txt |
| LICENSE (Apache) | assets/LICENSE-Apache2.txt |
| .gitignore | assets/gitignore-general.txt |
| CONTEXT.md | assets/CONTEXT.template.md |
| TODO.md | assets/TODO.template.md |
| DECISIONS.md | assets/DECISIONS.template.md |
集成
此技能创建的结构兼容 /wrap-session:
| 初始化创建 | Wrap-Session 更新 |
|---|---|
| README.md | README.md(含进度) |
| CHANGELOG.md | CHANGELOG.md(含变更) |
| CONTEXT.md | CONTEXT.md(当前状态) |
| TODO.md | TODO.md(含任务) |
| SESSION-LOG/ | SESSION-LOG/*.md |
评论
支持 Markdown