49 lines
2.0 KiB
Markdown
49 lines
2.0 KiB
Markdown
# 匠厂 技能开发模板
|
|
|
|
这是一个**规范化的新技能模板仓库**，用于复制出新的 skill 项目；它本身**不是业务 skill**。
|
|
|
|
## 模板目标
|
|
|
|
- 对齐当前规范 skill 的目录结构：`assets/`、`references/`、`scripts/`、`tests/`、`evals/`
|
|
- 对齐当前规范脚手架分层：`scripts/cli`、`scripts/db`、`scripts/service`、`scripts/util`、`scripts/jiangchang_skill_core`
|
|
- 提供最小可运行入口：`python scripts/main.py health` / `version`
|
|
- 让新技能从一开始就按规范落地，不再沿用旧模板的 `docs/`、`optional/`、`skill_main.py` 结构
|
|
|
|
## 新技能使用步骤
|
|
|
|
1. 复制本目录为新的 skill 仓库。
|
|
2. 全局替换 `your-skill-slug`、`your-platform-key`、`您的技能显示名称`、`你的平台名` 等占位内容。
|
|
3. 修改 `SKILL.md`、`references/` 和 `scripts/util/constants.py`。
|
|
4. 在 `scripts/service/` 中补业务 service 与真正的发布/执行逻辑。
|
|
5. 用 `python scripts/main.py health` 和 `python scripts/main.py version` 做最小验证。
|
|
|
|
开发教程入口：
|
|
|
|
- [需求文档模板](references/REQUIREMENTS.md)：给技术人员编写和查看研发需求的标准模板
|
|
- [开发教程](references/DEVELOPMENT.md)：给技术人员的完整开发步骤说明
|
|
|
|
## 目录说明
|
|
|
|
| 路径 | 用途 |
|
|
|------|------|
|
|
| `SKILL.md` | 技能清单与触发说明模板 |
|
|
| `assets/` | 示例输出与轻量 schema |
|
|
| `references/` | 面向用户与编排的文档模板 |
|
|
| `scripts/` | 规范分层后的代码骨架 |
|
|
| `tests/` | 单元测试或最小回归测试 |
|
|
| `evals/` | 人工/半自动评估材料 |
|
|
| `.github/workflows/release_skill.yaml` | 标准发布工作流 |
|
|
| `release.ps1` | 对齐现有 skill 的发布脚本入口 |
|
|
|
|
## 最小命令
|
|
|
|
```bash
|
|
python scripts/main.py health
|
|
python scripts/main.py version
|
|
```
|
|
|
|
## 注意
|
|
|
|
- 不要再往模板里引入旧式 `docs/` 或 `optional/` 目录。
|
|
- 新技能若不需要某些目录，也建议先保留结构，再按实际业务填充内容。
|