quick-start.md

快速上手指南

本指南帮助你在 5 分钟内开始使用框架约束模式。

前置条件

• 已完成 /specify 命令，生成了 specification.md
• 准备好你的提纲/框架（文本形式）

场景一：直接使用提纲

Step 1: 启动命令

/outline

Step 2: 输入提纲

在提示后，直接粘贴你的提纲文本：

《基于大语言模型的智能应用系统平台 - 立项方案》

一、概述
   （一）立项背景
   （二）申报依据
二、需求分析
三、研究现状
四、主要研究内容及技术指标
   （一）研究目标
   （二）研究内容
五、研究方案
   （一）总体架构
   （二）系统流程
六、经费预算
七、进度安排

支持的提纲格式：

• Markdown 标题格式（# 一级 ## 二级）
• 中文序号格式（一、二、三... 或 （一）（二）...）
• 阿拉伯数字格式（1. 2. 3...）
• 混合格式

Step 3: 提供背景信息

AI 会识别文档类型并询问关键信息：

检测到这是一份「项目立项报告」，请提供：

1. 项目名称：基于大语言模型的智能应用系统平台
2. 项目简介：构建企业级智能办公辅助平台
3. 核心技术：大语言模型、RAG、知识图谱
4. 预算范围：500万元
5. 时间周期：24个月

Step 4: 确认章节分类

AI 会自动分析章节类型：

🤖 通用章节（AI 自动生成）：
   - 一、概述 > 立项背景
   - 一、概述 > 申报依据
   - 三、研究现状
   - 七、进度安排

💬 核心章节（需要您补充信息）：
   - 四、主要研究内容及技术指标
   - 五、研究方案
   - 六、经费预算

开始生成？(yes/调整分类)

输入 yes 开始生成，或说明需要调整的地方。

Step 5: 逐章生成

AI 会按顺序生成每个章节，生成后等待你确认：

正在生成「一、概述 > 立项背景」...

[生成结果预览]

✅ 确认 / ✏️ 修改 / 🔄 重新生成

• 输入 确认 或 ok：继续下一章节
• 输入修改意见：AI 会根据你的意见修改
• 输入 重新生成：AI 会重新生成该章节

Step 6: 一致性检查

全部章节完成后，系统会自动检查一致性：

━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
📋 一致性检查报告
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

✅ 项目名称：统一使用「XX智能应用系统平台」(出现12次)
✅ 术语一致：AI → 人工智能
⚠️ 警告：经费预算总额(500万)与分项合计(480万)不一致
   → 位置：六、经费预算
   → 建议：调整分项或总额

修复问题后生成最终文档？

确认后，系统会生成最终的 draft.md 文件。

---

场景二：使用预置模板

Step 1: 查看可用模板

/outline --list

输出：

━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
📋 可用模板列表
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

项目管理
├─ project-proposal    项目立项报告
│  适用：科研/企业项目申报

学术研究
├─ thesis-opening      开题报告
│  适用：硕博开题

技术文档
├─ technical-report    技术报告
│  适用：技术方案、可行性分析

使用方式：/outline --template <模板ID>

Step 2: 使用模板

/outline --template project-proposal

后续流程与场景一相同，但提纲已预填充，你只需提供背景信息即可。

---

场景三：保存自定义模板

如果你有常用的提纲格式，可以保存为模板复用：

Step 1: 先按场景一完成提纲输入

Step 2: 保存为模板

在任意步骤中，输入：

/outline --save-template my-proposal

模板将保存到 templates/outlines/my-proposal.yaml

Step 3: 后续使用

/outline --template my-proposal

---

常用命令速查

命令	说明
/outline	直接输入提纲
/outline --list	查看可用模板
/outline --template <id>	使用指定模板
/outline --save-template <name>	保存当前提纲为模板

---

下一步

• 模板使用指南 - 深入了解模板系统
• 最佳实践 - 提高生成质量的技巧