Workflow Note(流程笔记)

Polar Sponsor
爱发电 赞助
.NET 9.0

流程构建类笔记的写作规范与模板。用于在 workflows/ 分类下撰写新笔记,涵盖文章结构、内容要求、质量标准、发布流程。笔记规范定义全局规范(目录结构、命名、语言),本技能则定义 workflows/ 分类的具体写作模板。

流程构建笔记写作规范

功能概述

流程构建笔记写作规范是一项面向实际任务的技能,主要用于为 workflows/ 分类撰写笔记时,遵循本规范;流程构建笔记记录 用 AI 搭建自动化流程的完整经验;

核心要点

  • 读者看完后应该能够复现你的方案;
  • 与 tools/(工具推荐)的区别:本分类关注"怎么把工具组合成流程",而非单个工具怎么用;
  • 先读 ~/.openclaw/skills/note-taking/SKILL.md (全局规范:命名、语言、侧边栏等。

使用与执行

它将相关步骤、工具调用和结果整理方式集中到统一流程中,帮助使用者更快完成目标并减少重复操作。从功能定位来看,该技能强调把分散的操作要求整理成清晰、可复用的处理流程,使用户能够围绕既定目标快速准备输入、选择执行方式并获得结构化结果。实际使用前应先确认任务范围、数据来源、运行环境、必要权限和关键参数,再依据技能说明逐步执行;

结果检查与注意事项

若输入条件不完整,应先补齐信息或采用保守配置,避免因错误假设导致结果偏离需求。执行过程中需要关注工具调用是否成功、接口或依赖是否可用、输出格式是否符合预期,并对异常提示、缺失字段和边界情况进行处理;涉及批量任务时,还应保存进度,避免中断后重复操作。

流程构建笔记写作规范

为 workflows/ 分类撰写笔记时,遵循本规范。

定位

流程构建笔记记录用 AI 搭建自动化流程的完整经验。读者看完后应该能够复现你的方案。

与 tools/(工具推荐)的区别:本分类关注"怎么把工具组合成流程",而非单个工具怎么用。

写作流程

  1. 先读 ~/.openclaw/skills/note-taking/SKILL.md(全局规范:命名、语言、侧边栏等)
  2. 先查重:搜索已有 workflows/ 笔记,同主题不重复创建
  3. 先想主题:提炼一个明确的技术主题,不是按时间堆砌做了什么
  4. 按模板写:使用下方模板
  5. 读实际配置:如果涉及 cron 任务、HEARTBEAT.md、AGENTS.md 等配置,必须从实际文件中读取完整内容写入笔记,不能给简略描述
  6. 发布:构建、提交、推送

文章结构模板

---
type: guide | experience
title: 标题(30字符以内,中文)
tags: [标签1, 标签2]
---

# 标题

## 这是什么

用一两句话说清楚这是什么、解决什么问题。让读者 5 秒内判断是否需要继续看。

## 最终效果

列出读者照做之后能得到什么。用具体、可感知的描述,不要写空话。

## 整体架构

用 ASCII 图或表格展示方案的宏观结构。让读者一眼看懂组件关系和数据流向。

## 实操步骤

分步骤、带命令/代码、可复现。每一步都是"照着做就能成"的级别。

### 第一步:xxx

### 第二步:xxx

...

## 踩坑记录

记录实际遇到的问题和解决方案。只保留有价值的,不要凑数。

### 1. 问题描述

**原因**:xxx
**解决**:xxx

## 参考资料

- [标题](链接)

内容要求

必须做到

  • 中文撰写:所有正文内容使用中文
  • 可复现:读者照着步骤能跑通,不缺前提条件
  • 配置完整:涉及 cron prompt、HEARTBEAT.md、AGENTS.md 等配置内容时,从实际文件中读取完整版本写入,不简略
  • 代码可执行:所有命令和代码片段都经过验证
  • 有具体案例:用实际数据说话,不要空泛描述

禁止做到

  • 禁止流水账:不要按时间线堆砌"Phase 1 / Phase 2 / Phase 3"
  • 禁止英文正文:标题、标签、代码中的英文可以,正文必须中文
  • 禁止占位符:不要写"参考相关文档"然后不给链接
  • 禁止空话:不要写"极大提升了效率"这种无法验证的描述
  • 禁止敏感信息:不泄露任何个人身份、密钥、内部地址等敏感内容

type 选择

type 适用场景
guide 教程:读者可以照着做的步骤指南
experience 经验:踩坑记录、项目复盘、架构思考

详见

  • 完整写作示例:见 references/example.md

相关专题

更多
Go-Zero API开发使用教程
Go-Zero API开发使用教程

本专题聚焦Go-Zero的API开发,拆解.api描述文件的语法结构、路由与分组定义、参数绑定与校验规则,说明统一响应体、JWT鉴权、跨域与接口文档生成的落地方式,并给出网关聚合与接口测试的实践建议。

2026.11.12

0

15

Go-Zero安装与goctl环境配置教程
Go-Zero安装与goctl环境配置教程

本专题围绕Go-Zero的安装与工具链配置展开,讲清Go版本要求、goctl安装方式、代理镜像、protoc依赖与环境变量设置,说明多版本共存、升级回退与CI流水线安装的做法,并整理安装阶段的常见报错与验证步骤。

2026.11.12

0

15

Go-Zero零基础入门教程
Go-Zero零基础入门教程

本专题整理Go-Zero的入门知识,从框架定位、环境准备到跑通第一个API服务,讲清目录分层、配置加载、日志与中间件的基本用法,并对比Gin、Kratos的差异,帮助Go开发者建立整体认知,判断它是否适合当前项目。

2026.11.12

0

15

Postman身份认证怎么配置
Postman身份认证怎么配置

本专题从实际API接口调试场景出发,讲解Postman身份认证的完整配置流程,包括常见认证协议介绍、授权参数设置、访问令牌填写、OAuth 2.0授权及认证失败排查,帮助用户正确完成接口授权与访问验证。

2026.11.06

0

12

Postman请求头Headers怎么设置
Postman请求头Headers怎么设置

围绕Postman HTTP请求头配置展开,讲解Headers选项的具体使用方式,包括Key和Value参数填写、请求头信息添加、常见Header字段设置及请求头修改方法,帮助用户解决接口调试过程中遇到的请求头配置问题。

2026.11.06

0

13

Postman接口请求发送教程
Postman接口请求发送教程

详细介绍Postman接口请求的创建与发送方法,涵盖GET和POST请求、URL配置、请求参数、Headers请求头、Body请求体设置以及响应结果查看,帮助用户掌握Postman接口请求的完整操作流程。

2026.11.06

0

10

DBeaver怎么导入数据
DBeaver怎么导入数据

DBeaver数据导入专题,整理Excel、CSV、SQL、TXT等常见文件的数据导入方法,涵盖目标数据库选择、数据表创建、字段映射、数据类型设置及导入参数配置等操作,帮助用户将本地文件中的数据写入数据库,并了解批量导入、重复数据处理和导入失败等常见问题的解决方法。

2026.11.05

0

12

DBeaver安全防护教程大全
DBeaver安全防护教程大全

DBeaver安全防护专题,围绕数据库连接安全、账号密码保护和访问权限管理展开,整理SSL/TLS加密连接、SSH隧道、数据库凭据保存及证书验证等配置方法,同时介绍敏感信息保护、远程连接风险和高权限账号使用等注意事项,帮助用户提高数据库日常管理的安全性。

2026.11.05

0

12

DBeaver连接创建与配置教程
DBeaver连接创建与配置教程

本专题聚焦DBeaver数据库连接配置与管理,覆盖从新建连接、选择数据库类型到填写连接参数和验证连接的完整流程。针对MySQL、PostgreSQL、SQL Server等常见数据库,整理相应的连接设置方法,并提供驱动缺失、认证失败和连接异常等问题的排查方向。

2026.11.04

0

16

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
热门推荐
/
最新课程
phpStudy极速入门视频教程
phpStudy极速入门视频教程

共6课时 | 54.7万人学习

独孤九贱(4)_PHP视频教程
独孤九贱(4)_PHP视频教程

共89课时 | 134.3万人学习