Hermes Agent 中文教程

Appearance

单篇写作模板 ​

每篇文章解决一个问题。篇幅由任务决定，建议阅读时间为 8—15 分钟。任务课使用完整模板；概念课可以省略命令和文件验收，改用判断练习与自检题。

页面结构 ​

markdown
# NN · 读者问题

> 你在课程中的位置，以及本篇会产出什么。

## 看完会得到什么

- 一个可展示的结果
- 一个判断标准
- 一个失败恢复入口

## 开始前

- 预计时间：
- 前置课程：
- 已验证平台与日期：
- 输入位置：Desktop、终端、Hermes 对话框或消息平台
- 本篇会修改什么：
- 本篇不会修改什么：

## 先认识本篇术语

| 术语 | 中文直觉 | 本篇用途 |
|---|---|---|

## 先看流程

![任务课从输入、Hermes 行动到验证结果的最小闭环](/images/writing-template-flow.svg)

## 动手步骤

### 第一步

命令、操作、它改变的内容、预期输出。

### 第二步

命令、操作、它改变的内容、预期输出。

## 权限检查

- 本篇会访问：
- 可以批准：
- 需要停下来确认：
- 不应输入的信息：

## 为什么这样设计

解释机制和选择，不展开无关实现。

## 出错时按这个顺序查

1. 检查状态。
2. 检查配置。
3. 检查凭据或权限。
4. 检查日志。
5. 对照官方文档。

## 本篇作品

说明读者需要保存的文件、截图、链接或验证结果。

## 本篇验收

- [ ] 结果文件或消息存在
- [ ] 读者能说明 Hermes 做了什么
- [ ] 读者能撤销、停止或重试

## 下一篇

说明下一篇解决的问题。

命令块标准 ​

每个命令块后回答四个问题：

  1. 这条命令在哪里输入？
  2. 它读取或修改什么？
  3. 成功时会看到什么？
  4. 失败时先检查哪里？

不提供无法验证的预期输出。版本号、模型名和平台清单使用占位说明或链接官方页面。

术语标准 ​

术语第一次出现时按“用途 → 中文直觉 → 英文名称”解释。

例：

Provider 是模型服务来源。它决定 Hermes 把请求发到哪家服务，以及使用哪套凭据。

避免用另一个陌生术语解释新术语。

图表标准 ​

Mermaid 用于三类内容：

  • 安装、任务和排错的步骤关系；
  • model、provider、tool 和 Agent 的关系；
  • memory、skill、cron、delegation 等功能的选择路径。

图中节点控制在 4—9 个。图表后补一段文字，确保无法渲染 Mermaid 的读者仍能理解。

安全标准 ​

  • 不展示真实 token、API key、用户 ID 或聊天 ID。
  • 凭据放进 Hermes 凭据管理或 .env，行为配置放进 config.yaml。
  • 安装篇在要求读者配置 provider 之前，先说明凭据不得发进聊天、截图或提交到仓库，并给出撤销入口。
  • 涉及写文件、删除、发布、支付和远程操作时，写清影响范围。
  • 排错先检查状态和日志，不把重装当成首选方案。
  • 消息平台示例使用飞书、钉钉、企业微信和微信；首版完整步骤以飞书为主。

发布前检查 ​

  • [ ] 功能事实有官方文档来源
  • [ ] 页面写了验证日期和已验证平台
  • [ ] 易变化的命令或行为旁有具体官方页面
  • [ ] 新术语有中文解释
  • [ ] 每条命令写了输入位置和成功判断
  • [ ] 有一个读者可完成的练习
  • [ ] 有权限检查、排错顺序和停止方式
  • [ ] Mermaid 语法通过构建
  • [ ] 页面没有真实凭据
  • [ ] 标题描述读者问题，不描述配置项列表