🤖 开源的AI技术笔记自动化写作工具 | 多模板 + 双模式 + 智能配图 + Obsidian强绑定
根据你的学习目标选择最适合的写作风格：
| 风格 | 适用场景 | 特点 |
|---|---|---|
| 深度理解型 | 从零学习新技术 | 7章节递进，场景驱动，原理深入 |
| 快速查阅型 | 速查手册/API文档 | 表格为主，快速定位，跳过原理 |
| 问题排查型 | 故障排查指南 | 决策树+排查步骤+临时/永久方案 |
| 对比选型型 | 技术选型对比 | 多维度对比表+决策树+加权评分 |
自动根据内容选择最佳图像风格：
| 风格 | 视觉效果 | 适用场景 |
|---|---|---|
| 工程蓝图 | 极简扁平，蓝灰色调 | 技术架构图、数据流向图 |
| 彩色插画 | 活泼明亮，紫蓝渐变 | 概念插图、场景示意 |
| 极简线稿 | 黑白线条，无填充 | 简单流程图、状态机图 |
智能识别你的需求，自动选择最佳生成模式：
Mode A: Research-Driven（调研驱动）
"帮我写一篇关于 RocketMQ 的技术笔记"
→ 自动深度调研 → 整理 → 写作 → 配图 → Review
Mode B: Idea-to-Note（Idea直出）
"整理我的Redis学习笔记：[文件路径/URL/大段文本]"
→ 跳过调研 → 解析你的资料 → 结构化 → 配图 → Review
三级智能降级策略，确保总有合适的图像：
1. 复杂架构图（>10组件） → draw.io
→ 输出 .drawio 可编辑文件 + PNG
2. 简单流程图/时序图 → Mermaid
→ Markdown代码块，Obsidian原生渲染
3. 概念插图 → AI图像生成
→ 支持LLM生图 → 直接生成
→ 不支持生图 → 降级到提示词占位符
完全为Obsidian设计，深度集成专属语法：
- ✅ Wikilinks双链：
[[RocketMQ架构]]自动关联 - ✅ Callouts警告框：
> [!NOTE]高亮提示 - ✅ Frontmatter元数据：标签、创建时间、关联笔记
- ✅ 插件兼容：draw.io插件、Mermaid原生渲染
一个文件管理所有默认行为：
# skills/config.yaml
defaults:
writing_style: deep-understanding # 写作风格
image_style: engineering-blueprint # 图片风格
review_level: strict # Review级别
phase1_mode: auto # Phase 1模式
ai_image_generation: auto # AI生图策略git clone https://github.com/Mrjlv1/tech-notes-writer.git
cd tech-notes-writer环境要求：
- Obsidian（必需）
- Obsidian draw.io 插件（可选，用于编辑.drawio文件）
- draw.io CLI：
brew install --cask drawio（可选，用于自动导出PNG）
"帮我写一篇关于 RocketMQ 的技术笔记"
系统自动：
- 识别为调研模式（Mode A）
- 选择深度理解型写作风格
- 执行深度调研 → 写作 → 配图 → Review
- 输出完整笔记初稿
"用快速查阅型写一篇 Redis 命令速查手册"
"用问题排查型写 MySQL 慢查询优化指南"
"用Idea模式整理我的笔记：/Users/me/notes/rocketmq-draft.md"
"整理这些想法：
RocketMQ是一个分布式消息中间件...
[你的笔记内容]"
"写一篇 RocketMQ 深度剖析：
- 写作风格：深度理解型
- 图片风格：工程蓝图
- Review级别：严格检查
- 模式：调研驱动"
用户请求
↓
步骤0: 模板选择 + 模式识别
├─ 加载 config.yaml
├─ 识别Phase 1模式（调研/Idea）
├─ 选择写作风格模板
├─ 选择图片风格模板
└─ 选择Review模板
↓
第一阶段：内容生成
├─ Phase 1: 深度调研（或跳过）
├─ Phase 2: 内容整理
├─ Phase 3: 场景写作
├─ Phase 4: 智能配图
└─ 🔍 Review 检查
↓
输出：初稿文档（含图像提示词）
↓
【人工审阅】
├─ ✅ 可行 → 进入第二阶段
└─ ❌ 需修改 → 返回Phase 3
↓
第二阶段：内容净化
├─ Phase 5: 文档关联维护
├─ Phase 6: 提示词备份
└─ Phase 7: 提示词清理
↓
输出：纯净文档 + 备份文件
tech-notes-writer/
├── README.md # 本文件
├── QUICKSTART.md # 详细使用指南
├── ARCHITECTURE.md # 架构设计文档
│
├── skills/
│ └── tech-notes-writer/ # 统一 Skill 根目录
│ ├── SKILL.md # 主技能入口（模板选择+双模式编排）
│ ├── config.yaml # 配置文件
│ │
│ ├── references/ # 详细参考文档（按需加载）
│ │ ├── phase1-content-generation.md # Phase 1: 内容生成规范
│ │ ├── phase2-content-cleanup.md # Phase 2: 内容净化规范
│ │ │
│ │ └── illustration/ # 配图相关文档
│ │ ├── illustration-guide.md # 配图决策树+渲染器选择
│ │ └── renderers/
│ │ ├── drawio.md # draw.io渲染器
│ │ ├── mermaid.md # Mermaid渲染器
│ │ └── ai-image.md # AI图像渲染器（含降级逻辑）
│ │
│ └── templates/ # 模板目录（步骤0动态加载）
│ ├── writing-styles/ # 写作风格模板
│ │ ├── deep-understanding.md # 深度理解型
│ │ ├── quick-reference.md # 快速查阅型
│ │ ├── troubleshooting.md # 问题排查型
│ │ └── comparison.md # 对比选型型
│ │
│ ├── image-styles/ # 图片风格模板
│ │ ├── engineering-blueprint.md
│ │ ├── colorful-illustration.md
│ │ └── minimal-lineart.md
│ │
│ └── review-templates/ # Review模板
│ ├── strict.md # 严格检查（4项20子项）
│ └── quick.md # 快速检查（2项8子项）
用户请求：
"帮我写一篇关于 RocketMQ 的技术笔记，用深度理解型"
系统执行：
- 识别模式：
research（仅提供技术名） - 选择模板：
deep-understanding - Phase 1a：深度调研RocketMQ
- Phase 1b：输出调研摘要（≥3000字）
- Phase 2-4：按7章节结构写作+配图
- Review：严格检查（4项20子项）
- 输出初稿
输出结构：
RocketMQ 深度剖析
├─ 1. 遇到什么问题（电商大促流量洪峰）
├─ 2. 没有它会怎样（同步调用雪崩）
├─ 3. 技术定义（异步消息中间件）
├─ 4. 快速上手（Producer发送消息）
├─ 5. 深入原理（架构图+存储机制）
├─ 6. 实战应用（订单解耦+削峰填谷）
└─ 7. 最佳实践（消息不丢失+顺序消息）
用户请求：
"用Idea模式整理我的笔记：./notes/redis-cache-draft.md"
系统执行：
- 识别模式：
idea（包含文件路径） - 跳过调研，直接读取文件
- 提取关键技术点
- 按模板结构化
- 补充缺失内容（对比分析、最佳实践）
- 配图+Review
- 输出初稿
用户请求：
"用快速查阅型写 Redis 常用命令速查"
系统执行：
- 选择模板：
quick-reference - 生成表格为主的速查手册
- 包含：核心API、配置片段、最佳实践Checklist
- 跳过原理深入讲解
用户请求：
"用问题排查型写 MySQL 慢查询优化指南"
系统执行：
- 选择模板：
troubleshooting - 生成排查决策树
- 包含：故障现象→可能原因→排查步骤→解决方案→预防措施
- 区分临时方案和永久方案
核心配置文件：skills/tech-notes-writer/config.yaml
| 参数 | 可选值 | 默认值 | 说明 |
|---|---|---|---|
writing_style |
deep-understandingquick-referencetroubleshootingcomparison |
deep-understanding |
写作风格模板 |
image_style |
engineering-blueprintcolorful-illustrationminimal-lineart |
engineering-blueprint |
图片风格模板 |
review_level |
strictquick |
strict |
Review检查级别 |
phase1_mode |
autoresearchidea |
auto |
Phase 1生成模式 |
ai_image_generation |
autoalwaysnever |
auto |
AI生图策略 |
ai_capabilities:
supports_image_generation: false # 当前LLM是否支持图像生成
fallback_to_prompt: true # 不支持时是否降级到提示词降级策略：
supports_image_generation: false→ 保留提示词占位符- 用户可手动使用提示词在Midjourney/DALL-E等工具生成
- 未来LLM支持生图时，只需改为
true即可自动生图
详见 CONFIGURATION.md - 17个参数详细说明
适用场景：正式发布、团队分享
- ✅ 内容逻辑一致性（5子项）
- ✅ 技术准确性（5子项）
- ✅ 场景连贯性（5子项）
- ✅ 代码示例完整性（5子项）
总计：4项20子项，耗时2-3分钟
适用场景：个人笔记、快速验证
- ✅ 技术准确性（4子项）
- ✅ 代码示例完整性（4子项）
总计：2项8子项，耗时30秒-1分钟
| 节点 | 位置 | 说明 |
|---|---|---|
| 初稿审核 | Phase 4后 | 确认初稿质量 |
| 清理确认 | Phase 5前 | 确认删除提示词 |
- ✅ 必须先备份 - 备份文件不存在则拒绝删除
- ✅ 备份验证 - 验证备份完整性和数量匹配
- ✅ 人工确认 - 必须人工确认才能删除
- ✅ 永久保留 - 备份文件永久存储
仅删除：
[🎨 生图提示词]标记和内容
保留：
> 📷 图片描述- 所有正文内容、代码示例
- 图像引用（draw.io/Mermaid）
| 文档 | 路径 | 说明 |
|---|---|---|
| 快速入门 | QUICKSTART.md | 5分钟快速开始 |
| 架构设计 | ARCHITECTURE.md | 系统架构和模板系统 |
我们欢迎所有形式的贡献！
-
添加新模板
skills/tech-notes-writer/templates/writing-styles/your-style.md skills/tech-notes-writer/templates/image-styles/your-style.md -
改进Review检查
- 修改
skills/tech-notes-writer/templates/review-templates/ - 更新检查项和子项
- 修改
-
优化图像生成
- 改进
skills/tech-notes-writer/references/illustration/renderers/ - 添加新的渲染器
- 改进
-
提交PR
- Fork 本仓库
- 创建特性分支 (
git checkout -b feature/amazing-feature) - 提交更改 (
git commit -m 'feat: add amazing feature') - 推送到分支 (
git push origin feature/amazing-feature) - 提交 Pull Request
feat:新功能fix:修复bugdocs:文档更新refactor:代码重构test:测试相关
| 版本 | 日期 | 核心功能 |
|---|---|---|
| v1.1.0 | 2026-05-18 | 多模板系统 + Phase 1双模式 + 统一图像技能 + Obsidian强绑定 + 文档优化 |
| v1.0.0 | 2026-05-15 | deep-research + draw.io + Mermaid + AI提示词 + Review检查 |
- 明确学习目标 - 选择最匹配的写作风格
- 提供充足上下文 - Idea模式下提供详细笔记
- 规划插图位置 - 标注需要图表的关键位置
- 仔细审阅初稿 - 检查技术准确性和代码可运行性
- 完整审阅 - 确认所有细节无误后再清理
- 验证备份 - 确认提示词备份完整
- 安全清理 - 仅删除提示词，保留正文
- 永久保留 - 备份文件随时可恢复
- 问题反馈：提交Issue
- 功能建议：Feature Request
- 文档改进：提交PR
本项目采用 MIT License 开源协议。
最后更新：2026-05-18
版本：v1.1.0
许可证：MIT