这条 Prompt 适合做什么
把模糊的代码库背景整理成面向多角色的版本说明与技术文档
开发
现在就用
直接复制
如果你只想马上开始，复制下面正文就够了。完整说明放在下方的展开区。
# 项目文档生成器 ## 使用场景 - 发布或移交前需要准确描述版本范围、特性与限制 - 需要把开发语境转换为管理层与合作方可读的说明 ## 输入字段 - repoSummary：目录结构、关键模块、依赖 - releaseScope：版本号、发布时间、必须交付的特性 - audience：目标读者（开发/产品/合作方） - constraints（可选）：安全、合规、性能指标 ## 生成流程 1. **事实采集**：依据 repoSummary 和 git 历史提取真实功能，不臆测。 2. **结构化骨架**：统一 `概览 → 架构 → 功能明细 → 使用方式 → 限制 → 下一步` 模板。 3. **多语言/多角色润色**：根据 audience 切换表达深度，可附中英文摘要。 4. **验证**：核对每个功能是否在代码中存在并附路径，必要时补充截图或命令。 ## 输出 - `/doc/<version>/project-overview.md`：面对管理层的叙述 - `/doc/<version>/technical-notes.md`：面向工程的实现细节 - `/doc/<version>/changelog.md`：严格的改动列表
最短示例
你可以这样给
repoSummary: apps/web + packages/ui; releaseScope: v0.1 搜索修复; audience: 产品+客服
你会得到
# 版本概览 - 目标：恢复搜索建议 95% 命中率。 ## 实现特性 1. suggest API 返回真实 slug。 2. 弹窗导航后关闭。
展开完整使用说明
适用目标
把模糊的代码库背景整理成面向多角色的版本说明与技术文档 项目文档生成器
你需要提供
code
必填待处理/审查/改写的代码（尽量包含上下文）
language
语言/框架/运行环境
context
业务背景与约束（性能/安全/兼容性/团队约定等）
focus
本次关注点（可多选）
correctness, security, performance, readability
使用步骤
-
1
澄清目标与边界
复述目标与运行环境，提出最少关键问题，明确输入/输出与副作用边界。
-
2
扫描正确性与风险
检查边界条件、异常路径、并发时序与安全风险，指出可复现的触发路径。
-
3
给出可落地改进
按优先级给出建议；必要时提供伪代码或 diff 级改动，并说明验证方法。
-
4
用输出契约收口
以结构化格式输出结论、问题清单、建议清单与验证清单。
输出格式
请按以下结构输出： ## TL;DR（1-3 行） - 结论与最高优先级问题 ## Issues（按 P0/P1/P2 分组） - [P0] 问题：… - 影响：… - 证据/触发路径：… - 建议：… ## Suggested Changes（可选） - 可直接应用的修改建议（伪代码或 diff 片段） ## Verification Checklist - [ ] 单元测试/用例 - [ ] 边界条件 - [ ] 性能/安全验证 ## Questions（若缺上下文） - 仅列出最少、最关键的问题
自查清单
- 是否明确了输入/输出与副作用边界？
- 是否指出了可复现的 bug/风险触发路径？
- 是否覆盖了安全与依赖风险？
- 是否给出按优先级排序的可执行建议？
- 是否给出验证清单（测试/指标/回归点）？
使用提示
- 引用真实文件路径或命令，避免假设功能
- 读者不同就提供不同深度，但所有内容共用同一事实基础