prompt-writer-skill
v0.1.4
Published
Codex skill for turning rough requirements into high-quality AI prompts.
Maintainers
Readme
Prompt Writer Skill
Prompt Writer Skill 会把“我大概想做这个”的笔记,整理成包含角色、上下文、约束、输出格式和质量检查的可执行提示词。
你不需要再为“如何写好提示词”单独设计一段提示词。只要在 Codex 或 Claude Code 中调用 $prompt-writer 或 /prompt-writer,就能得到可以直接复制使用的结果。
为什么需要它?
最近,AI 的使用方式已经不再只是“写出好提示词”。它正在扩展为 harness engineering,也就是把上下文、工具、验证和自动化流程一起设计。
但这并不意味着提示词工程已经不重要了。相反,提示词更像是 harness 内部的核心模块:它定义模型的角色、任务范围、输入解释方式、输出格式和验证标准。
工具越多、执行环境越复杂,就越需要清楚地定义应该把什么交给 AI。Prompt Writer Skill 正是为此而创建的。它会把粗略需求整理成包含角色、上下文、约束、输出格式和质量检查的可执行提示词。
| 问题 | 直接请求时 | 使用 Prompt Writer Skill 时 | | :--- | :--- | :--- | | 需求模糊 | 模型会猜测缺失信息,结果容易漂移 | 重写为目标、上下文、约束和输出格式 | | Harness 设计和提示词分离 | 虽然有工具和上下文,但模型具体要做什么并不清楚 | 在提示词中明确任务范围、输入解释方式和输出标准 | | 目标 AI 不同 | ChatGPT、Claude、Codex 使用同一段话 | 根据工具和执行环境调整表达和结构 | | 没有输出形状 | 回答容易变长,或者每次格式都不同 | 明确章节、JSON、清单或 schema | | 没有验证标准 | 停在“看起来不错” | 加入测试、评估标准或检查项 | | 提示词不可复用 | 每次都重新写类似的提示词 | 整理成带变量、示例和 eval 的模板 |
研究基础
Prompt Writer Skill 不是随手整理的提示词技巧集合,而是基于官方文档和公开实践笔记整理出来的 skill。
| 来源 | 反映到 skill 中的内容 |
| :--- | :--- |
| OpenAI API Prompt engineering | 清晰指令、输入/输出分离、结构化响应、评估标准 |
| OpenAI ChatGPT 提示词最佳实践 | 角色、上下文、示例、约束、语气和格式 |
| OpenAI API 提示词最佳实践 | 适合 API 复用的指令、示例和输出约定 |
| OpenAI Playground 提示词管理 | 变量、版本管理、对比和评估流程 |
| Anthropic Claude 提示词最佳实践 | 适合 Claude 的明确指令、XML 标签和长文档结构 |
| swyxio/ai-notes | 文本、代码、图像提示词的实践模式,以及 unknown/unsure 处理 |
| OWASP Top 10 for LLM Applications | 搜索、RAG、工具调用类提示词中对不可信外部输入的防护边界 |
因此,它不只是把文字润色得更好看,而是会根据目标 AI 和使用场景选择不同的提示词结构。
快速开始
需要:
- Node.js 18 或更高版本
- Codex 或 Claude Code
最简单的安装方式:
npx prompt-writer-skill@latest全局安装:
npm install -g prompt-writer-skill安装脚本会把 skill 文件复制到:
| 工具 | 安装路径 |
| :--- | :--- |
| Codex | ${CODEX_HOME:-~/.codex}/skills/prompt-writer |
| Claude Code | ${CLAUDE_CONFIG_DIR:-~/.claude}/skills/prompt-writer |
安装后请重启 Codex 或 Claude Code。
验证安装
| 工具 | 验证方式 |
| :--- | :--- |
| Codex | 在可用 skills 列表中确认 prompt-writer |
| Claude Code | 运行 /skills,或询问当前可用的 skills |
这个 skill 不会自动介入。它只会在你显式调用 $prompt-writer 或 /prompt-writer 时运行。
用法
主语言选择
在请求中指定主语言后,skill 会用该语言完成确认问题、假设、章节标题和最终提示词。支持的语言是韩语、英语、简体中文和日语。如果没有指定,skill 会沿用最新请求的语言。
$prompt-writer
主语言:简体中文
为编码 Agent 创建一段提示词,用来修复这个仓库中不稳定的测试。代码、文件路径、命令、JSON key 和引用文本在没有额外要求时会保留原文。
在 Codex 中通常使用 $prompt-writer。
$prompt-writer
帮我写一段可以交给 Codex 的提示词,用来修复这个仓库里的 bug。
要求:分析根因、做最小安全修改、运行测试、总结修改文件。在 Claude Code 中通常使用 /prompt-writer。
/prompt-writer
把下面内容改成适合 Claude 的研究提示词。
主题:B2B 客户 onboarding checklist。
要求:证据优先、分章节输出、明确处理不确定信息。默认输出便于复制:
可直接使用的提示词:
[最终提示词]
假设:
- 仅在有帮助时显示
确认问题:
- 仅在答案会显著改变提示词时显示示例
编码 Agent
$prompt-writer
创建一段提示词,让 Codex 修复登录失败 bug。
必须先检查相关文件,保持现有风格,只添加聚焦的测试,
并报告实际运行的验证命令。OpenAI API
$prompt-writer
创建一个 OpenAI API 提示词,把客户消息分类为 urgent、normal 或 low。
响应必须只包含 JSON,置信度低时允许返回 unsure。研究
$prompt-writer
为 Claude 创建一个市场研究提示词。
主题是韩国 B2B SaaS onboarding 案例。请区分事实和推论,
引用来源,证据不足时返回 unknown。图像生成
$prompt-writer
为商品详情页创建一段图像生成提示词。
产品是极简桌灯。白色背景、自然光、正面 3/4 角度,
图片内不要出现文字。支持的提示词类型
| 类型 | 生成内容 |
| :--- | :--- |
| 通用 AI 任务 | 面向 ChatGPT 或 Claude 的角色、任务、上下文和输出格式 |
| 编码 Agent | 仓库检查、限定范围修改、测试和变更总结 |
| OpenAI API | developer/user 分离、变量、JSON schema、示例和 eval |
| 研究/RAG | 来源优先级、引用、不确定性处理和 prompt-injection 边界 |
| 抽取/分类 | 允许值、字段说明、示例和 unknown/unsure 处理 |
| 图像/视频 | 主体、构图、风格、光线、镜头和负面约束 |
| 可复用模板 | 变量、质量标准、失败案例和发布前检查 |
工作方式
- 确认用户选择的主语言,或根据最新请求推断主语言。
- 识别目标 AI 或执行环境。
- 提取用户的真实目标、上下文、输入材料和约束。
- 为任务选择合适的提示词结构。
- 在有用时应用 OpenAI/Claude 官方提示词指南和实践模式。
- 用所选主语言返回最终提示词、假设,以及必要的确认问题。
对于复杂任务,skill 可以参考 skills/prompt-writer/references/official-prompting-playbook.md 和 skills/prompt-writer/references/ai-notes-patterns.md。对于简单任务,它会保持输出简洁。
获得更好结果
如果有以下信息,可以一起提供:
- 目标 AI:Codex、ChatGPT、OpenAI API、Claude、图像模型等
- 任务目标:写作、分析、修复、研究、生成、自动化等
- 输入材料:需求、参考文档、现有提示词、期望示例输出
- 约束:语言、语气、长度、禁止事项、输出格式
- 成功标准:必须包含的内容、测试方法、质量检查
不需要一次提供所有信息。明显的空白会用实用默认值填充,只有在答案会显著改变提示词时才会提出确认问题。
什么时候不需要使用?
简单翻译、短文案修改、明显的一次性问题,直接问 AI 更快。
这个 skill 更适合提示词结构会明显影响质量的任务、需要复用的提示词,以及出错成本较高的编码 Agent 任务。
本地开发
git clone https://github.com/Songgyubin/prompt-writer-skill.git
cd prompt-writer-skill
npm run validate检查 package 中会包含哪些文件:
npm run pack:dry-run项目结构
prompt-writer-skill/
├── skills/prompt-writer/SKILL.md
├── skills/prompt-writer/agents/openai.yaml
├── skills/prompt-writer/references/
│ ├── official-prompting-playbook.md
│ └── ai-notes-patterns.md
├── scripts/install-skills.mjs
├── scripts/validate-package.mjs
├── .codex-plugin/plugin.json
└── package.json发布说明
发布前运行:
npm run validate
npm run pack:dry-run推送到 main 后,GitHub Actions 会验证 package,并通过 npm Trusted Publishing 发布。npm 上已经存在的版本会被跳过。
如需发布新变更,请同时更新 package.json 和 .codex-plugin/plugin.json 中的 version,然后合并到 main。
License
当前 package 的 license 是 UNLICENSED。
