← ClaudeAtlas

doc-compactlisted

文档整理与压缩。核心职责是在不丢行为信息的前提下压缩冗余文档——删复述、删死链、删历史沿革、收敛重复提醒;配套完成结构整理(纠正文档放置、重建根 AGENTS.md 索引、补 inline 指针、规范 CLAUDE.md 为单行 @*.md、判定并拆分过大项目的二级索引)和全局文档管理规范的检查/安装。当文档冗余膨胀、索引失效、AGENTS.md 膨胀、CLAUDE.md 混入杂质,或需要确认全局规范是否写清文档管理模式时使用。
x0c/doc-skills · ★ 1 · AI & Automation · score 74
Install: claude install-skill x0c/doc-skills
# doc-compact 执行前先探测实际生效的文件,不硬编码路径。 `<DOC_INIT_DIR>` 默认与本 skill 同级:`<本 SKILL.md 所在目录>/../doc-init` ## 流程 **Step 1 校验全局规范 → Step 2 只读审计 → Step 3 判定二级索引 → Step 4 修复结构 → Step 5 压缩(核心,不可跳过)→ Step 6 验证** --- ## Step 1 — 全局规范 **目标文件仅限全局 AI 指令文件**,绝不能传项目 `AGENTS.md`: ```bash # 探测全局 AI 指令文件真身(软链则跟到真身) for f in ~/.claude/CLAUDE.md ~/.codex/AGENTS.md ~/.codex/instructions.md ~/.config/opencode/AGENTS.md; do [ -f "$f" ] && readlink -f "$f" 2>/dev/null || echo "$f" done | sort -u ``` 对每个存在的全局文件运行:`python3 <DOC_INIT_DIR>/scripts/insert_doc_governance.py <全局文件路径>`。 `[跳过]` = 已最新;`[新增/升级]` = 已写入,扫一遍其余章节删旧约定。 `<DOC_INIT_DIR>` 不存在时:逐条对照 `references/standard.md` 手工比对,报告中注明「未自动校验」。 **禁止**把当前项目的 `AGENTS.md` 传给 `insert_doc_governance.py`——项目 `AGENTS.md` 存放项目规范,不是全局 AI 指令文件,写入会污染项目文档。 ## Step 2 — 只读审计 运行 `python3 scripts/audit.py [项目根]`,一次跑完机器可判的检查: - **A** CLAUDE.md 全单行 `@*.md` - **B** 无悬空 `@AGENTS.md` - **C** 无裸 `OVERVIEW.md`/`INDEX.md`;具名 `<DOMAIN>_INDEX.md` 合法 - **D** AGENTS.md 行数(> 500 行 → Step 3) - **E** 无孤儿文档(docs/specs 下未被根 AGENTS.md ∪ README ∪ `*_INDEX.md` 引用) - **F** 文件命名合规(排查 `YYYY-MM-DD-*`,review `*-review.md`) - **G** 预置折叠建议(排查 / Review 台账 ≥3 篇,建议性) - **H** doc-init 联动:反向全局引用、领域地图段存在性 → **影响 Step 4/5 保护边界** - **I** §2.5 路径存活性:对含 `§2.5 物理路径速查` 的 KB,`ls` 验证每行路径是否仍存在;STALE 路径纳入 Step 5 清理(详见 `compression-guide.md` §2.5 路径存活性验证) - **J** AGENTS.md 膨胀度量化(字符/估算 token/规则条数/强调词密度)与托管块识别:成对 `<!-- 名字:begin/end -->` 标记的块列为🔒托管块(Step 4 索引重建时原样保留,不压不删);未配对标记报❌。只认这一种 markdown 标准注释约定,其他样式