SuperAPI AI 工具集

progressive-disclosure-docs

写作与研究

查看项目

更新于 10-16 01:33

技能介绍

用途:让文档对人和智能体都易于发现、加载与执行。除用户明确要求外,应保留目标文档原有语言和风格。核心是把文档结构类比 Agent Skills 分层:发现层决定是否阅读(文件名、标题、摘要、目录);激活层完成常见任务(范围、判断规则、最短可用路径);执行层仅在需要时处理细节(命令、配置块、示例、排错);引用层保留深度但不造成杂乱(指向专题文档、附录、源文档的链接)。不要因为内容就在手边就扩充现有文档,应把内容放到未来读者自然会找的位置。

工作流:先检查现有文档、文件名、标题与当前范围,确定每份候选文档的目标读者和任务;将新内容归类(部署流程、业务逻辑或领域行为、架构或基础设施、排错证据、编码或文档规则、参考材料或示例);再决定放置位置——只有当新内容直接支撑该文档主主题时才更新现有文档,当内容引入第二主题、不同读者或可复用决策模型时新建专题文档,原文档只需提及新主题时保留为导航点。写作由浅入深:先说明用途与使用时机,常见路径先于边界情况,长命令、完整配置、历史证据与罕见情形放在主路径之后,用链接指向更深的文档。最后验证:标题与内容匹配,各小节归属正确,未来读者能凭文件名找到,删去某节不会表明它该属于别的文档。

拆分或保留:某节引入新主题则新建文档并链接;一份文档服务不同读者意图则按任务或受众拆分;配置或日志压过流程文档则移入专题文档或附录;文件名不再预示内容则改名或拆分;用户纠正放置方式则记录规则并更新结构;内容只是直接支撑该文档的短注记则保留在原文。

文档形态:专题文档建议用清晰主题名加一段说明、Summary、Common Path、Details、Verification、Related Docs;规则文档可用规则名加 Core Principles、Classification Rules、Checklist、Examples、References。但仓库已有更强本地约定时不要强行套用模板。反模式包括:把架构规则塞进部署文档、把一次性排错记录放进顶层文档、创建 notes.md、misc.md、temp.md 等含糊文件名、把关键决策藏在历史日志下、在多份文档重复同一规则、把长 README 当作所有细节的唯一归处。文件名用小写英文加连字符,如 artemis-video-gateway.md;需要时可用中文或项目母语标题;命名应体现稳定主题而非日期或临时任务;环境特定文档仅在影响含义时把环境写入文件名。

输出要求:编辑文档时说明创建或更新了哪份文档,是否把内容移出不合适的文档,保持无关文档不动;在 git 仓库中可运行 git diff --check 做轻量校验。适用场景为整理项目文档结构与拆分内容,限制是必须先检查既有文档并遵循本地约定,模板非强制。