关于 markdown-drafts
markdown-drafts 是面向 Agent 的写作技能,适用于起草要放入外部系统的内容。它规定 Markdown 结构,并要求用代码围栏保留原始标记,便于复制。
主要功能
- 01草稿采用 Markdown 结构
- 02代码块标注语言
- 03标识符和命令使用行内代码
- 04提供列表、表格和链接规范
- 05用代码围栏呈现可复制源码
适用场景
- 01起草 GitHub Issue 和 Pull Request
- 02准备 Jira 工单或 Wiki 页面
- 03撰写设计文档和 RFC
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ cloudflare/ workerd --skill markdown-drafts安装后在 Claude Code 中输入/markdown-drafts确认已加载。
详细介绍
Markdown 草稿
当用户要求你起草、撰写或编写将复制到外部系统的内容时——例如 GitHub issue、拉取请求描述、Jira 工单、wiki 页面、设计文档、RFC 或类似内容——始终使用 Markdown 语法,确保格式在复制粘贴后仍然保留。
适用场景
- GitHub issue 和拉取请求描述
- Jira 工单描述和评论
- Confluence / wiki 页面草稿
- 设计文档和 RFC
- Slack 消息(Slack 支持渲染部分 Markdown)
- 用户明确表示要复制到其他位置的任何内容
格式规则
- 使用
#、##、###标题来构建内容结构 - 无序列表使用
-或*,有序列表使用1. - 代码使用带语言标签的三个反引号围栏代码块(例如,
```cpp) - 标识符、文件路径、命令和配置值使用
inline code反引号 - 用
**粗体**强调重点,用_斜体_表示次要强调 - 展示结构化比较或数据时使用 Markdown 表格
- 使用
> 引用块添加提示、引用文本或重要说明 - 使用
[链接文本](url)添加参考链接——不要在正文中直接写裸 URL - 适当时使用
---水平分隔线分隔主要章节 - 起草行动项或检查清单时使用任务列表(
- [ ]/- [x]) - 保持行长合理(例如,80-120 个字符)
结构指南
- 先用简洁的摘要段落开篇,再展开细节
- 使用标题划分内容,方便快速浏览
- 段落要简短——在 issue 跟踪器中,大段文字不易浏览
- 将最重要的信息放在前面(倒金字塔结构)
- 相关时以接下来的步骤、待解答的问题或行动项结尾
渲染:始终输出原始 Markdown
聊天界面会渲染 Markdown,从而移除原始语法(###、**、` 等)。由于这些草稿需要复制粘贴到外部系统,用户需要保留原始标记。
始终将整个草稿放在围栏代码块中,这样聊天界面就会将其显示为纯文本。使用普通的三个反引号围栏(不带语言标签):
```
## 我的标题
- 项目一
- **粗体文本**和 `代码`
```
这样可以确保用户看到并复制到准确的 Markdown 源码。不要在代码围栏之外将草稿渲染为格式化文本——标记会被聊天界面悄悄移除。
注意事项
- 不要在代码围栏之外将草稿渲染为格式化 Markdown——用户会丢失语法标记
- 不要使用纯文本格式(例如,用全大写字母作为标题、用
====做下划线、手动缩进) - 除非目标系统要求使用 HTML 且 Markdown 无法满足需求,否则不要使用 HTML 标签
- 除非用户的草稿风格包含表情符号,或用户明确要求,否则不要添加表情符号
- 不要使用常见的、由 AI 生成的陈词滥调、套路或填充内容,例如三段式排比或泛泛的开头和结尾。保持简洁、切题。
- 不要添加编辑性评论或未经证实的说法。严格遵循事实和用户指示。如需澄清,请先提问,不要自行假设。
评论
支持 Markdown