文档总览

这套文档围绕一条主线来写

先把 workflow 跑起来，再接入命令，再决定是否需要持久化和扩展点

先记住三件事

• clack-kit 默认是轻量模式
• history、checkpoint、logs 默认都关闭
• values 和 results 分开存放，输入与产物不混在一起

推荐阅读顺序

1. 快速开始
2. 核心概念
3. 示例导览
4. 定义工作流
5. 命令执行
6. CLI 集成
7. 状态与持久化
8. 运行时上下文
9. 模板与插件
10. API 参考
11. 排障
12. 设计与实现

按角色进入

第一次接触仓库

• 从 快速开始 入手
• 再看 核心概念
• 然后挑一篇 示例导览 里的场景照着改

已经在写流程

• 需要组织 DSL 时，看 定义工作流
• 需要具体字段时，看 步骤类型参考
• 需要把命令接进去时，看 命令执行

需要持久化与恢复

• 先看 状态与持久化
• 再看 运行时上下文
• 有具体问题时直接查 排障

需要扩展默认能力

• 扩展模板、插件和工具时，看 模板与插件
• 查导出、类型和默认值时，看 API 参考
• 想理解模块边界时，看 设计与实现

文档地图

开始

• 快速开始
• 示例导览
• 核心概念

核心用法

• 定义工作流
• 步骤类型参考
• 命令执行
• CLI 集成

参考

• 状态与持久化
• 运行时上下文
• 模板与插件
• API 参考
• 国际化与时区
• 排障
• 最佳实践
• 设计与实现

仓库内的另外两个入口

• 根目录 README 负责最短路径介绍
• examples/README 负责示例文件索引