跳到主要内容

约定

知识库的命名与元数据规则。本页所有示例均使用虚构名称。

文件夹名称

文件夹规则示例
项目英文产品名称小写,单词之间用连字符连接,然后加项目编号example-camera-12
项目,名称仅有中文时project- 加项目编号project-12
代次gen- 加代次编号gen-1
品牌品牌名称小写,单词之间用连字符连接example-brand

项目编号是文件夹名称的一部分。因此两个同名产品各自保留独立的文件夹。

文件名称

文件规则示例
Slate 撰写的文档标题小写,单词之间用连字符连接,然后加 -v 与版本号example-camera-specification-v3.md
项目记录固定名称,不带版本号project.md
上传的原始文件提供时的原名,并加上 -v1example-returns-v1.xlsx
上传文档的文本上传文件名,然后加 .extracted.mdexample-returns-v1.xlsx.extracted.md
冲突后保留的版本文档名称,然后加 .conflict- 与一段短代码spec-v3.conflict-a1b2c3d.md

版本号从 1 开始递增。每个新版本都是一个新文件。Slate 从不覆盖带版本号的文档。

中文文件名在各处均受支持。

元数据

Slate 撰写的每一份 Markdown 文档都以一个元数据块开头。数据文件和图片不带该块。

---
project: example-camera-12
generation: 1
stage: voc
type: voc_report
version: 2
date: '2026-07-24'
source_job: 481
source_thread: null
---
字段取值
project项目文件夹名称
generation代次编号。上传文件为空
stage阶段名称。上传文件为空
type文档类型。见下表
version版本号,与文件名一致
date文档撰写日期
source_job产出该文档的 Slate 任务。上传文件与对话编辑为空
source_thread产出该文档的对话。其他情况为空

另有两个字段在适用时出现。

字段取值
change_note修订原因。通过对话编辑文档时添加
sources文档使用的编号引用,与正文中的来源列表一致

文档类型

类型含义
specification产品规格书
market_report竞品与市场分析
voc_report客户评论分析
dataset表格数据,例如竞品或退货导出
copyListing 文案
marketing_image生成的产品图或场景图
manual产品手册或说明书
brand_asset品牌套件素材
positioning产品线定位
profit_model成本与利润模型
factory_brief给工厂的说明
misc以上未涵盖的内容,包括提取出的文本
ops_report保留。没有阶段写入此类型

项目记录

project.md 保存一个项目的设置。这些设置发生变化时,Slate 会重写它。

字段取值
slug项目文件夹名称
name录入的产品名称
name_en英文产品名称。未设置时为空
sku型号。未设置时为空
category产品类目

记录正文包含两个可选章节。

章节用途
## Description产品是什么,面向哪些市场
## Notes for AISlate 对该项目每一份文档都会应用的常驻指令

新增条目

新建项目

  1. 在 Slate 中创建项目。
  2. 填写名称、英文名称、型号和产品类目。

项目文件夹与项目记录会自动写入。请勿手工创建项目文件夹。

新建文档

  1. 在 Slate 中运行该阶段,或在对话中提出修改要求。
  2. 等待运行结束。

文档会以下一个版本号写入对应的阶段文件夹。

新增上传

  1. 在 Slate 中选择上传控件。
  2. 选择文件。
  3. 确认或更正 Slate 建议的文档类型。

Slate 会根据文件名、文件扩展名和文件内的文本建议类型。已确认的类型不会再被更改。

新建品牌套件

  1. brands 下创建一个文件夹。
  2. 添加 guidelines.md,写入语气与文案规则。
  3. 添加 palette.yml,写入按用途划分的颜色。
  4. 添加 refs 文件夹,并把参考图放入其中。

品牌套件由人工添加。没有阶段写入 brands

在 Obsidian 中编辑

编辑操作是否支持
修改文档文本支持
添加自定义元数据字段,例如标签或审核人支持
重命名、编辑或删除 uploads 中的文件支持
添加或编辑品牌套件支持
重命名或重新编号 Slate 撰写的文档不支持。该文档会从 Slate 中消失,其引用也会失效
重命名任何标准元数据字段不支持。该文档会从筛选列表中消失
在 Slate 正在撰写某文档新版本时编辑该文档不支持。两个版本都会保留,需要人工合并
删除配套文本文件允许。下一次读取时会重新生成

文本归操作员所有。文件名、标准元数据字段和版本号归 Slate 所有。

Slate 每五分钟重新读取一次知识库。

相关

  • 概览 介绍访问权限与版本历史。
  • 结构 介绍各文件夹及其存放的内容。