Hub 模板说明书写法 / 模板描述规范
统一 Hub 模板的标题、摘要、适用场景、输入输出、风险说明和首次使用指引写法。
这页不是教你怎么搭 workflow。
这页教的是另一件同样重要的事：
一条准备发到 Hub 的模板，说明书应该怎么写。
因为很多模板不是坏在流程本身。
而是坏在：
- 标题写得太虚
- 摘要写得像广告
- 输入字段没解释
- 风险边界没说
- 第一次使用的人不知道从哪里开始
结果就是，模板明明能用，别人还是不敢用，或者一上手就误用。
先说结论
一份好的 Hub 模板说明书，至少要回答 8 个问题：
- 这条模板到底是干什么的
- 适合谁用
- 不适合谁用
- 进来要填什么
- 最终会产出什么
- 会不会碰外部风险
- 第一次该怎么跑
- 哪些地方可以安全改，哪些地方别乱动
如果缺了其中两三个，用户就会开始猜。
而模板一旦靠猜，基本就不稳了。
官方写法总原则
Hub 模板说明书建议遵守这 6 条：
- 讲真实工作，不讲空泛能力
- 先讲输入和输出，再讲“先进”
- 说清边界，不要假装全能
- 说清风险，不要默认使用者会自己判断
- 给第一次使用的人留台阶
- 能让别人复用，就不要靠作者本人补课
标题怎么写
标题最容易犯的错，是写得太抽象。
不推荐
- 智能内容工作流
- 多模态增长引擎
- 超级自动化模板
这种标题的问题是：
- 看不出具体工作
- 看不出输入输出
- 看不出适用场景
更推荐
- 每日 AI 简报生成与复核
- 浏览器提交前审核与留痕
- 批量商品白底图处理与交付
- 研究问题到结构化 Brief
更好的标题通常有两个特征：
- 能看出工作对象
- 能看出最终动作或结果
一句话摘要怎么写
摘要的任务不是“显得厉害”。
摘要的任务是让人 5 秒内决定：
这条是不是我要的。
不推荐
“通过先进的 AI 编排能力，实现高效、灵活、可扩展的业务自动化闭环。”
这是标准空气。
更推荐
“把一个研究问题整理成带来源、开放问题和下一步建议的结构化 brief。”
“把商品图批量去背、统一输出并交付到指定目录，适合电商素材整理。”
好摘要通常包含这 3 个元素：
- 输入对象
- 关键过程
- 输出结果
“适合谁 / 不适合谁”必须写
这是 Hub 模板特别容易缺的一段。
但它很重要。
因为它能直接减少误用。
推荐写法
适合谁：
- 需要固定节奏产出 AI 简报的内容团队
- 需要在浏览器提交前加人工复核的运营团队
- 需要批量处理电商图片的素材团队
不适合谁：
- 还在探索流程、没有稳定输入输出的人
- 希望无审批直连生产外发的人
- 没有测试目标、第一次就想打生产环境的人
如果你不写“不适合谁”，使用者会默认“所有人都适合”。
这通常不是好事。
输入字段说明怎么写
字段说明不要只写字段名。
字段名只是系统用的，不是给第一次使用的人用的。
不推荐
topicsourceRefsdeliveryChannel
更推荐
| 字段 | 用户该怎么理解 | 建议填写方式 |
|---|---|---|
topic | 这次要处理的主题或问题 | 用一句完整问题描述，不要只写关键词 |
sourceRefs | 可选参考来源 | 每行一个来源，先用测试来源 |
deliveryChannel | 最终交付位置 | 第一轮先填测试频道或测试目录 |
最重要的是：
字段说明要站在使用者角度，不要站在作者角度。
输出结果怎么写
Hub 模板最怕另一种模糊：
“跑完以后你应该自己懂输出在哪里。”
不要这样。
说明书里应该明确写：
- 最终交付物是什么
- 大概长什么样
- 会放到哪里
- 哪些只是中间产物，哪些是最终结果
推荐写法
- 最终输出：一份结构化 markdown brief
- 中间产物：检索摘要、review 结论、运行证据
- 默认交付：测试目录或指定交付节点
风险和审批说明怎么写
Hub 模板不是产品宣传页。
不能只说能做什么，还要说哪里要停。
至少建议写清楚：
- 有没有外部写入
- 有没有浏览器提交
- 有没有公开发送
- 有没有建议保留审批
- 第一轮是不是必须用测试目标
推荐写法
风险提示：
- 该模板包含外部交付动作，首次使用请保留审批节点
- 如果涉及浏览器提交，先用测试账号和测试目标
- 不建议在未验证输入字段前直连生产频道或生产目录
这段写清楚，能少很多“我以为它会自动帮我判断”的误解。
首次使用指引一定要有
第一次使用说明，不需要很长。
但必须有。
最小也应该回答：
- 先填什么
- 先改什么
- 第一轮往哪里交付
- 先跑到哪一步最安全
推荐写法
首次使用建议：
- 先把所有交付目标改成测试目标
- 先填最小输入样例，不要一上来就上完整生产数据
- 如果模板带审批，第一轮保留审批，不要跳过
- 先验证输出结构和交付位置，再决定是否改正式目标
“哪些地方可以改，哪些地方别乱动”要写
这是减少模板被改坏的关键。
建议明确分成两类：
可以安全改的
- 输入字段默认值
- 测试目标地址
- 交付目录
- 文案提示
- review 文本
不建议随便改的
- 主干节点顺序
- 审批前后的关键连线
- 外部连接绑定语义
- 最终交付节点逻辑
- 受控代码或 imported transform 的风险处理方式
这段一写，团队里别人接手时会轻松很多。
不要把模板说明写成广告
下面这些写法，建议尽量少用：
- 全能
- 一键搞定
- 零门槛
- 无脑使用
- 智能闭环
- 超级自动化
不是因为这些词不能用。
而是因为它们没有信息量。
Hub 模板说明最值钱的是：
让人知道怎么安全起步。
不是让人觉得文案很会吹。
官方推荐结构
如果你们后面要统一 Hub 模板说明，我建议固定用下面这个结构：
- 标题
- 一句话摘要
- 适合谁
- 不适合谁
- 输入字段说明
- 最终输出 / 交付结果
- 风险与审批提示
- 首次使用建议
- 可安全修改项
- 已知限制
可直接复用的说明书模板
你们后面发 Hub，可以直接套这个：
# 模板名称
一句话摘要：这条模板把什么输入，处理成什么输出，适合什么工作。
## 适合谁
-
-
## 不适合谁
-
-
## 输入字段说明
| 字段 | 怎么理解 | 建议怎么填 |
| --- | --- | --- |
| | | |
## 输出与交付
- 最终输出：
- 中间产物：
- 默认交付位置：
## 风险与审批提示
-
-
## 首次使用建议
1.
2.
3.
4.
## 可以安全修改的地方
-
-
## 不建议随便修改的地方
-
-
## 已知限制
-
- 一眼看上去就更靠谱的模板说明，长什么样
好的模板说明通常有这些特征：
- 标题像真实工作，不像概念名词
- 摘要里能看见输入和输出
- 风险提示不藏着
- 第一次使用建议够具体
- 看完以后，别人知道先去哪里改测试值
而差的模板说明通常长这样：
- 标题很大
- 摘要很空
- 风险没写
- 输入字段全靠猜
- 作者不在旁边时没人敢动
发布前最后自检
如果你已经写完模板说明，最后再问自己这 5 句：
- 看标题，别人知道它是干什么的吗
- 看摘要，别人知道输入和输出吗
- 看字段，别人知道该填什么吗
- 看风险，别人知道哪里别乱点吗
- 看首次使用说明，别人知道第一轮该怎么安全试跑吗
只要有两句答不上来，就还没写完。