[{"data":1,"prerenderedAt":69},["ShallowReactive",2],{"header-counts":3,"footer-counts":6,"prompt-doc-generation":9},{"tools":4,"reviews":5},65,7,{"tools":4,"reviews":5,"playbooks":7,"news":8},10,8,{"id":10,"title":11,"body":12,"description":54,"extension":55,"meta":56,"navigation":57,"path":58,"seo":59,"stem":60,"tags":61,"targetTools":64,"__hash__":68},"prompts\u002Fprompts\u002Fdoc-generation.md","技术文档生成 Prompt：让 AI 写出人能看懂的文档",{"type":13,"value":14,"toc":47},"minimark",[15,19,23,27,38,41,44],[16,17,18],"h2",{"id":18},"用法",[20,21,22],"p",{},"把代码 \u002F API \u002F 功能描述粘进来，配合下面的 prompt。",[16,24,26],{"id":25},"prompt","Prompt",[28,29,35],"pre",{"className":30,"code":32,"language":33,"meta":34},[31],"language-text","帮我把以下内容写成技术文档。不要写成说明书（「X 是一个用于 Y 的工具」），写成任务指南（「你想做 Z？这样做」）。\n\n## 文档结构\n\n### 这个文档解决什么问题\n（1 句话：读者看完能做什么）\n\n### 30 秒上手\n（最小可运行示例，不超过 5 步，能 copy-paste 直接跑）\n\n### 常用操作\n（按使用频率排序，不是按功能分类排序。每个操作格式：）\n- **做 X**：`命令或代码` → 预期结果\n- **做 Y**：`命令或代码` → 预期结果\n\n### 常见问题\n（列出 3 个最可能遇到的报错，每个给解决方案。不要列「什么是 X」这种概念问题）\n\n### 进阶\n（只给链接和一句话描述，不要在这里展开。读者需要时会自己点进去）\n\n## 规则\n- 不要写「概述」「背景」「设计理念」——没人看\n- 代码示例必须能直接运行，不能有伪代码\n- 如果某个操作需要前置条件，在步骤里写明\n- 中文输出，代码注释也用中文\n\n---\n\n内容来源：\n（粘贴你的代码 \u002F API 定义 \u002F 功能描述）\n","text","",[36,37,32],"code",{"__ignoreMap":34},[16,39,40],{"id":40},"效果",[20,42,43],{},"不加 prompt 时 AI 写的文档通常是：「X 是一个强大的工具，它提供了 A、B、C 功能……」——正确但没人看。",[20,45,46],{},"加了这条 prompt 后输出变成任务导向：「你想部署？这样做。你想调试？这样做。」——读者可以直接找到自己要做的事。",{"title":34,"searchDepth":48,"depth":48,"links":49},3,[50,52,53],{"id":18,"depth":51,"text":18},2,{"id":25,"depth":51,"text":26},{"id":40,"depth":51,"text":40},"让 AI 写文档经常得到一堆正确的废话？这条 prompt 强制 AI 写「任务导向」的文档——读者要做什么、怎么做、出错怎么办。","md",{},true,"\u002Fprompts\u002Fdoc-generation",{"title":11,"description":54},"prompts\u002Fdoc-generation",[62,63],"文档","写作",[65,66,67],"Claude","Cursor","ChatGPT","xX6RP5p3rfZBcAinqMoi6uO6AXqqeLsB_0-4RvXcNZ4",1782316489338]