directory-summary

根据已有文件或目录生成目录级 .abstract.md 和 .overview.md,帮助判断相关性、选择阅读内容,完整原文按需读取。

SKILL.md

GitHub

目录摘要

生成要求

  • 对选定目录生成 .abstract.md 和 .overview.md。L2 是完整原文,保留原位置,不改写或复制。
  • 按内容类型选择下列摘要要求。文件摘要和子目录摘要作为生成目录概览的材料,不要求分别保存。
  • 先构建 L1 .overview.md,再从其简要描述提炼 L0 .abstract.md;已有 L1 时直接提炼。L0 用一句话说明主题、用途和范围,不增加 L1 未包含的信息。
  • 只描述实际读取的内容,保留影响选择的条件和准确引用。覆盖不完整时说明范围;空文件不编造内容;生成的摘要不再次当作原文输入。
  • 单文件输入的摘要落点、递归深度和已有摘要的覆盖方式,以用户指定为准。未指定时列为待选项,不自动递归或覆盖。

文件摘要要求

阅读给定文件,使用指定语言生成摘要。

输出要求:

  • 50~150 个词,直接输出纯文本,不使用 Markdown。
  • 说明文件是什么、覆盖什么;用途仅在正文明确时说明。
  • 保留正文中的核心关键词。

文档摘要要求

阅读给定文档,使用指定语言概括内容结构、主要主题和要点。

输出要求:

  • 60~180 个词,直接输出纯文本,不使用 Markdown。
  • 先用一句话说明主要目的,再概括章节及其关系、重要概念、定义或解释和关键信息。
  • 说明文档类型,保留语义检索关键词。
  • 目标读者、前置知识和使用场景仅据正文提取。
  • Markdown 关注标题层次;API 文档关注功能、参数和返回值;教程关注步骤和学习目标;参考文档关注覆盖范围和组织方式。

技能概览要求

依据技能名称、描述和完整内容,提取便于检索的信息。

输出要求:

  • 何时使用:使用场景和触发条件。
  • 如何使用:主要功能和核心操作。
  • 为什么使用:解决什么问题。
  • 关键特性:重要工具、方法和最佳实践。
  • 简洁清楚,不照抄原文,突出检索信息,避免过多代码细节。
  • 不超过 1,000 tokens,直接输出概览正文。

目录概览要求

依据目录名称、文件摘要、子目录摘要和覆盖情况生成概览。统一使用指定语言。输入是代码结构骨架时,将其作为文件结构说明理解。

输出要求:

  • 输出 Markdown,共 400~800 个词,一级标题使用目录名称。
  • 标题后直接写 50~150 个词的简要描述,不另加二级标题。说明主题、范围、用途、关键词及有来源依据的使用场景和适用读者,不包含数量统计。
  • 后续依次为目录覆盖情况、快速导航、详细说明。
  • 覆盖情况说明直接子项总数和实际覆盖范围;仅有样本时,说明已提供和未逐项检查的数量。
  • 快速导航采用决策树。围绕读者想了解或完成的事,用箭头指向具体文件或目录,附简短关键词说明。
  • 使用输入提供的目标链接,链接名称自然,不重复堆叠名称。
  • 每个已提供的文件或子目录使用带链接的三级标题分别说明。仅有样本时,说明详细介绍只覆盖这些样本。

关系与忠实性要求:

  • 子目录默认属于同一整体;仅在来源明确时将其视为独立项目。代码仓库应说明子目录与整体的关系。
  • 只描述输入摘要支持的内容,不编造名称、事实或关系,不用外部知识补全空白。此要求同样适用于前述摘要。
  • 仅有样本时,可用"样本显示"等限定语概括目录,不声称已经检查全部内容,也不描述未提供条目的具体内容。