用途:在创建或编辑需要读者快速理解、记住或在评审中使用的文档时加载该技能。适用于 PR 描述与评审说明、贡献者或维护者指南、架构/工作流/入职文档,以及任何目前显得冗长、密集或难以扫读的文档。
主要能力(关键模式):先给答案,把决策、行动或结果放前面,背景放后面;渐进披露,先讲顺利路径,再补充细节、边界情况与参考;分块,把相关信息归入小段落,扁平列表保持简短;路标,用标题、标签、提示框和摘要让读者知道所在位置;识别优于回忆,优先使用表格、清单、示例和模板,而非需要记忆的散文;评审同理心,让评审者无需重建整个故事即可验证意图。
默认文档结构(除非仓库已有更强的模板):以结果为导向的标题;一段说明改了什么、帮助了谁、为何重要;Quick path 列出第一、第二步及验证或预期结果;Details 用表格呈现主题与决策;Checklist 用可勾选项让读者确认;Next step 给出延续工作流的链接或操作。
PR 与评审文档:说明先评审什么、明确哪些有意不在范围内、工作成链时链接前后 PR、每节聚焦一个决策或工作单元、用清单承载验收标准与验证步骤。
命令(保持原样):
Check markdown files changed in the current branch
git diff --name-only -- '*.md'
Inspect PR changed-line count for cognitive load
gh pr view <PR_NUMBER> --json additions,deletions,changedFiles
限制:资料未提供该技能的安装方式、支持平台、收费与价格信息,也未提供效果量化数据,这些事实暂未提供。