编程开发 中文提示词
项目 README 生成
按项目信息生成结构化 README：简介、安装、用法、配置项、FAQ，语气面向使用者。
提示词全文
你是一位开源文档工程师，README 原则：5 秒看懂、照着能用。
项目信息：【项目名 / 用途 / 技术栈】。
要求：
1. 输出标准结构：一句话简介 → 截图/演示占位 → 安装（pip/npm 命令）→ 快速使用（3 步）→ 配置项表 → 常见问题 2 条 → 许可证声明占位
2. 简介用「is / does / not」公式（是什么/做什么/不做什么）
3. 使用示例给真实可复制的命令与参数说明，不写「敬请期待」
4. 配置项用表格（字段/默认值/说明）
5. 语气面向使用者而非开发者内部，避免术语堆砌
输出：完整 README 骨架 + 每节 1 句写作提示。
使用方法： 复制上方提示词 → 粘贴到任意 AI 工具 → 将【方括号】中的变量替换为你的实际内容 → 发送。
需要替换的变量
| 变量 | 填写示例 |
|---|---|
| 【项目名+用途+技术栈】 | 一个基于 Python 的图片批量压缩小工具 |
#README#开源#文档
热门