Skip to content

mi4646/markdown-draft-curation

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

markdown-draft-curation

交互式整理不完整 Markdown 文档的 Claude Code 技能。

特性

  • 🎯 5 阶段交互式流程 - 草稿分析 → 定位确认 → 基础整理 → 逐步补充 → 最终确认
  • 📝 渐进式构建 - 不追求一次写完整,每步等待用户确认
  • 🔗 链接有效性检查 - 内置 Python 脚本,先询问用户再执行
  • 📚 完整实践记录 - 包含 FastAPI、Flask、Tauri 三个真实案例
  • 🛡️ 敏感信息保护 - 自动识别并保留敏感信息(密码、API 密钥等)
  • 🧩 模块化设计 - 核心简洁,详情可引用

安装

skill/ 目录复制到你的 Claude Code 技能目录:

# Windows
xcopy /E /I "skill" "%USERPROFILE%\.claude\skills\markdown-draft-curation"

# Linux/macOS
cp -r skill ~/.claude/skills/markdown-draft-curation

使用

在 Claude Code 中调用:

/markdown-draft-curation

然后按照提示操作即可。

项目架构

markdown-draft-curation/
├── skill/                    # ⭐ 技能模块(复制到 Claude Code 即可使用)
│   ├── SKILL.md              # 核心流程 + 快速参考(必加载)
│   ├── practice-examples.md  # FastAPI/Flask/Tauri 实践记录(可选引用)
│   ├── templates.md         # 完整模板集合(可选引用)
│   └── check-links.py       # 链接有效性检查脚本(运行时调用)
│
├── evals/                    # 🧪 测试用例(开发时使用,不需要复制)
│   ├── evals.json            # 测试定义
│   ├── test-input-1-links-only.md     # 测试场景 1:链接集合
│   ├── test-input-2-mixed-content.md  # 测试场景 2:混杂内容
│   ├── test-input-3-scattered-notes.md # 测试场景 3:零散笔记
│   ├── test-input-4-titles-only.md    # 测试场景 4:只有标题
│   ├── test-input-5-wasm-links.md      # 测试场景 5:新领域链接
│   └── test-input-6-sensitive-mixed.md # 测试场景 6:敏感混杂文件
│
├── workspace/                # 📄 测试输出(示例,不需要复制)
│   └── iteration-1/
│       ├── eval-1/  # FastAPI 完整示例
│       ├── eval-4/  # Rust 完整示例
│       ├── eval-5/  # WebAssembly 完整示例
│       └── eval-6/  # 敏感文件完整示例
│
├── README.md                 # 项目说明(本文件)
├── design.md                 # 设计文档
└── LICENSE                   # MIT 许可证

目录说明

目录/文件 是否需要复制 用途
skill/ ✅ 是 实际的 Claude Code 技能
evals/ ❌ 否 开发测试用例
workspace/ ❌ 否 测试输出示例
design.md ❌ 否 设计文档
README.md ❌ 否 项目说明

技能模块架构(skill/)

采用分模块设计,平衡简洁性和完整性:

  • SKILL.md(必加载)- 核心流程、检查清单、快速参考
  • practice-examples.md(可选引用)- 三个完整实践案例,供 AI 参考"应该怎么做"
  • templates.md(可选引用)- 完整的用户提示文本模板
  • check-links.py(运行时调用)- Python 脚本,先询问用户再执行

技能架构

skill/
├── SKILL.md              # 核心流程 + 快速参考
├── practice-examples.md  # FastAPI/Flask/Tauri 实践记录
├── templates.md         # 完整模板集合
└── check-links.py       # 链接有效性检查脚本

测试场景

项目包含 6 个测试场景:

  1. ✅ 只有链接集合的文档(FastAPI)
  2. ✅ 内容混杂的文档(Tauri)
  3. ✅ 零散笔记文档(Flask)
  4. ✅ 只有标题的文档(Rust)
  5. ✅ 新领域链接文档(WebAssembly)
  6. ✅ 包含敏感信息的混杂文档

核心原则

  1. 严格按流程执行 - 每一步必须等用户确认后再继续
  2. 内容程度动态调整 - 保持灵活,根据用户反馈随时调整
  3. 不要追求一次写完整 - 渐进式构建,迭代效率高于一次性完美
  4. 可能需要"推倒重来" - 不要害怕恢复原始状态,重新开始
  5. humanizer-zh 使用原则 - 保持专业性,去除明显的 AI 痕迹即可

设计理念

这个技能基于真实的文档整理实践经验,从 FastAPI、Flask、Tauri 等多个文档的整理过程中提炼而来。它强调用户主导渐进式构建灵活调整,而不是一次性自动完成。

相关文档

  • 设计文档:design.md
  • 测试输出:workspace/iteration-1/

许可证

MIT

About

Claude Code 技能 - 交互式整理不完整的 Markdown 文档,支持链接集合、零散笔记、草稿文件等,渐进式构建,用户主导内容深度。

Resources

License

Stars

0 stars

Watchers

0 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages