这个提示词用来做什么

为开源项目或内部工具补齐 README、快速上手与贡献指南。输出快速上手、目录结构、接口说明与提交规范，让新人和外部贡献者能自行跑通。说明项目用途即可，可指定面向内部还是外部用户。

提示词全文

请帮我为下面的项目编写一套规范的开源文档。

项目信息：
- 名称：{项目名}
- 简介：{一句话说明项目做什么}
- 技术栈：{语言/框架/依赖}
- 已有代码或仓库链接：{粘贴关键代码或链接，可选}

## 需要产出的文档
1. README.md：一句话简介 → 功能特性（3-6 条）→ 快速开始（安装、最小示例，命令可直接复制运行）→ 常用命令/配置说明 → 常见问题 → 许可证
2. CONTRIBUTING.md：开发环境搭建、代码风格、提交规范、提 PR 的流程与检查清单
3. 变更日志（CHANGELOG）：按 Keep a Changelog 格式，从 v0.1.0 开始，为每个版本写 Added/Changed/Fixed 三类条目

## 要求
命令与代码示例必须基于项目实际情况，不确定的配置项标「待确认」并给出查看位置，不要凭空捏造 API；英文技术名词保留原文，说明文字用中文；文档语气简洁直接，不要营销式套话。

怎么用

  1. 把上面的提示词全文复制到对话窗口或工作流里。
  2. 把花括号占位符（如 {任务描述}）替换成你自己的内容。
  3. 条目越具体，产出越稳定；不需要的条目可以直接删掉。

输出示例

输入一个 FastAPI 工具的仓库信息，输出 README、CONTRIBUTING 与 CHANGELOG 三份文档。

基本信息

  • 分类：写作
  • 标签：开源 · README · 文档 · 开发者体验
  • 收录日期：2026-08-29

同类提示词