SuperAPI AI 工具集

cognitive-doc-design

办公与效率

查看项目

更新于 10-15 21:50

技能介绍

用途:在编写或修改需要读者快速理解、记忆或在评审中使用文档时加载此技能,尤其适用于PR描述与评审说明、贡献者或维护者指南、架构与工作流文档、入门文档,以及任何过长、过密或难以扫读的文档。

主要能力:用固定原则降低认知负荷。结论先行,先给出决策、动作或结果,背景放其后;渐进式披露,先走顺畅路径再补细节、边界与引用;分块,把相关信息归入小段落并控制列表长度;路标,用标题、标签、提示框与摘要指明位置;识别优于回忆,优先使用表格、清单、示例与模板;评审同理心,让评审者无需重建整个叙事即可验证意图。

默认文档结构:以结果为导向的标题;一段说明改动内容、受益对象与意义;快速路径列出第一、第二动作与验证或预期结果;细节用“主题|决策”表格;检查清单供读者逐条确认;下一步给出链接或后续动作。仓库已有更强模板时可沿用。

PR与评审文档:明确先评审什么,说明有意排除在范围之外的内容,工作分链时链接上一个与下一个PR,每节聚焦一个决策或工作单元,用检查清单承载验收标准与验证步骤。

命令示例:检查当前分支改动的Markdown文件使用 git diff --name-only -- '*.md';查看PR改动行数以评估认知负荷使用 gh pr view <PR_NUMBER> --json additions,deletions,changedFiles。

限制:资料未提供该技能的安装方式、平台支持、收费情况、具体效果数据与更多使用步骤,以上暂未提供。