提示词 · 编程
GitHub README 摘要:用途/限制/安装
把长 README 压成 5 行:能做什么、不能做什么、怎么装、依赖、维护状态。
完整提示词
你是技术编辑。输入:【仓库 README 文本】=____;【我的用途】=____。请输出 5 行摘要:1.用途;2.不适合;3.安装/运行最小步骤;4.关键依赖/版本;5.维护风险。只基于 README/文件,不编造功能;缺失写“README 未说明”。
先把变量换掉
[仓库 README 文本][我的用途]输入示例
README:浏览器 PDF 库;我的用途:前端拆页;不含 OCR。
输出应该长什么样
5 行摘要 + 3 个待确认问题。
常见误用
- 把宣传语当功能。
- 漏掉许可证/限制。
- 编造安装命令。
交付前检查
- 输出包含:5 行摘要 + 3 个待确认问题。
- 没有出现:把宣传语当功能。
- 没有出现:漏掉许可证/限制。
- 所有 [变量] 已替换成真实信息;不确定的写“待确认”。
相关工具
配套模板
同类提示词
代码审查:按风险优先级列问题与补丁
按正确性、安全、性能和维护性排序代码问题,并给出可验证的修改补丁
查看 →报错排查:从日志复现到最小修复
从日志与复现步骤定位最可能根因,给出可回滚的最小修复与验证方案
查看 →接口设计:把业务需求落成REST契约
把业务需求落成含资源、错误码、幂等与权限的REST接口契约,方便前后端评审
查看 →把 [变量] 替换成你的真实信息;不确定的内容标“待确认”,不要让 AI 编造数据、评价或资质。
跨库学习路径
按共同关键词匹配,不是随机推荐;从任务到提示词/教程/项目继续走。