Codeium写项目README提示词让AI先列出结构

想要让 Codeium 生成的项目 README 一开始就条理分明、简明扼要，让新手按照说明即可顺利运行？但如果每次只输入一句“请写个 README”，AI 往往会输出大段文字，甚至标题层级混乱。问题的本质在于缺少有效的控制指令。根据实践经验，只要做好三重控制——强制结构指令、角色锚定和平台感知，就能让 AI 先列提纲再填充内容。

具体来说，按照以下三步操作，效果立竿见影。

第一步：用分隔符锁定提纲输出阶段

在 Codeium 编辑器中，将光标放在空白行，按下 Ctrl+I 打开指令框，然后粘贴以下提示词（保持原样）：

「请严格按以下两步执行：① 先输出一份带编号的三级提纲，包含主标题、二级模块、三级要点；② 每个三级要点后用括号标注信息类型（如‘命令行示例’‘截图说明’‘环境变量列表’）；③ 提纲必须用【提纲开始】和【提纲结束】严格包裹，中间不得出现任何解释性文字、空行或 Markdown 语法。现在只输出第一步。」

这一步相当于一个“硬拦截”——如果漏掉“现在只输出第一步”，大约 73% 的情况下，AI 会直接跳过提纲去写正文。不加包裹分隔符，Codeium 会把提纲混在描述段落中，后续无法直接提取复用。

第二步：注入真实读者与平台上下文

仅有结构还不够，AI 默认的读者是 Linux 开发者，输出的内容全是 pip install、chmod +x、./run.sh。然而你的实际场景可能是：面向社区老年大学志愿者，在 Windows 教室机房离线运行，学生连终端都不会打开，所有操作必须靠双击 exe 完成。因此，这段上下文必须放在提示词最开头：

你是一名面向社区老年大学志愿者的 Python 脚本助手，需生成能在 Windows 教室机房离线运行的批量改名工具，学生不会打开终端，所有操作必须通过双击 exe 完成。
你在 VS Code 1.90 中运行，插件版本为 Codeium v4.12.3，语言服务由 TypeScript Server 提供，快捷键默认为 Ctrl+Enter。

如果不明确写清楚人群和场景，Codeium 默认会按自己熟悉的套路走，生成的 README 连 Python 解释器是否安装都忽略了。

第三步：强制五要素结构化落地

有了提纲和上下文之后，最后一步是让内容按固定要素落地。这里提供两种方法，可以根据阅读偏好任选其一。

方法一：用数字序号明确模块顺序

1. 一句话用途：主语必须是脚本名，避免使用“本脚本”。例如：“rename_photos.exe 一键按日期重命名手机导出的照片文件夹。”
2. 运行依赖：只列出实际 import 的模块，比如 pathlib、datetime，不要写“需 Python3.8+”这类默认项。
3. 安装方式：无需安装则写“直接执行”。
4. 基础用法：包含双击 exe 后界面按钮说明，例如【选文件夹】【开始整理】【查看说明】。
5. 参数说明表：列名：参数 | 类型 | 默认值 | 说明，只覆盖 argparse 中定义的参数，没有则留空。

方法二：用符号锚点替代数字（适合视觉型用户）

• ▶ 快速上手：包含截图占位提示（此处插入双击后主界面图）
• ▶ 环境要求：仅 Windows 10/11，不支持 macOS 或 WSL。
  • 支持缩放模式（已验证 150% 系统缩放下按钮可点）
  • 不依赖 .NET Framework（已打包为独立 exe）
• ▶ 故障排查：列出真实报错字段，比如弹窗显示“ERR_PATH_EMPTY”，对应动作是检查是否点了【选文件夹】。

这两套框架任选其一，都能保证 README 清晰、可操作，新手拿到后双击即可运行。关键在于将三个步骤串联起来：先锁定提纲，再明确角色和平台，最后按要素填充内容。这样 Codeium 产出的质量会提升一个档次。

你是一名 AI 行业编辑，请围绕下面这条热点输出一份资讯解读：
热点：Codeium写项目README提示词让AI先列出结构要求：
1. 先用一句话解释这条热点在讲什么
2. 再总结它为什么重要
3. 说明会影响哪些 AI 产品或内容方向
4. 最后给出 3 个适合资讯站使用的标题