feat(docs): add market four-tab materials (tutorial/demo/changelog) for v1.0.46
All checks were successful
技能自动化发布 / release (push) Successful in 13s
All checks were successful
技能自动化发布 / release (push) Successful in 13s
This commit is contained in:
@@ -106,6 +106,9 @@ your-skill/
|
||||
├─ tests/
|
||||
├─ .gitignore
|
||||
├─ README.md
|
||||
├─ TUTORIAL.md
|
||||
├─ DEMO.md
|
||||
├─ CHANGELOG.md
|
||||
├─ requirements.txt
|
||||
├─ release.ps1
|
||||
└─ SKILL.md
|
||||
@@ -114,7 +117,10 @@ your-skill/
|
||||
各目录职责如下:
|
||||
|
||||
- `assets/`:放示例输出、schema、静态说明资源
|
||||
- `README.md`:面向用户的市场详情页说明
|
||||
- `README.md`:市场 **说明** Tab(`readme_md`)
|
||||
- `TUTORIAL.md`:市场 **教程** Tab(`tutorial_md`)
|
||||
- `DEMO.md`:市场 **演示** Tab(`demo_video_url` + `demo_md`)
|
||||
- `CHANGELOG.md`:市场 **更新日志** Tab(按版本小节同步 `changelog`)
|
||||
- `SKILL.md`:面向 LLM / 平台的技能入口
|
||||
- `references/`:Agent 运行/编排/调用时渐进加载的补充上下文(如 CLI、SCHEMA)
|
||||
- `development/`:面向开发者与 AI 编程代理的开发资料、需求、测试与技术规范
|
||||
@@ -305,7 +311,7 @@ git remote -v
|
||||
复制后优先改下面这些地方:
|
||||
|
||||
1. `SKILL.md`
|
||||
2. 根目录 `README.md`(用户市场说明)
|
||||
2. 根目录市场四 Tab:`README.md` / `TUTORIAL.md` / `DEMO.md` / `CHANGELOG.md`
|
||||
3. `scripts/util/constants.py`
|
||||
4. `references/` 与 `development/` 下的文案
|
||||
5. `scripts/service/` 下的业务占位实现(优先改 `task_service.py`)
|
||||
@@ -339,7 +345,7 @@ git remote -v
|
||||
|
||||
如需浏览器自动化,不要在模板里保留空的 `platform_playwright.py`;请按业务新建 `xxx_playwright.py`(命名自定),并在 `task_service.py` 中按需引用。
|
||||
|
||||
## 6. `SKILL.md` 与根 `README.md` 应该怎么写
|
||||
## 6. `SKILL.md` 与市场四 Tab 材料应该怎么写
|
||||
|
||||
### `SKILL.md`(LLM / 平台入口)
|
||||
|
||||
@@ -351,19 +357,26 @@ git remote -v
|
||||
- 何时触发本技能、CLI 入口摘要、运行契约要点
|
||||
- 指向 `references/`(Agent 调用)与 `development/`(开发规范)的分工说明
|
||||
|
||||
不要在 `SKILL.md` 里写大量用户市场文案或实现细节。
|
||||
不要在 `SKILL.md` 里写大量用户市场文案或实现细节;**不要**把演示视频 URL 写进 `SKILL.md`(放 `DEMO.md` frontmatter)。
|
||||
|
||||
### 根 `README.md`(用户市场说明)
|
||||
### 市场四 Tab(根目录,面向普通用户)
|
||||
|
||||
根 `README.md` 是技能市场详情页主来源(`metadata.readme_md`),面向普通用户。
|
||||
发布 CI 会把下列文件同步到技能市场详情 Tabs(有文件才更新对应字段):
|
||||
|
||||
应包含 YAML frontmatter 的 `description`(市场列表简介),正文用用户能理解的语言说明:
|
||||
| 文件 | 市场 Tab | 同步字段 |
|
||||
|------|----------|----------|
|
||||
| `README.md` | 说明 | `readme_md`(frontmatter `description` 作列表简介) |
|
||||
| `TUTORIAL.md` | 教程 | `tutorial_md` |
|
||||
| `DEMO.md` | 演示 | `demo_md` + frontmatter `demo_video_url` |
|
||||
| `CHANGELOG.md` | 更新日志 | 匹配当前 tag 版本的 `##` 小节 → `changelog` |
|
||||
|
||||
- 能做什么、适合什么场景、使用前准备什么
|
||||
- 如何自然语言告诉 Agent
|
||||
- 执行结果、注意事项、常见问题
|
||||
**`README.md`**:能力与场景说明。含 frontmatter `description`;写能做什么、场景、准备、如何告诉 Agent、结果、注意事项、FAQ。不要写开发教程、目录规范、release、requirements。
|
||||
|
||||
不要在根 `README.md` 里写开发教程、目录规范、release、requirements 等技术细节。
|
||||
**`TUTORIAL.md`**:第一次怎么用完的逐步操作。写「开始前 → 步骤 → 卡住怎么办」;不要写 CLI / 目录 / 开发规范。
|
||||
|
||||
**`DEMO.md`**:演示视频与补充说明。frontmatter 必须含 `demo_video_url`(无视频时用 `""`);正文可选。
|
||||
|
||||
**`CHANGELOG.md`**:每个正式版本一节(如 `## 1.0.46`)。打 tag 前为即将发布的版本新增小节;用户可读的变化,少写内部实现。
|
||||
|
||||
实现细节放在:
|
||||
|
||||
@@ -402,9 +415,12 @@ metadata:
|
||||
|
||||
当前规范 skill 的文档按读者拆分:
|
||||
|
||||
**根 `README.md`**
|
||||
**根市场材料(四 Tab)**
|
||||
|
||||
- 用户市场详情页说明(含 frontmatter `description`)
|
||||
- `README.md` — 说明(含 frontmatter `description`)
|
||||
- `TUTORIAL.md` — 使用教程
|
||||
- `DEMO.md` — 演示(`demo_video_url` + 正文)
|
||||
- `CHANGELOG.md` — 按版本更新日志
|
||||
|
||||
**`SKILL.md`**
|
||||
|
||||
@@ -442,7 +458,7 @@ metadata:
|
||||
比如 `skill-actions.schema.json`、日志记录、机读 JSON 的 schema
|
||||
|
||||
不要把正式研发文档放到 `assets/`。
|
||||
用户说明进根 `README.md`;Agent 编排资料进 `references/`;开发规范进 `development/`。
|
||||
用户市场四 Tab 进根 `README.md` / `TUTORIAL.md` / `DEMO.md` / `CHANGELOG.md`;Agent 编排资料进 `references/`;开发规范进 `development/`。
|
||||
|
||||
## 9. `cli` 层怎么写
|
||||
|
||||
@@ -768,7 +784,7 @@ uses: client-jiangchang/jiangchang-platform-kit/.github/workflows/reusable-relea
|
||||
如果工作流失败,不要继续做平台验证,而应该先回到代码仓库排查,例如:
|
||||
|
||||
- 发布脚本是否正常推送
|
||||
- `SKILL.md`、根 `README.md`、`scripts/`、`references/`、`development/` 是否齐全
|
||||
- `SKILL.md`、根市场四 Tab(`README.md` / `TUTORIAL.md` / `DEMO.md` / `CHANGELOG.md`)、`scripts/`、`references/`、`development/` 是否齐全
|
||||
- 工作流文件是否存在
|
||||
- 发布包结构是否符合模板规范
|
||||
|
||||
@@ -903,7 +919,7 @@ uses: client-jiangchang/jiangchang-platform-kit/.github/workflows/reusable-relea
|
||||
现在的新模板原则是:
|
||||
|
||||
- 不做旧结构兼容
|
||||
- 用户说明在根 `README.md`,Agent 资料在 `references/`,开发规范在 `development/`
|
||||
- 用户市场四 Tab 在根 `README.md` / `TUTORIAL.md` / `DEMO.md` / `CHANGELOG.md`,Agent 资料在 `references/`,开发规范在 `development/`
|
||||
- 统一走 `scripts/main.py` 作为 CLI 入口
|
||||
|
||||
### 错误 5:平台放 slug 最前
|
||||
@@ -965,7 +981,7 @@ git remote add origin <新技能仓库 URL>
|
||||
如果让一个新人照着做,我建议他按这个顺序:
|
||||
|
||||
1. 按 [`NAMING.md`](NAMING.md) 确定 slug,复制模板并改目录名
|
||||
2. 改 `SKILL.md` 与根 `README.md`
|
||||
2. 改 `SKILL.md` 与根市场四 Tab(`README.md` / `TUTORIAL.md` / `DEMO.md` / `CHANGELOG.md`)
|
||||
3. 改 `scripts/util/constants.py`
|
||||
4. 改 `references/` 与 `development/`
|
||||
5. 改 `scripts/cli/app.py`
|
||||
@@ -981,7 +997,7 @@ git remote add origin <新技能仓库 URL>
|
||||
|
||||
- 目录结构统一
|
||||
- 入口统一为 `scripts/main.py`
|
||||
- 用户说明在根 `README.md`,Agent 资料在 `references/`,开发规范在 `development/`
|
||||
- 用户市场四 Tab 在根 `README.md` / `TUTORIAL.md` / `DEMO.md` / `CHANGELOG.md`,Agent 资料在 `references/`,开发规范在 `development/`
|
||||
- 业务核心逻辑统一放 `scripts/service/`
|
||||
- 不再使用旧模板历史结构
|
||||
|
||||
|
||||
Reference in New Issue
Block a user