hehaiguang1123
a6f05ab2d5
- Phase 0: AGENTS.md cleanup (dedup quotes, renumber sections, merge qmd) - Phase 1: typed relations (manage-relations.py, graph-search.py, check-staleness.py, detect-conflicts.py) - Phase 2: frontmatter validator, weekly lint, knowledge promotion, git hooks - Fix .gitignore to track tools/ and .githooks/ - Fix git remote URL (remove plaintext token) - New wiki pages: 504 pages, 34 raw sources
283 lines
6.6 KiB
Markdown
283 lines
6.6 KiB
Markdown
---
|
||
title: "Idea Document Template"
|
||
description: "人机协作创意文档模板 — 基于 LLM Wiki 模式设计"
|
||
author: []
|
||
created: 2026-04-23
|
||
tags:
|
||
- template
|
||
- collaboration
|
||
- human-llm
|
||
categories:
|
||
- "[[Templates]]"
|
||
source: ""
|
||
type: template
|
||
---
|
||
|
||
<!--
|
||
================================================================================
|
||
IDEA DOCUMENT — 人机协作创意文档模板
|
||
================================================================================
|
||
|
||
使用说明：
|
||
1. 复制此模板到你的工作目录
|
||
2. 填写 <<<FILL>>> 标记的所有字段
|
||
3. 将完整文档交给 LLM 代理
|
||
4. LLM 将根据本文档的 Schema 层定义执行操作
|
||
|
||
模板理念：参考 llm-wiki (karpathy) 的三层架构设计：
|
||
Raw Sources → Wiki（本文档）→ Schema（本模板中的 Workflow 层）
|
||
================================================================================
|
||
-->
|
||
|
||
# Idea: <<<项目/任务名称>>>
|
||
|
||
> **一句话描述**：<<<用一句话描述这个创意的核心价值是什么>>>
|
||
|
||
## 1. 背景与动机
|
||
|
||
### 问题陈述
|
||
|
||
<<<描述当前面临的问题或痛点>>>
|
||
|
||
### 现有方案
|
||
|
||
<<<描述现有的解决方案及其局限性>>>
|
||
|
||
### 改进机会
|
||
|
||
<<<描述本创意试图抓住的机会>>>
|
||
|
||
---
|
||
|
||
## 2. 核心概念
|
||
|
||
### 主要目标
|
||
|
||
<<<本创意要达成的核心目标>>>
|
||
|
||
### 关键要素
|
||
|
||
| 要素 | 描述 | 优先级 |
|
||
|------|------|--------|
|
||
| 要素1 | <<<描述>>> | P0 |
|
||
| 要素2 | <<<描述>>> | P1 |
|
||
| 要素3 | <<<描述>>> | P2 |
|
||
|
||
### 预期产出
|
||
|
||
- [ ] 产出1：<<<
|
||
- [ ] 产出2：<<<
|
||
- [ ] 产出3：<<<描述>>>
|
||
|
||
---
|
||
|
||
## 3. 人机职责边界
|
||
|
||
### Human（你）
|
||
|
||
- [ ] **Source**：提供背景资料、原始数据、参考资料
|
||
- [ ] **Direction**：指明分析方向、强调重点
|
||
- [ ] **Ask**：提出好问题、验证结果
|
||
- [ ] **Think**：理解含义、判断价值、做出决策
|
||
- [ ] **Review**：审核 LLM 的输出，决定是否采纳
|
||
|
||
### LLM（代理）
|
||
|
||
- [ ] **Research**：搜集信息、分析资料、提取关键点
|
||
- [ ] **Summarize**：将复杂信息简化为清晰的结构化内容
|
||
- [ ] **Cross-reference**：建立概念间的关联
|
||
- [ ] **File**：按规范组织产出，更新相关文档
|
||
- [ ] **Maintain**：跟踪状态变化，提醒维护需求
|
||
|
||
---
|
||
|
||
## 4. 工作流程
|
||
|
||
### 阶段一：探索（Explore）
|
||
|
||
```
|
||
输入：背景资料 / 参考文档 / 初步想法
|
||
执行：
|
||
1. LLM 阅读提供的资料
|
||
2. LLM 识别关键概念、核心问题、关联要素
|
||
3. LLM 与你讨论并确认理解是否正确
|
||
4. LLM 产出：初步概念图 / 问题框架 / 待确认清单
|
||
输出：探索结论.md
|
||
```
|
||
|
||
### 阶段二：构建（Build）
|
||
|
||
```
|
||
输入：探索结论 / 反馈意见
|
||
执行：
|
||
1. LLM 根据 Schema 规范生成结构化文档
|
||
2. LLM 创建/更新相关维基页面（如适用）
|
||
3. LLM 标记需要你决策的关键节点
|
||
4. 你审核并给出修改意见
|
||
输出：核心文档 / 子文档 / 决策点清单
|
||
```
|
||
|
||
### 阶段三：迭代（Iterate）
|
||
|
||
```
|
||
输入：你的反馈 / 新增信息 / 外部变化
|
||
执行：
|
||
1. LLM 根据反馈调整文档
|
||
2. LLM 检查一致性（与相关文档的交叉引用）
|
||
3. LLM 标注版本变化（CHANGELOG）
|
||
4. 你最终确认或提出进一步修改
|
||
输出：v1.0 / v2.0 / ... 版本文档
|
||
```
|
||
|
||
### 阶段四：产出（Deliver）
|
||
|
||
```
|
||
输入：已确认的最终版本
|
||
执行：
|
||
1. LLM 按指定格式导出（Markdown / PDF / PPTX / DOCX）
|
||
2. LLM 更新索引文件（INDEX.md）
|
||
3. LLM 追加日志（LOG.md）
|
||
4. LLM 清理临时文件
|
||
输出：最终交付物 + 归档
|
||
```
|
||
|
||
---
|
||
|
||
## 5. 文档结构规范（Schema）
|
||
|
||
### 文件组织
|
||
|
||
```
|
||
docs/
|
||
├── INDEX.md # 所有文档的目录索引
|
||
├── LOG.md # 操作时间线日志
|
||
├── README.md # 项目说明
|
||
├── idea.md # 本创意文档（主文件）
|
||
├── explorations/ # 探索阶段产出
|
||
│ ├── 概念图.md
|
||
│ └── 问题框架.md
|
||
├── builds/ # 构建阶段产出
|
||
│ ├── 核心方案.md
|
||
│ └── 详细设计.md
|
||
└── assets/ # 资源文件
|
||
├── images/
|
||
└── data/
|
||
```
|
||
|
||
### 命名约定
|
||
|
||
- 文件名：`kebab-case`（小写+连字符）
|
||
- 目录名：`kebab-case`
|
||
- 图片：`yyyymmdd-描述性名称.png`
|
||
|
||
### Frontmatter 规范
|
||
|
||
```yaml
|
||
---
|
||
title: "文档标题"
|
||
created: YYYY-MM-DD
|
||
updated: YYYY-MM-DD # 有更新时添加
|
||
tags:
|
||
- tag1
|
||
- tag2
|
||
categories:
|
||
- "[[Category]]"
|
||
status: draft | review | published # 当前状态
|
||
source: "" # 参考来源，无则留空
|
||
---
|
||
```
|
||
|
||
### 链接规范
|
||
|
||
- 同仓库文档：`[[文档名]]`（Obsidian wikilink）
|
||
- 外部链接：`[描述](URL)`
|
||
- 图片：`![[图片名.png]]`
|
||
|
||
---
|
||
|
||
## 6. 版本与日志
|
||
|
||
### CHANGELOG
|
||
|
||
| 版本 | 日期 | 变更内容 | 作者 |
|
||
|------|------|----------|------|
|
||
| v0.1 | <<<日期>>> | <<<初始版本>>> | <<<你的名字>>> |
|
||
|
||
### LOG.md 格式
|
||
|
||
```markdown
|
||
## [YYYY-MM-DD] 操作类型 | 操作描述
|
||
|
||
**输入**：<<<输入内容>>>
|
||
**执行**：<<<执行了什么>>>
|
||
**输出**：<<<产出了什么>>>
|
||
**备注**：<<<任何需要记录的信息>>>
|
||
```
|
||
|
||
---
|
||
|
||
## 7. 质量检查清单
|
||
|
||
在每个阶段完成后，用此清单检查：
|
||
|
||
### 探索阶段
|
||
|
||
- [ ] LLM 是否准确理解了问题背景？
|
||
- [ ] 关键概念是否被正确识别？
|
||
- [ ] 是否有模糊或遗漏的点需要进一步澄清？
|
||
|
||
### 构建阶段
|
||
|
||
- [ ] 文档是否符合 Schema 规范？
|
||
- [ ] 交叉引用是否完整？
|
||
- [ ] 是否有矛盾或不一致的地方？
|
||
|
||
### 迭代阶段
|
||
|
||
- [ ] 反馈是否被正确采纳？
|
||
- [ ] 修改是否引入了新问题？
|
||
- [ ] 版本记录是否完整？
|
||
|
||
### 产出阶段
|
||
|
||
- [ ] 最终文档格式是否符合要求？
|
||
- [ ] INDEX.md 和 LOG.md 是否已更新？
|
||
- [ ] 临时文件是否已清理？
|
||
|
||
---
|
||
|
||
## 8. 附录
|
||
|
||
### 参考资料
|
||
|
||
<<<列出所有参考的文档、网址、工具等>>>
|
||
|
||
### 相关文档
|
||
|
||
- [[相关文档1]]
|
||
- [[相关文档2]]
|
||
|
||
### 工具与环境
|
||
|
||
| 工具 | 用途 | 获取方式 |
|
||
|------|------|----------|
|
||
| Obsidian | 文档编辑与浏览 | <https://obsidian.md> |
|
||
| <<<其他工具>>> | <<<用途>>> | <<<链接>>> |
|
||
|
||
---
|
||
|
||
<!--
|
||
================================================================================
|
||
使用示例
|
||
================================================================================
|
||
|
||
当你有一个新想法时，这样使用本模板：
|
||
|
||
1. 复制本模板到新文件，如 `my-idea.md`
|
||
2. 填写所有 <<<FILL>>> 字段
|
||
3. 将文件路径告诉 LLM："请帮我完善这个创意文档"
|
||
4. LLM 会按照本模板定义的 Schema 和 Workflow 执行
|
||
|
||
================================================================================
|
||
-->
|