技能文档编写器

4小时前更新 2 00
技能文档编写器技能文档编写器
技能文档编写器

技能简介

skill-writer 用于编写符合 ClawdHub/MoltHub 注册表规范的高质量 SKILL.md 文件。它覆盖技能格式规范、YAML前置元数据模式、内容组织模式、示例质量要求以及常见反模式规避。

业务背景

技能文档编写器帮助开发者快速生成符合平台规范的SKILL.md文件,确保技能能被注册表正确索引和发现。它内置格式规范与反模式检查,降低文档返工率,让团队将精力聚焦于功能开发而非格式调整。

落地案例:某开发团队需为内部CLI工具创建技能文档,输入工具名称、功能描述及依赖环境后,系统自动生成包含YAML元数据、使用示例和章节结构的完整文档。团队成员无需反复查阅规范手册,直接获得可直接提交至ClawdHub的合规文件。

能做什么

  • 从零创建新技能的结构框架
  • 编写可被注册表正确索引的前置元数据
  • 选择适合不同技能类型的章节组织方式
  • 生成包含具体代码示例的技能内容
  • 在发布前自检技能文档质量

使用说明

安装依赖:

npx molthub@latest search "your-slug"

使用步骤:

  1. 确定技能名称(小写连字符格式,如 csv-pipeline
  2. 编写 description 字段:说明功能+触发场景+覆盖范围
  3. 配置 metadata.clawdbot:emoji、所需二进制工具、支持的操作系统
  4. 撰写 When to Use 章节:4-8个具体场景 bullet
  5. 按任务而非概念组织主体内容,每个章节包含可运行的代码块

输入与输出

见下方输入与输出表格。

项目内容
输入技能名称(slug)、功能描述、操作系统列表、依赖工具列表、使用场景、代码示例
输出符合 ClawdHub 规范的 SKILL.md 文件,含 YAML 前置元数据和结构化 Markdown
适用人群需要在 ClawdHub/MoltHub 发布技能的开发者,希望标准化文档格式的团队
不包含自动提交注册表、技能功能代码实现、非 Markdown 格式输出

 

风险提示

  • description 过长会被搜索结果截断,建议控制在单句长度
  • requires.anyBins 避免填写 bash/echo 等通用工具
  • 缺少代码块的技能被视为观点而非工具
  • 技能名称需预先检查 slug 冲突

来源信息

原始链接:https://github.com/openclaw/skills/tree/main/skills/gitgoodordietrying/skill-writer/SKILL.md
来源类型:GitHub 仓库

数据统计

相关导航

暂无评论

none
暂无评论...