Skip to content

零基础单课写作模板

每课解决一个读者问题,只引入完成下一步所需的 2—4 个新概念。概念课、操作课和排错课使用不同证据,但都必须有可观察的完成标准。

页面结构

markdown
# NN · 读者问题

*用一句具体问题说明本课为何存在。*

> 说明课程位置,以及本课会留下什么作品或判断结果。

## 看完会得到什么

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

## 开始前

- 预计时间:
- 前置课程:
- 难度:零基础 / 入门 / 综合
- 适用版本:
- 已验证平台与日期:
- 验证方式:已执行 / 仅官方文档核验
- 输入位置:Desktop / 系统终端 / Hermes 对话 / 消息平台
- 本课会修改:
- 本课不会修改:

## 先认识本课术语

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

## 先看流程

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

用三句话说明输入是什么、Hermes 做什么、学习者如何验收。

## 动手步骤

### 第一步 · 操作名称

**现在执行**

- 在哪里:
- 命令或操作:
- 会读取或修改:
- 成功时会看到:
- 为什么这样做:
- 失败时先检查:

后续命令按用途标为“现在执行”“成功后检查”或“失败时再用”。

## 权限检查

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

通用凭据规则链接到第 05 课,本课只写新增风险。

## 常见错误

| 错误表现 | 可能原因 | 先看什么 | 解决方式 |
|---|---|---|---|

## 本课作品

写明要保存的文件、截图、状态或消息,以及下一课怎样复用。

## 知识检查

1. 三个概念或情境判断题;
2. 一个实际操作题;
3. 一个故障排查题;
4. 只有综合课增加开放设计题。

答案放在可折叠区,必须解释原因。

## 本课验收

- [ ] 结果文件、消息或状态真实存在
- [ ] 必要结构和内容齐全
- [ ] 能说明 Hermes 实际做了什么
- [ ] 输入和范围外对象未被修改
- [ ] 能停止、撤销或重试

## 以后只记住这三点

1. 一条可迁移结论;
2. 一条边界;
3. 一个失败入口。

## 下一课

说明下一课解决的问题,以及为什么现在才需要它。

## 版本信息与来源

- 教程版本:
- Hermes 适用版本:
- 已验证系统:
- 最后核验日期:
- 验证方式:
- 官方来源:

命令块标准

每个命令块回答六个问题:

  1. 是否现在必须执行;
  2. 在哪里执行;
  3. 读取什么;
  4. 修改什么;
  5. 成功时看到什么结果模式;
  6. 失败时先检查哪里。

不得提供没有真实执行过的精确输出。版本号、模型名和平台清单使用结果模式,并链接官方页面。

术语标准

术语第一次出现时按“它解决什么 → 中文直觉 → 英文名称 → 不等于什么”解释。不要用另一个陌生术语解释新术语。

每课最多引入 2—4 个核心新概念。更完整参数和平台差异放入折叠内容或链接官方文档。

图表标准

面向学习者的流程和架构图统一使用原生 SVG:

  • 深色网格背景;
  • 语义色;
  • 圆角卡片;
  • 高对比箭头;
  • 节点控制在 4—8 个;
  • 同一概念全站使用同一颜色;
  • 图片必须有 alt 和正文解释。

不要把原生 Mermaid 直接作为最终展示形式。

安全标准

  • 不展示真实 token、API key、用户 ID 或聊天 ID;
  • 凭据进入 Hermes 登录或凭据输入,不进入普通聊天、截图或 Git;
  • 安装课先讲最小凭据安全,第 05 课建立完整判断;
  • 后续页面只写本课新增风险,不重复整套警告;
  • 发布、支付、删除和生产变更必须保留人工决定;
  • 排错先停止并观察,不把重装当首选方案。

验收标准

  • 概念课:分类正确、能解释理由、能指出不适用情况;
  • 操作课:产物或状态存在、输入输出清楚、可停止或撤销;
  • 排错课:记录现象、证据、原因、修复和复查;
  • 综合课:自动检查与人工事实核对同时通过。

发布前检查

  • [ ] 页面不假设读者懂编程、API 或源码
  • [ ] 每课只引入少量必要概念
  • [ ] 功能事实有官方一手来源
  • [ ] 易变内容标明版本、平台、日期和验证方式
  • [ ] 命令标明用途、位置、影响、预期和失败入口
  • [ ] 有一个可完成的练习或情境判断
  • [ ] 有知识检查、作品和可验证验收
  • [ ] 有权限边界、停止方式和恢复入口
  • [ ] 原生 SVG 可解析、可阅读且有替代文字
  • [ ] 页面没有真实凭据或私人标识
  • [ ] 标题描述读者问题,不是功能清单