关于 tldr-expert
tldr-expert 是用于精简技术内容的技能,可按受众调整摘要深度,并提供 PR、会议、发布说明及简报等结构化格式。
主要功能
- 01结论优先的执行摘要
- 02涵盖改动、原因和测试的 PR 描述
- 03聚焦决策与行动项的会议记录
- 04面向用户及破坏性变更的发布说明
- 05适配受众的技术简报
适用场景
- 01为审阅者总结代码改动
- 02将讨论整理为决策和行动项
- 03准备利益相关方简报
- 04撰写面向用户的发布说明
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ oakoss/ agent-skills --skill tldr-expert安装后在 Claude Code 中输入/tldr-expert确认已加载。
附带文件references/summarization-patterns.md
详细介绍
TL;DR 专家
概述
TL;DR Expert 技能可为技术内容生成清晰、简洁的摘要。它运用结构化模式提炼复杂信息,根据受众选择恰当的详细程度,生成可执行的简报。
**适用场景:**撰写 PR 描述、为审阅者总结代码变更、为利益相关者撰写执行简报、将长篇讨论提炼为决策和行动项,或生成发行说明。
**不适用场景:**撰写完整文档(使用 docs 技能)、制作营销文案、编写详细教程,或撰写需要全面覆盖内容的规范。
快速参考
| 模式 | 格式 | 要点 |
|---|---|---|
| 执行摘要 | 先结论,再证据,最后细节 | 先给出建议;采用倒金字塔结构 |
| PR 描述 | 变更内容、变更原因、测试方法 | 审阅者会先读标题和第一段 |
| 代码变更 | 变更的文件、关键决策、影响范围 | 聚焦意图,而非逐行对比 |
| 会议记录 | 决策、行动项、未解决的问题 | 略去讨论过程;记录结果 |
| 发行说明 | 面向用户的变更、破坏性变更、迁移 | 面向用户,而非开发者 |
| 技术简报 | 问题、解决方案、替代方案、建议 | 最多一页;链接到详细内容 |
常见错误
| 错误 | 正确做法 |
|---|---|
| 过于冗长,包含所有细节 | 在保留 80% 价值的同时,将篇幅压缩至原文的 20% |
| 缺少背景,假设读者已有所了解 | 在摘要前用一句话交代背景 |
| 到第三段才点明重点 | 首句说明结论或关键变更 |
| 会议记录中没有可执行的行动项 | 每份会议摘要都要列出负责人和截止日期 |
| 总结 HOW,而非 WHY | 先说明意图和影响,而非实现细节 |
| 没有考虑受众 | 调整深度:高管看 3 条要点,开发者看 1 段话 |
| 发行说明面向开发者 | 聚焦用户可以如何采取不同做法,而非代码变更 |
| PR 描述只写“各种修复” | 列出每项变更及其原因;含糊其辞对谁都没有帮助 |
| 发行说明遗漏破坏性变更 | 为破坏性变更单独设立章节,并提供迁移步骤 |
| 对非技术受众使用行话 | 根据读者的专业水平选择用词 |
委派
- 内容发现:使用
ExploreAgent 收集源材料 - 详细审阅:使用
TaskAgent 在总结前进行全面分析 - 代码审查:委派给
code-reviewerAgent 评估变更影响
如果有
docs技能,请将完整文档编写任务委派给它。
参考资料
评论
支持 Markdown