@tinkcarlos/skillora 0.2.0

package/.claude/skills/skill-expert-skills/references/docs-generation-workflow.md

@@ -0,0 +1,398 @@
+# 文档生成工作流 (Docs Generation Workflow)
+
+> **核心原则**：知识获取 → 知识验证 → 文档生成 → 文档存储，形成完整闭环。
+
+---
+
+## 🔴 文档生成触发条件
+
+| 触发场景 | 文档类型 | 存储位置 |
+|----------|----------|----------|
+| 新建 Skill | 领域知识文档 | `docs/knowledge/` |
+| 优化 Skill | 调研文档 | `docs/research/` |
+| 知识库更新 | 知识沉淀文档 | `docs/knowledge/` |
+| 技术调研 | 调研文档 | `docs/research/` |
+
+---
+
+## 🔴 文档生成流程
+
+```
+┌─────────────────────────────────────────────────────────────┐
+│  Step 1: 需求分析 → 确定文档范围                            │
+│      ↓                                                      │
+│  Step 2: 知识获取 → 使用 MCP 工具                           │
+│      ↓                                                      │
+│  Step 3: 知识验证 → 最新性/准确性/完整性                    │
+│      ↓                                                      │
+│  Step 4: 文档结构设计 → 选择模板                            │
+│      ↓                                                      │
+│  Step 5: 文档撰写 → 按模板填充                              │
+│      ↓                                                      │
+│  Step 6: 文档审核 → 质量检查                                │
+│      ↓                                                      │
+│  Step 7: 文档保存 → 保存到 docs/ + 更新索引                 │
+└─────────────────────────────────────────────────────────────┘
+```
+
+---
+
+## Step 1: 需求分析
+
+### 1.1 确定文档范围
+
+| 问题 | 答案 | 影响 |
+|------|------|------|
+| 文档目的是什么？ | [目的] | 决定文档类型 |
+| 目标读者是谁？ | [读者] | 决定详细程度 |
+| 覆盖哪些主题？ | [主题] | 决定文档范围 |
+| 时效性要求？ | [要求] | 决定更新频率 |
+
+### 1.2 文档类型选择
+
+| 文档类型 | 适用场景 | 模板 |
+|----------|----------|------|
+| 领域知识文档 | 系统性知识沉淀 | 领域知识模板 |
+| 调研文档 | 特定时间点调研 | 技术调研模板 |
+| 最佳实践文档 | 实践经验总结 | 最佳实践模板 |
+
+---
+
+## Step 2: 知识获取
+
+### 2.1 MCP 工具使用
+
+```markdown
+## 知识获取工具选择
+
+### 库/框架文档
+mcp__context7__resolve-library-id → 获取库 ID
+mcp__context7__query-docs → 查询文档
+
+### 深度搜索
+mcp__exa__web_search_exa → 网络深度搜索
+mcp__exa__get_code_context_exa → 代码上下文
+
+### GitHub 文档
+mcp__mcp-deepwiki__deepwiki_fetch → 获取仓库文档
+
+### 网页内容
+mcp__fetch__fetch → 获取特定 URL
+WebSearch → 搜索最新信息
+```
+
+### 2.2 知识获取记录
+
+```markdown
+## 知识获取记录
+
+| 工具 | 查询 | 结果摘要 | 来源 URL | 获取日期 |
+|------|------|----------|----------|----------|
+| [工具] | [查询] | [摘要] | [URL] | YYYY-MM-DD |
+```
+
+---
+
+## Step 3: 知识验证
+
+→ **详细流程见**: `references/knowledge-validation-checklist.md`
+
+### 3.1 快速验证清单
+
+```markdown
+## 快速验证
+
+### 最新性
+- [ ] 版本号验证通过
+- [ ] 时效性分级 ≥ B级
+- [ ] 无重大 Breaking Changes
+
+### 准确性
+- [ ] 有 S/A 级来源
+- [ ] 三步验证法通过
+- [ ] 冲突已处理
+
+### 完整性
+- [ ] 覆盖率 ≥ 80%
+- [ ] 无重大遗漏
+- [ ] 深度检查通过
+```
+
+---
+
+## Step 4: 文档结构设计
+
+### 4.1 领域知识文档模板
+
+```markdown
+# [领域名称] 知识文档
+
+## 元信息
+- **创建日期**: YYYY-MM-DD
+- **最后更新**: YYYY-MM-DD
+- **版本**: v1.0
+- **状态**: 🟢 Active / 🟡 Review / 🔴 Outdated
+
+## 概述
+[领域简介，100-200字]
+
+## 核心概念
+### 概念1
+[定义和解释]
+
+### 概念2
+[定义和解释]
+
+## 关键技术
+### 技术1
+- **用途**: [用途]
+- **用法**: [用法]
+- **注意事项**: [注意事项]
+
+## 最佳实践
+1. [实践1]
+2. [实践2]
+3. [实践3]
+
+## 常见陷阱
+1. [陷阱1] → [解决方案]
+2. [陷阱2] → [解决方案]
+3. [陷阱3] → [解决方案]
+
+## 参考资源
+| 资源 | URL | 说明 |
+|------|-----|------|
+| [资源1] | [URL] | [说明] |
+
+## 更新日志
+| 日期 | 版本 | 变更内容 |
+|------|------|----------|
+| YYYY-MM-DD | v1.0 | 初始版本 |
+```
+
+### 4.2 技术调研文档模板
+
+```markdown
+# [主题] 技术调研
+
+## 调研信息
+- **调研日期**: YYYY-MM-DD
+- **调研目的**: [目的]
+- **调研范围**: [范围]
+
+## 调研背景
+[背景说明，100-200字]
+
+## 调研方法
+| 方法 | 工具 | 说明 |
+|------|------|------|
+| [方法1] | [工具] | [说明] |
+
+## 调研发现
+
+### 发现1: [标题]
+- **内容**: [内容]
+- **来源**: [来源]
+- **可信度**: S/A/B/C/D
+
+### 发现2: [标题]
+- **内容**: [内容]
+- **来源**: [来源]
+- **可信度**: S/A/B/C/D
+
+## 关键结论
+1. [结论1]
+2. [结论2]
+3. [结论3]
+
+## 建议行动
+| 行动 | 优先级 | 说明 |
+|------|--------|------|
+| [行动1] | P0/P1/P2 | [说明] |
+
+## 参考来源
+| 来源 | URL | 获取日期 | 可信度 |
+|------|-----|----------|--------|
+| [来源1] | [URL] | YYYY-MM-DD | S/A/B/C/D |
+
+## 附录
+[补充材料]
+```
+
+### 4.3 最佳实践文档模板
+
+```markdown
+# [主题] 最佳实践
+
+## 元信息
+- **创建日期**: YYYY-MM-DD
+- **适用版本**: [版本]
+- **适用场景**: [场景]
+
+## 概述
+[最佳实践概述，100-200字]
+
+## 实践清单
+
+### 实践1: [标题]
+- **场景**: [适用场景]
+- **做法**: [具体做法]
+- **原因**: [为什么这样做]
+- **示例**: [简短示例]
+
+### 实践2: [标题]
+- **场景**: [适用场景]
+- **做法**: [具体做法]
+- **原因**: [为什么这样做]
+- **示例**: [简短示例]
+
+## 反模式（避免）
+
+### 反模式1: [标题]
+- **问题**: [问题描述]
+- **后果**: [可能后果]
+- **正确做法**: [应该怎么做]
+
+## 检查清单
+- [ ] [检查项1]
+- [ ] [检查项2]
+- [ ] [检查项3]
+
+## 参考资源
+| 资源 | URL | 说明 |
+|------|-----|------|
+| [资源1] | [URL] | [说明] |
+```
+
+---
+
+## Step 5: 文档撰写
+
+### 5.1 撰写原则
+
+| 原则 | 说明 |
+|------|------|
+| 准确性 | 内容必须经过验证 |
+| 简洁性 | 避免冗余，直达要点 |
+| 结构化 | 使用清晰的层级结构 |
+| 可操作 | 提供可执行的指导 |
+| 可追溯 | 标注来源和日期 |
+
+### 5.2 撰写检查
+
+```markdown
+## 撰写检查清单
+
+- [ ] 使用了正确的模板
+- [ ] 元信息完整
+- [ ] 内容经过验证
+- [ ] 来源已标注
+- [ ] 格式统一规范
+- [ ] 无拼写/语法错误
+```
+
+---
+
+## Step 6: 文档审核
+
+### 6.1 质量检查清单
+
+```markdown
+## 文档质量检查
+
+### 内容质量
+- [ ] 内容准确无误
+- [ ] 覆盖范围完整
+- [ ] 深度适当
+- [ ] 时效性符合要求
+
+### 结构质量
+- [ ] 结构清晰
+- [ ] 层级合理
+- [ ] 导航方便
+
+### 格式质量
+- [ ] Markdown 格式正确
+- [ ] 表格对齐
+- [ ] 代码块正确
+- [ ] 链接有效
+
+### 可用性
+- [ ] 易于理解
+- [ ] 易于查找
+- [ ] 易于更新
+```
+
+---
+
+## Step 7: 文档保存
+
+### 7.1 文档存储规范
+
+| 项目 | 规范 |
+|------|------|
+| **存储位置** | `skill-expert-skills/docs/` |
+| **调研文档** | `docs/research/YYYY-MM-DD-[topic].md` |
+| **知识文档** | `docs/knowledge/[domain]-knowledge.md` |
+
+### 7.2 命名规范
+
+```
+调研文档：YYYY-MM-DD-[topic].md
+  示例：2025-01-17-react-19-features.md
+        2025-01-15-claude-skills-api.md
+
+知识文档：[domain]-knowledge.md
+  示例：frontend-knowledge.md
+        claude-skills-knowledge.md
+```
+
+### 7.3 索引更新
+
+保存文档后，必须更新 `docs/_index.md`：
+
+```markdown
+## 更新索引
+
+### 调研文档 (research/)
+| 文档 | 主题 | 创建日期 | 状态 |
+|------|------|----------|------|
+| [新文档] | [主题] | YYYY-MM-DD | 🟢 Active |
+
+### 知识文档 (knowledge/)
+| 文档 | 领域 | 最后更新 | 状态 |
+|------|------|----------|------|
+| [新文档] | [领域] | YYYY-MM-DD | 🟢 Active |
+```
+
+---
+
+## 快速参考
+
+```
+┌─────────────────────────────────────────────────────────────┐
+│           文档生成工作流 - 快速参考                          │
+├─────────────────────────────────────────────────────────────┤
+│                                                             │
+│  触发条件：                                                 │
+│     新建 Skill → 领域知识文档                               │
+│     优化 Skill → 调研文档                                   │
+│     知识更新 → 知识沉淀文档                                 │
+│                                                             │
+│  7步流程：                                                  │
+│     1. 需求分析 → 确定范围和类型                            │
+│     2. 知识获取 → MCP 工具                                  │
+│     3. 知识验证 → 最新性/准确性/完整性                      │
+│     4. 结构设计 → 选择模板                                  │
+│     5. 文档撰写 → 按模板填充                                │
+│     6. 文档审核 → 质量检查                                  │
+│     7. 文档保存 → 保存 + 更新索引                           │
+│                                                             │
+│  存储规范：                                                 │
+│     调研文档 → docs/research/YYYY-MM-DD-[topic].md          │
+│     知识文档 → docs/knowledge/[domain]-knowledge.md         │
+│                                                             │
+│  必须更新：docs/_index.md                                   │
+│                                                             │
+└─────────────────────────────────────────────────────────────┘
+```