Skip to content

zjy-dev/playbook

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 

Repository files navigation

Playbook

把"做一件事的最佳实践"沉淀为结构化、可被 agent 直接消费的 SOP 集合。

这是什么

Playbook 是一个最佳实践仓库。每当我们摸索出一类任务的高质量做法(尤其涉及 agent 的 skill / subagent / mcp 协作,但不限于 agent),就把它固化成一个 SOP,让下一次(无论是人还是 agent)都能照着稳定复现,而不必从零摸索。

它解决的核心问题:经验不流失、执行不走样、人机协作边界清晰

核心概念

概念 含义
playbook 本仓库整体,即所有 SOP 的集合
SOP 某一类任务的标准作业流程,存放于 playbooks/<sop_name>/
三个环节 每个 SOP 都遵循的统一骨架:① 环境配置 ② 用户需要准备的内容 ③ 具体执行步骤和 prompt
sop_name SOP 类型/模板名,可复用,如 paper-to-ppt。用作目录名
task_name 具体任务实例名,一次性,如 paper-to-ppt-llm-survey。用作分支名 tasks/<task_name>

关键区分:sop_name 是"做哪类事",task_name 是"这一次具体做的那件事"。一个 sop_name 会被多个 task_name 复用。

目录结构

playbook/
├── README.md                      # 本文件,给用户/贡献者
├── AGENTS.md                      # 给 agent 的全局约定(自动加载)
└── playbooks/
    ├── environment-setup/         # 公共环境自查 SOP,被其他 SOP 引用
    │   ├── SOP.md
    │   └── README.md
    ├── _template/                 # 新建 SOP 的模板,复制它来起步
    │   ├── SOP.md
    │   └── README.md
    └── <sop_name>/                # 每个具体 SOP
        ├── SOP.md                 # 写给 agent,用户可 never read
        ├── README.md              # 写给用户:准备物 + prompt 模板
        └── ...                    # 该 SOP 额外需要的文件夹
  • SOP.md:写给 agent 的标准作业流程,用户可以完全不看。
  • README.md:写给用户,一般只含"用户需要准备什么"和"召唤 agent 的 prompt 模板";若该 SOP 确需用户亲自参与执行,也可包含执行章节。

用户使用流程

  1. 定位 SOP:在下方索引里找到你要做的任务类型。
  2. 读它的 README.md:看清需要准备什么。
  3. 准备输入:按 README 把素材备好(如把要讲的图表截好、按序号重命名放进一个文件夹)。
  4. 召唤 agent:复制 README 里的 prompt 模板,只替换极少数占位符(通常只有 {{task_name}}),发给 agent 即可。

Playbook 索引

sop_name 用途
environment-setup 公共环境自查(分支 / 传统软件环境 / agent 环境),被其他 SOP 引用
paper-to-ppt 把一篇论文(PDF)做成图片驱动的学术宣讲 PPT
_template 新建 SOP 的模板骨架

新增 SOP 时请在此表登记。

如何新增一个 Playbook

  1. 复制 playbooks/_template/playbooks/<你的 sop_name>/
  2. 填写 SOP.md(给 agent)与 README.md(给用户)。
  3. 环节 1 直接引用 environment-setup,只补充本 SOP 的差异项。
  4. 在上方"Playbook 索引"表登记。

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors