cmd-idiot-proof-docs

用途：编写或重写文档，使其面向人类和智能体都更简单、便于快速扫读和直接执行。核心倾向是简化文档，从最短可行路径开始，在保留原意与事实内容的前提下重新排序以提升清晰度。\n\n输出顺序固定：Quickstart 永远放最前，然后是主工作流、配置/参考表格（相关时）、替代路径（仅当确为真实的用户或代码路径替代时），其余细节放到末尾的 <details><summary>...</summary>...</details> 中。\n\n审批门（必需）：编辑任何文件前，先展示变更预览并等待用户明确批准。每个文件使用固定预览结构：Additions、Removals、Changes，并展示将要添加、删除或修改的具体文本。只有获得批准后才应用编辑，且只应用已批准的编辑；未获批准不得修改文件。\n\n核心规则：同时优化人类与智能体阅读；尽量提供可直接复制粘贴的命令片段；偏好短段落和简洁语言；结构化信息使用 Markdown 表格；流程或架构说明可用 Mermaid 图；避免多余章节；除非是真实替代路径，否则不要写 Optional 章节；把多余或背景材料放到末尾；仅当仓库布局有助于完成任务时才添加 Code Structure。\n\n命令块规则（严格）：bash 代码块内不放注释，标签放在代码块外。正确定式例如“Start the server:”后接 make start_server，“Run a command:”后接 make run_command；不正确做法是把多个步骤合并进一个未标注的代码块。\n\n默认章节仅为对当前文档有价值的项：Quickstart、Main Workflow、Configuration、Code Structure（仅当有用）、Troubleshooting（仅针对真实反复出现的问题）。配置表格式为 Name、Purpose、Default，例如 APP_ENV 运行时环境默认 development，API_URL 接口基础地址默认 http://localhost:8000。长解释、实现说明和低优先级参考材料移入 details 块。最终交付物为 Markdown（.md），保留所有重要内容但做简化、重排与优先级处理。限制：资料未提供具体价格、平台支持范围或安装命令等额外信息。