SuperAPI AI 工具集

cmd-docs-idiot-proof

写作与研究

查看项目

更新于 10-16 02:37

技能介绍

用途:该技能用于编写或重写文档,使文档对人和智能体都更简单、快速可扫读、易于执行。核心倾向是简单文档,从最短成功路径开始,在保留原意和事实内容的前提下重新排序以提升清晰度。

主要能力与输出顺序:要求按固定顺序组织内容——Quickstart(始终第一)、主工作流、配置/参考表格(相关时)、替代路径(仅当确为真实的用户或代码路径替代时)、其余细节放在末尾的 <details><summary>...</summary>...</details> 中。

审批门(必需):编辑任何文件前,必须展示变更预览供批准。每个文件使用固定预览结构:Additions、Removals、Changes,并展示将要添加、删除或修改的具体文本;等待用户明确批准后才应用编辑,且只应用已批准的编辑;未获批准不得修改文件。

核心规则:兼顾人类与智能体读者;尽量提供可直接复制粘贴的命令片段;偏好短小节和简洁语言;结构化信息用 Markdown 表格;有助于理解流程或架构时用 Mermaid 图;避免不必要的小节;除非是真实替代路径,否则避免“Optional”小节;把多余或背景材料放到末尾;仅当仓库布局有助于完成任务时才添加“Code Structure”。

命令块规则(严格):bash 代码块内不得放注释,标签放在代码块外。正确模式为标签加代码块,例如“Start the server:”后接 make start_server;错误模式是把多个步骤合并在一个无标签代码块中。

小节默认值:仅使用对具体文档有价值的小节,默认集合为 Quickstart、Main Workflow、Configuration、Code Structure(仅在有帮助时)、Troubleshooting(仅针对真实反复出现的问题)。配置表格格式为 Name、Purpose、Default 三列,例如 APP_ENV 对应 Runtime environment 与 development,API_URL 对应 Base URL for API calls 与 http://localhost:8000。

交付物:最终输出为 Markdown(.md),保留所有重要内容,但为快速执行而简化、重排并区分优先级。

限制:资料未提供具体安装命令、收费、价格、平台或效果信息;该技能依赖用户审批流程,未获批准不会修改文件。