主题
模板创建指南
用模板把“每次都要重复搭结构”的工作一次性标准化。
本页是模板创建的唯一详述文档。其他页面仅保留简版说明并链接到本页。
为什么要做模板
模板可以解决三类重复问题:
- 项目结构重复(章节目录、命名规则)
- 设定文件重复(
@system中的风格/术语/审阅标准) - 指令模板重复(写作和审阅的常用提示词)
前后端模板能力总览
当前模板体系按代码与接口口径分为两层:
- 模板类型(2 类)
system:系统模板(所有人可见,不可直接修改)user:用户模板(可创建、编辑、复制、删除)
- 系统预设模板(6 个)
novel(长篇小说)zhihu(知乎回答)tech-blog(技术博客)horror(恐怖短篇)science(科学写作)blank(空白项目)
总共几种“模板创建”方式
按当前产品功能口径,一共 5 种:
- 选系统模板创建项目(项目创建向导)
- 选空白模板创建项目(
blank) - 新建用户模板(设置页模板管理)
- 复制已有模板创建副本(系统/用户模板都可复制为用户模板)
- 从现有项目
@system导出为模板(前端服务组合能力)
说明:第 5 种是前端收集
@system文件后调用模板创建接口实现,不是独立后端路由。
前后端能力与入口对齐
| 场景 | 前端入口 | 前端调用 | 后端接口/行为 |
|---|---|---|---|
| 获取模板列表 | 项目创建向导、设置页模板管理 | getTemplates("all") | GET /templates,返回系统模板 + 当前用户模板 |
| 查看模板详情 | 设置页右侧文件面板、应用模板前 | getTemplateById(idOrSlug) | GET /templates/:id(支持 id/slug) |
| 新建用户模板 | 设置页「创建模板」 | createTemplate() | POST /templates,仅创建 user 模板 |
| 复制模板 | 设置页「复制」 | duplicateTemplate() | POST /templates/:id/duplicate,复制为当前用户模板 |
| 编辑/删除用户模板 | 设置页模板操作 | updateTemplate() / deleteTemplate() | PUT /templates/:id / DELETE /templates/:id |
| 管理模板文件 | 设置页文件列表 | addTemplateFile() / updateTemplateFile() / removeTemplateFile() | POST/PUT/DELETE /templates/:id/files... |
| 项目创建时应用模板 | 创建项目向导完成后 | applyTemplate(projectId, templateIdOrSlug) | 按模板文件写入项目 @system |
| 从项目导出模板 | 设置页(导出)/服务能力 | createTemplateFromProject() | 复用 POST /templates(无独立导出路由) |
webfrontend 展示口径(当前实现)
- 项目创建向导
- 模板卡片展示系统模板 + 用户模板,按
icon/color/name/description/fileCount渲染 - 若模板为空,自动跳过模板选择步骤,直接进入项目基础信息填写
blank模板作为“空白创建”兜底,不强制写入模板文件
- 模板卡片展示系统模板 + 用户模板,按
- 设置页模板管理
- 左侧按「我的模板 / 系统模板」分组展示
- 用户模板支持:创建、编辑、删除、复制、文件增删改
- 系统模板支持:查看、复制(不可编辑、不可删除)
- Tauri 离线模式支持本地模板 CRUD 与后续同步状态显示
模板的三层结构(推荐)
1) 项目骨架模板(目录层)
示例:
text
项目名/
├── @system/
│ ├── 写作风格.md
│ ├── 术语表.md
│ └── 审阅标准.md
├── 01-引言/
├── 02-主体/
├── 03-结论/
└── 99-附录/2) 内容模板(文件层)
为常用文档准备固定段落结构,例如:
- 章节模板:背景 / 目标 / 内容 / 小结
- 技术方案模板:问题 / 方案 / 实现 / 风险 / 验证
- 论文模板:摘要 / 引言 / 方法 / 实验 / 结论
3) Agent 指令模板(交互层)
- 写作模板:用于快速出初稿
- 审阅模板:用于统一质量检查和修订格式
写作模板示例
text
你现在是写作模式。基于 @system 设定,按以下结构生成《{章节名}》:
1) 背景
2) 关键要点(3-5条)
3) 正文
4) 小结
篇幅约 {字数},风格:{风格要求}。审阅模板示例
text
你现在是审阅模式。请审阅《{文件名}》,按“事实-逻辑-结构-表达-格式”检查并修订。仅做必要修改,不重写整体风格。最后输出问题分级和修改摘要。模板创建流程(建议)
- 先选场景:小说 / 论文 / 技术文档 / 报告
- 确定目录骨架:把重复章节固化为目录模板
- 填好
@system:写作风格、术语、审阅标准 - 准备写作/审阅指令模板:保证团队可复用
- 小范围试跑:用一章验证模板是否顺手,再迭代
模板质量检查清单(创建前必看)
- [ ]
@system至少有 3 个文件(风格/术语/审阅) - [ ] 每个模板文件都包含“可执行规则”,而不是只有标题
- [ ] 写作模板和审阅模板成对出现
- [ ] 至少包含 1 个“禁止项”和 1 个“通过标准”
- [ ] 模板命名清晰(场景 + 版本)
与写作/审阅 Agent 配合
这样可以把“搭结构 → 生成 → 把关”形成稳定流水线。