关于 init-project-jpkb
init-project-jpkb 是用于在 JPKB 仓库中创建项目的工作流技能,提供标准化文档和目录结构。它收集项目及类别信息、保留现有文件,并支持通用、Python、Node.js、3D 打印和研究项目布局。
主要功能
- 01收集项目和类别信息
- 02确认目标路径
- 03保留或合并已有文件
- 04根据模板生成文件
- 05支持五种项目类型
适用场景
- 01在 JPKB 中创建带文档的项目
- 02搭建研究或 3D 打印项目
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ product-on-purpose/ pm-skills --skill init-project-jpkb安装后在 Claude Code 中输入/init-project-jpkb确认已加载。
包含的文件
除 SKILL.md 外,安装时一起下载的参考资料和脚本。
assets/CHANGELOG.template.mdCONTEXT.template.mdDECISIONS.template.mdLICENSE-Apache2.txtLICENSE-MIT.txtREADME.template.mdTODO.template.mdgitignore-general.txtreferences/project-types.md详细介绍
JPKB 项目初始化工作流
在 JPKB 仓库中搭建新项目,并创建标准化的文档文件。
执行步骤
1. 收集需求
创建任何文件前,先向用户确认:
| 必填 | 问题 | 默认值 |
|---|---|---|
| ✓ | 项目名称? | 无 — 必须询问 |
| ✓ | 类别/父文件夹? | 提供现有选项供选择 |
| 项目类型? | general | |
| 许可证偏好? | MIT | |
| 简短描述? | "一个新项目" |
如果上下文已提供答案,则跳过相关问题。 如果用户说“在 3d-prints 中初始化 parametric-hinge”,不要重复询问。
2. 确认目标路径
创建文件前,确认完整路径:
Target: E:\Projects\JP KB\jpkb\projects\<category>\<project-name>\
等待用户确认或更正。
3. 检查现有文件
创建文件前,检查已存在的内容:
| 如果存在 | 操作 |
|---|---|
| README.md | 跳过 — 保留现有文件 |
| CHANGELOG.md | 跳过 — 保留现有文件 |
| LICENSE | 跳过 — 保留现有文件 |
| .gitignore | 合并 — 追加缺失条目 |
| _NOTES/ | 跳过 — 保留现有内容 |
| AGENTS/ | 仅创建缺失部分 |
这样可以安全地对现有项目重新运行,以添加 Agent 结构。
4. 创建目录结构
<project-name>/
├── README.md
├── CHANGELOG.md
├── LICENSE
├── .gitignore
├── _NOTES/
│ └── .gitkeep
└── AGENTS/
└── claude/
├── CONTEXT.md
├── TODO.md
├── DECISIONS.md
└── SESSION-LOG/
5. 填充文件
使用 assets/ 文件夹中的模板,并替换:
{{PROJECT_NAME}}— 项目名称{{DESCRIPTION}}— 项目描述{{DATE}}— 当前日期(YYYY-MM-DD){{YEAR}}— 当前年份{{CATEGORY}}— 项目类别
项目类型对应的差异请参见 references/project-types.md。
6. 确认完成
向用户报告:
- 创建的完整路径
- 生成的文件
- 建议的后续步骤
项目类型
| 类型 | 额外结构 | 适用场景 |
|---|---|---|
general | 仅基础结构 | 默认类型、文档项目 |
code-python | + src/、tests/、pyproject.toml | Python 项目 |
code-node | + src/、package.json | Node.js 项目 |
3d-print | + models/、images/ | 3D 打印项目 |
research | + data/、notebooks/ | 研究/数据项目 |
完整详情请参见 references/project-types.md。
模板资源
| 文件 | 来源 |
|---|---|
| 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 写入的结构:
| Init 创建 | Wrap-Session 更新 |
|---|---|
| README.md(模板) | README.md(含进度) |
| CHANGELOG.md([Unreleased]) | CHANGELOG.md(含变更) |
| CONTEXT.md(初始状态) | CONTEXT.md(当前状态) |
| TODO.md(空) | TODO.md(含任务) |
| SESSION-LOG/(空) | SESSION-LOG/*.md |
评论
支持 Markdown