Skip to content

yay0128/skill-document-analysis

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Document Analysis — 通用文档分析框架 (AgentSkill)

License AgentSkills

Document Analysis 是一个结构化的文档分析框架,通过标准化的识别→拆解→评价→输出流程,将任何类型的文档转化为可操作的分析结果。

🎯 典型使用场景

场景 输入 输出
"这份合同有没有坑?" 合同文本 🔴 风险清单 + 行动建议
"帮我看看这个 PRD 完整吗?" PRD 文档 📊 五维评分 + 缺失项列表
"优化这段 Prompt" Prompt 文本 🎯 CTOE评分 + 优化建议
"会议纪要有什么要点?" 会议记录 ✅ 核心决议 + 待办跟踪表
"这个 SOP 能落地吗?" SOP 文档 📋 可执行性评分 + 改进建议

📖 完整场景清单:docs/use-cases.md


📋 支持的文档类型

类型 本质 适用文档
信息传递型 传达信息 通知、公告、邮件、通报、备忘录
规则约束型 规范行为 制度、规范、合同、法律文书
执行操作型 指导操作 SOP、手册、指南、部署文档
方案设计型 描述方案 PRD、设计、架构、商业计划书
数据证明型 证明事实 财报、审计报告、票据、证件
研究决策型 产生结论 论文、白皮书、研究报告
认知沉淀型 记录认知 笔记、日记、博客、复盘

AI 文档专项:还支持分析 Prompt、Agent Skill、MCP 文档、Workflow 等 AI 相关文档。


🚀 安装方式

⭐ 一句话安装

在 Claude Code、Codex、OpenClaw 等支持 Skill 的 Agent 中,直接说:

帮我安装这个 skill:https://github.com/yay0128/skill-document-analysis

Agent 会自动 clone 到对应目录,无需手动处理路径。


手动安装

全局安装

Claude Code:

git clone https://github.com/yay0128/skill-document-analysis.git
mkdir -p ~/.claude/skills
cp -r skill-document-analysis ~/.claude/skills/

Codex:

git clone https://github.com/yay0128/skill-document-analysis.git
mkdir -p ~/.codex/skills
cp -r skill-document-analysis ~/.codex/skills/

OpenCode / OpenClaw:

skill install document-analysis

Gemini CLI:

activate_skill document-analysis

项目安装

cd your-project
git clone https://github.com/yay0128/skill-document-analysis.git
mkdir -p .claude/skills
ln -s skill-document-analysis .claude/skills/

两种安装方式对比:

全局安装 项目安装
作用域 所有项目生效 仅当前项目生效
影响范围 修改影响全局 不影响其他项目
适用场景 通用工具 项目定制

📁 项目结构

skill-document-analysis/
├── SKILL.md                          # 主 Skill 文件
├── README.md                         # 本文件
├── LICENSE                           # MIT 许可证
├── docs/
│   └── use-cases.md                 # 完整使用场景清单
├── references/
│   ├── udaf-framework.md             # 框架详解
│   ├── type1-info-transfer.md        # 信息传递型拆解法
│   ├── type2-rule-constraint.md      # 规则约束型拆解法
│   ├── type3-execution-operation.md  # 执行操作型拆解法
│   ├── type4-solution-design.md      # 方案设计型拆解法
│   ├── type5-data-proof.md           # 数据证明型拆解法
│   ├── type6-research-decision.md    # 研究决策型拆解法
│   ├── type7-cognition-sediment.md  # 认知沉淀型拆解法
│   ├── ai-docs-ctoe.md               # AI 文档 CTOE 模型
│   ├── output-templates.md            # 标准输出模板库
│   └── codex-tools.md                # Codex 工具映射
└── assets/                           # 资源文件(预留)

📊 五维评分体系

维度 0分 5分
完整性 关键信息大面积缺失 所有必要信息齐全
清晰度 表述混乱、歧义严重 表述精准、无歧义
逻辑性 逻辑矛盾、前后冲突 逻辑严密、自洽完整
可执行性 无法执行、纯理论 可直接执行
风险度 高风险、多处隐患 风险可控

评分等级:A(21-25) | B(16-20) | C(11-15) | D(6-10) | E(0-5)


🔧 分析方法

七种专属拆解方法

  1. 5W1H法 — 信息传递型
  2. 规则边界法 — 规则约束型
  3. 流程节点法 — 执行操作型
  4. 方案论证法 — 方案设计型
  5. 证据链法 — 数据证明型
  6. 论证链法 — 研究决策型
  7. 认知提炼法 — 认知沉淀型

AI 文档 CTOE 模型

对 AI 相关文档(Prompt/Agent Skill/MCP/Workflow),额外评估:

  • C — Context(上下文)
  • T — Task(任务目标)
  • O — Output(输出格式)
  • E — Evaluation(验收标准)

📝 标准输出格式

## 一句话总结
[核心内容]

## 核心要点
1. ...

## 风险提示
1. 🔴 [高风险]
2. 🟡 [中风险]

## 行动建议
1. ...

## 后续跟踪
| 事项 | 时间节点 | 责任人 | 状态 |

🛠️ 开发说明

遵循 AgentSkills 规范

  • SKILL.md — YAML Frontmatter + Markdown
  • references/ — 按需加载的参考资料
  • docs/ — 独立文档

三层加载机制:Metadata → SKILL.md Body → Bundled Resources


📜 许可证

MIT License | 详见 LICENSE


📚 相关资源

About

UDAF — Universal Document Analysis Framework. A structured AgentSkill for analyzing, decomposing, and evaluating any document type. 通用文档分析框架

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors