article-writer-cn/docs/outline-mode/templates-guide.md

AI 驱动的智能写作系统 - 专注公众号/自媒体文章创作

# 模板使用指南

本指南详细介绍框架约束模式的模板系统。

## 模板概述

模板是预定义的提纲结构，包含：
- 章节层次结构
- 章节类型标记（通用/核心）
- 必填信息字段
- 一致性检查规则
- 生成建议

使用模板可以：
- 快速开始，无需手动输入提纲
- 确保文档结构规范
- 获得针对性的生成提示

## 预置模板详解

### 1. 项目立项报告 (project-proposal)

**适用场景**：科研项目申报、企业项目立项、创新基金申请

**结构概览**：
```
一、概述
   ├─ （一）立项背景 [通用]
   └─ （二）申报依据 [通用]
二、需求分析 [核心]
三、研究现状 [通用]
四、主要研究内容及技术指标
   ├─ （一）研究目标 [核心]
   ├─ （二）研究内容 [核心]
   └─ （三）技术指标
       ├─ 1. 功能指标 [核心]
       └─ 2. 性能指标 [核心]
五、研究方案
   ├─ （一）总体架构 [核心]
   ├─ （二）系统流程 [核心]
   └─ （三）方案组成 [核心]
六、经费预算
   ├─ （一）硬件设备费 [核心]
   └─ （二）软件设备费 [核心]
七、进度安排 [通用]
```

**必填信息**：
| 字段 | 说明 | 示例 |
|------|------|------|
| projectName | 项目名称 | 基于大语言模型的智能应用平台 |
| projectSummary | 项目简介 | 构建面向企业的智能化办公辅助平台 |
| organization | 申报单位 | XX科技有限公司 |
| coreTechnology | 核心技术 | 大语言模型、知识图谱、RAG |
| budget | 预算范围 | 500万元 |
| duration | 项目周期 | 24个月 |

**使用方式**：
```
/outline --template project-proposal
```

---

### 2. 开题报告 (thesis-opening)

**适用场景**：硕士/博士学位论文开题、学术研究计划

**结构概览**：
```
一、选题背景与意义
   ├─ （一）选题背景 [通用]
   └─ （二）研究意义
       ├─ 1. 理论意义 [核心]
       └─ 2. 实践意义 [核心]
二、国内外研究现状
   ├─ （一）国外研究现状 [通用]
   ├─ （二）国内研究现状 [通用]
   └─ （三）研究述评 [核心]
三、研究内容与方法
   ├─ （一）研究目标 [核心]
   ├─ （二）研究内容 [核心]
   ├─ （三）研究方法 [核心]
   └─ （四）技术路线 [核心]
四、研究重点与难点
   ├─ （一）研究重点 [核心]
   └─ （二）研究难点 [核心]
五、创新点 [核心]
六、研究计划与进度安排 [通用]
七、预期成果 [通用]
八、参考文献 [通用]
```

**必填信息**：
| 字段 | 说明 | 示例 |
|------|------|------|
| thesisTitle | 论文题目 | 基于深度学习的自然语言处理技术研究 |
| studentName | 学生姓名 | 张三 |
| supervisorName | 导师姓名 | 李四 |
| major | 专业 | 计算机科学与技术 |
| degree | 学位类型 | 学术硕士/专业硕士/博士 |
| researchField | 研究方向 | 自然语言处理、深度学习 |
| keywords | 关键词 | 深度学习; 自然语言处理; 文本分类 |

**使用方式**：
```
/outline --template thesis-opening
```

---

### 3. 技术报告 (technical-report)

**适用场景**：技术方案设计、可行性分析、技术调研报告

**结构概览**：
```
一、概述
   ├─ 1.1 背景介绍 [通用]
   ├─ 1.2 术语定义 [通用/可选]
   └─ 1.3 参考资料 [通用/可选]
二、需求分析
   ├─ 2.1 业务需求 [核心]
   ├─ 2.2 功能需求 [核心]
   └─ 2.3 非功能需求 [核心]
三、技术调研
   ├─ 3.1 技术现状 [通用]
   ├─ 3.2 技术选型分析 [核心]
   └─ 3.3 技术选型结论 [核心]
四、技术方案
   ├─ 4.1 总体架构 [核心]
   ├─ 4.2 核心模块设计 [核心]
   ├─ 4.3 数据设计 [核心/可选]
   └─ 4.4 接口设计 [核心/可选]
五、可行性分析
   ├─ 5.1 技术可行性 [通用]
   ├─ 5.2 资源可行性 [核心]
   └─ 5.3 风险分析 [核心]
六、实施计划
   ├─ 6.1 里程碑规划 [通用]
   ├─ 6.2 任务分解 [核心/可选]
   └─ 6.3 资源需求 [核心/可选]
七、总结与建议 [通用]
```

**必填信息**：
| 字段 | 说明 | 示例 |
|------|------|------|
| reportTitle | 报告标题 | XX系统技术方案报告 |
| projectName | 项目名称 | 智能客服系统 |
| version | 版本号 | V1.0 |
| author | 作者 | 张三 |
| department | 部门 | 技术研发部 |

**使用方式**：
```
/outline --template technical-report
```

---

## 自定义模板

### 创建自定义模板

1. **从现有提纲保存**：
   ```
   /outline --save-template my-template
   ```

2. **手动创建 YAML 文件**：

   在 `templates/outlines/` 目录下创建 `my-template.yaml`：

   ```yaml
   id: my-template
   name: 我的模板
   description: 模板描述
   category: 分类

   structure:
     - title: 一、第一章
       type: auto  # 通用章节
       word_count: 500-800
       hints:
         - 生成提示1
         - 生成提示2

     - title: 二、第二章
       type: interactive  # 核心章节
       word_count: 800-1200
       questions:
         - 问题1？
         - 问题2？

     - title: 三、第三章
       type: section  # 父章节
       children:
         - title: （一）子章节1
           type: auto
         - title: （二）子章节2
           type: interactive

   required_info:
     - key: fieldName
       label: 字段标签
       required: true
       example: 示例值

   consistency_rules:
     - type: proper_noun
       description: 一致性规则描述
       sources:
         - fieldName
   ```

### 模板字段说明

| 字段 | 必填 | 说明 |
|------|------|------|
| `id` | 是 | 模板唯一标识 |
| `name` | 是 | 模板名称 |
| `description` | 是 | 模板描述 |
| `category` | 否 | 分类 |
| `tags` | 否 | 标签列表 |
| `structure` | 是 | 章节结构 |
| `required_info` | 否 | 必填信息字段 |
| `consistency_rules` | 否 | 一致性检查规则 |
| `generation_hints` | 否 | 生成建议 |

### 章节类型

| 类型 | 说明 | 适用场景 |
|------|------|---------|
| `auto` | 通用章节，AI 自动生成 | 背景介绍、文献综述、进度安排 |
| `interactive` | 核心章节，需要用户输入 | 研究内容、技术方案、预算 |
| `section` | 父章节，包含子章节 | 多级标题的父级 |

---

## 模板管理

### 查看所有模板

```
/outline --list
```

### 查看模板详情

```
/outline --template <id> --preview
```

### 删除自定义模板

手动删除 `templates/outlines/<id>.yaml` 文件。

---

## 下一步

- [最佳实践](./best-practices.md) - 提高生成质量的技巧