首页 / 技能 / Scribe Tech Tutorial — 教程写作助手

\ud83e\udd9e Scribe Tech Tutorial — 教程写作助手

v1.0.0

为开发者规划、起草并打磨技术教程，提供结构化流程：定义范围→列大纲→验证示例代码→撰写正文→渐进复杂度→质量检查，确保每篇教程步骤清晰、代码可运行、学习成果明确。

0· 25·1 当前·1 累计
athola 头像by @athola
开发工具文档工具生产力工具代码生成工作流
下载技能包 项目主页
最后更新
2026/4/20
0
安全扫描
VirusTotal
无害
查看报告
OpenClaw
安全
high confidence
该技能仅为指令型教程撰写助手，其声明的需求与运行时指令与用途一致，不会索取无关凭据或下载内容。
评估建议
此技能专注于编写开发者教程，不索取凭据或安装代码。主要风险在于执行示例代码：运行任何片段前请先检查，并在隔离环境（container、VM）中运行不受信任的代码；同时确认所引用的配套技能（如 scribe:slop-detector）可信。如需额外安全层，可禁用智能体自主调用或在运行前审查操作。
详细分析 ▾
✓ 用途与能力
名称/描述（起草技术教程）与所含模块及运行时指令一致。仅声明两个配置路径（night-market.scribe:shared 与 night-market.scribe:slop-detector），与 SKILL.md 提到的 slop 检测器及共享 scribe 模块相符，无无关二进制、环境变量或外部服务请求。
ℹ 指令范围
SKILL.md 指示智能体编写大纲、起草代码示例，并在真实环境中“运行”并验证片段。此行为符合教程写作目的，但意味着智能体（或用户）将执行命令/代码并捕获输出。未指示读取无关系统文件或向外发送数据。用户应在执行前审查示例代码，并优先在隔离/测试环境（容器、VM）运行不受信任的片段。
✓ 安装机制
纯指令型技能，无安装规范与代码文件，最大限度降低磁盘/写入风险——无任何下载或安装器执行。
✓ 凭证需求
技能无需环境变量或凭据。声明的两个配置路径为内部技能配置挂钩（共享模块与 slop 检测器），与所述功能相称。
✓ 持久化与权限
always:false 且无安装步骤；技能不请求永久或提权驻留。它引用其他技能（scribe:slop-detector）作为工作流一部分；默认允许自主调用，属技能常规行为，此处不过度。
安全有层次，运行前请审查代码。

运行时依赖

无特殊依赖

版本

latestv1.0.02026/4/20

- 首次发布“tech-tutorial”技能，用于为开发者规划、起草并打磨技术教程。 - 提供结构化方法论与清晰步骤：范围定义、大纲创建、代码示例验证、正文撰写、渐进复杂度、slop 检查及最终质量门。 - 集成其他 scribe 工具进行 slop 检测与 API 文档编写。 - 包含基于清单的质量要求与详细指南，用于撰写实用、动手实践的教程。 - 旨在产出步骤清晰、代码驱动、经过严格测试且学习成果明确的指南。

● 无害

安装命令

点击复制
官方npx clawhub@latest install nm-scribe-tech-tutorial
镜像加速npx clawhub@latest install nm-scribe-tech-tutorial --registry https://cn.longxiaskill.com

技能文档

Night Market Skill — 从 claude-night-market/scribe 移植。如需完整的 agent、hook 与命令体验，请安装 Claude Code 插件。

# Tech Tutorial（技术教程）

一篇优秀的技术教程只有一个目标：让读者从“不会做”到“能做”。这需要可运行的代码、具体的步骤，以及对出错点的坦诚说明。本技能将引导你完成教程的大纲、起草与验证，确保达到这一标准。

何时使用

  • 为某个库、CLI 工具或 API 撰写入门指南
  • 创建读者可在终端一步步跟进的演练
  • 通过动手练习讲解技术概念
  • 产出一份补充 API 参考文档的实操教程

何时不要使用

  • 生成 API 参考文档（请用 scribe:doc-generator）
  • 润色已有文字（请用 scribe:slop-detector）
  • 仅做高层架构概述而无可运行步骤
  • 写无动手环节的概念性文章

方法论

第 1 步：界定范围与受众

落笔前回答以下问题：

  • 目标读者是谁？（经验水平、假定已有知识）
  • 完成后他们将构建或实现什么？
  • 读者必须预先安装的唯一先决条件是什么？
  • 哪些内容明确不在范围内？

将答案写成草稿顶部的说明块。如果无法一句话回答“他们将实现什么”，范围就太宽了。

第 2 步：大纲

加载：@modules/outline-structure.md 起草正文前先给出逐节大纲。每节条目必须一句话说明读者在该节“做什么”或“学到什么”。参考大纲模块了解标准章节顺序与长度目标。

第 3 步：先写代码示例

加载：@modules/code-examples.md 先写代码，再写说明。每段代码必须在真实环境中跑通后才能进入教程。仅对非显式行加注释。参考代码示例模块了解格式与错误处理规则。

第 4 步：围绕代码起草正文

正文用于解释代码做了什么、为什么这么做。遵守以下规则：

  • 一步一段：要运行什么、它做了什么、预期结果
  • 每个命令块后给出预期输出
  • 全文统一使用第二人称（“你”）
  • 不要预告下一步，直接给出下一步

第 5 步：逐步增加复杂度

加载：@modules/progressive-complexity.md 从最小可运行示例开始，基线跑通后再引入变体与边界情况。参考渐进复杂度模块了解分层规则与节奏指导。

第 6 步：清理“废话”

起草后运行： `` Skill(scribe:slop-detector) ` 先修复所有一级发现。重点关注：

  • 一级词汇废话（见 scribe:slop-detector 词表）
  • 三词并列形容词堆叠（如“快速、高效且可靠”）
  • 句尾现在分词拖尾（如“, enabling …”）

第 7 步：质量门槛

对照以下清单验证最终教程：

  • [ ] 所有代码块已测试并产生所述输出
  • [ ] 先决条件章节列出相关确切版本
  • [ ] 每一步都说明预期结果
  • [ ] 故障排除章节至少覆盖两种常见失败情形
  • [ ] 无一一级废话词
  • [ ] 每 1000 字破折号少于 2 个
  • [ ] 无序列表占比低于 40%
  • [ ] 行长度在 80 字符处换行

必需的 TodoWrite 项

  • tech-tutorial:scope-defined — 已注明受众、目标与范围外内容
  • tech-tutorial:outline-approved — 章节大纲已确认
  • tech-tutorial:code-tested — 所有代码片段已在真实环境验证
  • tech-tutorial:prose-drafted — 已撰写步骤说明文字
  • tech-tutorial:slop-scanned — 已通过废话检测
  • tech-tutorial:quality-verified — 已通过质量门槛清单
  • tech-tutorial:user-approved — 已获得最终批准

模块参考

  • 见 modules/outline-structure.md 了解章节顺序与长度目标
  • 见 modules/code-examples.md 了解代码段格式与注释规则
  • 见 modules/progressive-complexity.md` 了解节奏与分层指导

与其他技能集成

技能使用场景
scribe:slop-detector起草后、批准前
scribe:doc-generator配套 API 参考章节
scribe:style-learner匹配已有教程语气

退出条件

  • 教程大纲在起草前已确认
  • 所有代码片段在真实环境测试通过
  • 废话评分低于 1.5（干净）
  • 通过质量门槛清单
  • 获得用户批准
数据来源：ClawHub ↗ · 中文优化：龙虾技能库