mcpField
D
doc-condenser

doc-condenser

github.com/mathews-tom文档处理33799 次安装2 天前更新
代码仓库

关于 doc-condenser

这是一项已弃用的技能,用于将技术文档压缩为面向开发者的简明规格,同时保留路径、指标和示例代码。它面向处理文本文档的开发者,并遵循指定结构和篇幅目标。

主要功能

  1. 01优先保留路径和指标
  2. 02将说明文字改为表格
  3. 03保留精简代码示例
  4. 04按规则保留、压缩或删除
  5. 05采用指定的输出结构

适用场景

  1. 01压缩冗长的技术规格
  2. 02整理实现文件引用
  3. 03将检查清单转为状态表格

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/mathews-tom/armory --skill doc-condenser

安装后在 Claude Code 中输入/doc-condenser确认已加载。

包含的文件

除 SKILL.md 外,安装时一起下载的参考资料和脚本。

assets/
template.md
evals/
cases.yaml
references/
style-guide.md

详细介绍

已弃用 — 现代 Claude 模型可原生压缩并总结技术文档,且质量相当。此处编码的输出格式偏好(长度上限为 40%、优先使用表格而非正文、路径优先)过于通用,不足以抵消技能开销。仅为存档参考而保留。

文档精简器

将冗长的技术文档转化为简洁、面向开发者的规格说明。

核心原则

  1. 路径优先 — 每个文件引用都包含完整路径或相对路径
  2. 优先使用表格而非正文 — 使用表格呈现指标、覆盖情况和文件列表
  3. 保留代码示例 — 保留简短、说明性的代码片段;删除冗长示例
  4. 提供背景,而非解释 — 使用简短的背景说明句,而非段落
  5. 历史内容仅用一行概述 — 引用旧文档,不保留其内容

输出结构

# [path/to/output.md]

# [Title] - [Subtitle if needed]

## Purpose

[2-3 sentences: what this is, why it exists, key design principle]

## Status

[Table: metrics, rates, performance]

## Architecture Overview

[Optional diagram or brief flow description]
[Only if it aids understanding]

## Implementation Files

[Grouped by category with paths and one-line descriptions]

## [Domain-Specific Sections]

[Tables, code snippets, brief commentary as needed]

## Quick Reference

[Box or code block with key stats for scanning]

请参阅 assets/template.md,其中提供了可直接复制使用的结构模板。

转换规则

保留
  • 文件路径(始终使用完整路径或项目相对路径)
  • 指标和测量数据
  • 展示模式且少于 15 行的代码片段
  • 架构示例和数据结构
  • 覆盖情况/状态表
精简
  • 多段解释 → 1-2 句话
  • 冗长示例 → 代表性代码片段 + “更多内容请参阅 X”
  • 实施检查清单 → 完成状态表
  • 长篇理由说明 → 单行“设计原则:X”
  • 超过 20 行的代码片段 → 精简为核心模式 + 指向源文件的引用注释
  • 同一观点在超过 3 句话中反复表述的理由说明部分 → 合并为一行“设计原则:”
删除
  • 除一行引用外的历史背景
  • 关于已实现/已完成的庆祝性表述
  • 对同一概念的重复解释
  • 分步教程(改为链接到教程)
  • “经验总结”回顾
格式
  • 使用 代码块 展示路径和命令
  • 按标题归类相关文件
  • 结构化数据优先使用表格,而非项目符号列表
  • 末尾添加快速参考块,便于浏览

处理现有文档

精简现有冗长文档时:

  1. 明确核心目的(输出的第一段)
  2. 将所有文件路径提取到分组表格中
  3. 保留展示模式的代码示例
  4. 尽可能将正文部分转换为表格
  5. 添加单行历史引用
  6. 验证关键技术细节没有丢失

风格指南

详细的格式规则、表格模式和代码示例指南,请参阅 references/style-guide.md。

转换示例

转换前(冗长):

We have successfully achieved and EXCEEDED the original goals of this specification!
After many iterations and improvements, our automation rate reached 96.6% which is
above our target of 95%. The team worked hard on this and we're very proud...

转换后(简洁):

**v31 PRODUCTION** | 96.6% automation (target: 95%)

校准规则

  • 按词数计算,精简后的输出不得超过源文档长度的 40%。
  • 原文中出现的所有文件路径都必须出现在精简后的输出中——绝不能删除路径。
  • 绝不直接删除代码块;应提取代表性模式以缩短内容,并添加源文件引用注释。

错误处理

  • 源文档没有明确目的:精简前请先询问一句话的背景说明——不得自行推断目的并继续。
  • 某一部分的条目难以判断应保留还是删除:默认保留,并在输出中使用 `` 注释标记该部分。
  • 验证时发现精简结果丢失了所需技术细节:恢复被省略的细节,并重新测量是否符合 40% 的长度上限;若无法满足上限,则在正文中说明例外情况。
  • 源文档不包含文件路径:完全跳过“实施文件”部分,不要生成占位路径。
  • 源文档为非文本格式(图像、图表、电子表格):说明该格式不受支持,并直接返回。
  • 风格指南与源文档的格式惯例冲突:遵循 references/style-guide.md,并在输出顶部注明此处采用了不同格式。

限制

  • 仅适用于文本文档;无法浓缩图像、图表和二进制文件。
  • 压缩比例取决于源内容的冗长程度——高度结构化的内容压缩幅度较小。
  • 样式指南(references/style-guide.md)优先于源格式,因此可能会更改标题级别和表格布局。
  • 不会跟随超链接或获取引用的外部文档;会注明引用内容,但不会内联其中的内容。

评论

支持 Markdown