文案写作 通用 中文 English 文档撰写者 为此仓库编写/更新文档:[README / API 文档 / 设置指南 / CONTRIBUTING]。好的文档应当准确、 生成后的提示词 为此仓库编写/更新文档: `[README / API docs / setup guide / CONTRIBUTING]`。好的文档应当准确、 诚实,并且便于快速浏览。绝不要编写听起来自信却言之无物的文档。 ## 步骤 1. **先验证** - 在声称命令可用之前,实际运行你记录的命令(安装、构建、 运行、测试),或阅读代码。一份写着 `npm install && npm start` 的文档,必须是你已经确认过的路径。检查现有 文档中过时的说明并加以更正。 2. **为读者而写** - 读者是带着与你完全相同任务的新手: 他们需要按顺序知道什么才能成功。先给出用一句话说明的价值。然后是快速开始,再是细节。不要大段文字——使用简短小节、 列表和代码块。 3. **展示真实示例** - 使用与代码实际行为相符的具体示例。在有帮助的地方复制真实输出。不要编造不存在的标志、选项或边界行为。 4. **匹配项目的语气和风格** - 模仿仓库文档中已有的语气、标题风格 和格式约定。与现有的 README/CHANGELOG/CONTRIBUTING 保持一致。 5. **保持内容最新** - 如果你在编辑现有文档,删除现在已经错误的内容,而不要只是追加。检查代码示例、链接和版本引用是否仍然成立。 6. **覆盖真实的摩擦点** - 仅为真正常见的问题加入故障排除,来源于真实经验(或明确已知的问题),而不是编造的 FAQ 填充内容。 ## 验证 - [ ] 文档中的每条命令都实际运行过,并且捕获了其输出。 - [ ] 每个示例都与代码的实际输出相符,而不是理想化版本。 - [ ] 标题风格、语气和术语与项目现有文档一致。 - [ ] 过时内容已被删除,而不是与新文本并存。 - [ ] 故障排除覆盖来自代码和问题历史的真实摩擦点,而不是编造的问题。 - [ ] 文档中没有任何内容在代码中不存在,也没有遗漏新手所需的任何设置步骤。 ## 规则 - 绝不要记录不存在的功能,也绝不要遗漏必需的设置步骤。 - 不要复制粘贴营销套话或通用样板——说明这个项目本身做什么。 - 如果代码与文档不一致,相信代码并修正文档。 复制提示词 分享提示词 查看示例 发送到 AI 优化器 收藏模板 保存当前版本 示例 关闭 分享 卡片风格 雾面玻璃 暖白纸笺 深夜蓝图 薄荷网格 珊瑚日落 水墨笺 关闭 图片仅展示节选。