关于 cognitive-doc-design
cognitive-doc-design 是面向文档编写与修订的写作技能，通过清晰结构和渐进呈现，帮助读者快速理解和审阅内容。
主要功能
- 01结论优先的组织方式
- 02渐进式呈现细节
- 03分组并精简章节
- 04使用标题、标签和摘要
- 05采用表格、清单和示例
适用场景
- 01撰写 PR 描述和审阅意见
- 02编写贡献者与维护者指南
- 03组织架构或入门文档
安装
复制下面的命令，在终端中运行。
$
npx skills add https:/安装后在 Claude Code 中输入/cognitive-doc-design确认已加载。
详细介绍
适用场景
在编写或编辑需要让读者快速理解、记住或用于评审的文档时，加载此技能。
尤其适用于：
- PR 描述和评审备注。
- 贡献者或维护者指南。
- 架构、工作流或入门文档。
- 任何目前篇幅过长、内容密集或难以浏览的文档。
关键模式
| 模式 | 规则 |
|---|---|
| 开门见山 | 先给出决定、行动或结果，再补充背景。 |
| 渐进式展开 | 从理想路径开始，再补充详情、边缘情况和参考资料。 |
| 分块 | 将相关信息归为小节。保持列表简短。 |
| 标示导航 | 使用标题、标签、提示框和摘要，帮助读者了解当前所在位置。 |
| 便于识别，而非依赖回忆 | 优先使用表格、检查清单、示例和模板，而不是必须记忆的文字说明。 |
| 体谅评审者 | 设计文档，让评审者无需还原完整过程也能核实意图。 |
文档结构
除非代码库已有更完善的模板，否则使用以下默认结构：
# <Outcome-oriented title>
<One paragraph: what changed, who it helps, and why it matters.>
## Quick path
1. <First action>
2. <Second action>
3. <Verification or expected result>
## Details
| Topic | Decision |
|-------|----------|
| <area> | <concise explanation> |
## Checklist
- [ ] <Reader can confirm this>
- [ ] <Reader can confirm that>
## Next step
<Link or action that continues the workflow.>
PR 和评审文档
编写 PR 文档时，明确评审路径，减轻评审者的负担：
- 说明应先评审哪些内容。
- 说明哪些内容有意不在范围内。
- 如果工作分成多个 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
评论
支持 Markdown