用途
writing-skills 是一个文档编写技能,用于在创建或修改项目文档时遵守统一规范。其注意事项要求:内容具有普适性,除非明确说明,否则不应依赖具体业务;文档应能脱离特定项目上下文独立理解;示例应简洁有力,不要废话连篇。
目录结构
技能采用如下目录结构:
skills/
<skill-name>/
SKILL.md ← 必须,skill 入口文件
命名规范
- 文件夹名:小写字母 + 连字符,例如 code-review、task-breakdown
- name 字段:必须和文件夹名一致
- 风格:用名词或动词短语,简洁明确
SKILL.md 格式
---
name: <skill-name>
description: <一句话说明用途和触发时机>
---
# <标题>
## 依赖规范
#[[file:../rules/<规则文件>.md]]
#[[file:../<其他skill>/SKILL.md]]
## 目的
<一句话说明目标>
## 输入
- <输入项>
## 步骤
> 每个步骤先输出标题,再输出结果
- <步骤 1>
- <步骤 2>
## 输出
- <输出项>
## Review 检查清单
- <检查项>
编写规则
- description:说清楚“什么时候用”,Kiro 靠它决定是否激活 skill
- 依赖规范:列出所有引用的 rules 和其他 skill,确保单独使用时能加载完整上下文
- 步骤:加上“每个步骤先输出标题,再输出结果”,防止 AI 跳步
- 引用一致:文字里提到的规范名称,必须在依赖规范里有对应的 #[[file:]]
- 写入文档:如果步骤涉及写文档,加上“路径遵守 project-structure 文档存放规范”
- 阶段结束:如果是流程阶段 skill,末尾加“下一阶段”和 stage-gate 引用
规则文件
通用规则放在 skills/rules/ 目录,不是独立 skill,被其他 skill 通过 #[[file:]] 引用:
skills/rules/
<rule-name>.md
规则文件同样需要 frontmatter(name + description),但不需要步骤和输出。
适用场景
适用于需要按统一规范创建或修改项目文档的场景,尤其是需要保证文档普适性、可独立理解、引用一致,以及防止 AI 在编写过程中跳步的情况。
限制
资料未提供该技能的具体收费、价格、平台支持范围或效果数据,暂未提供相关信息。