Files
SB-Workflow/README.md
T

125 lines
6.9 KiB
Markdown

# SB-Workflow
面向 Codex 的工程协作工作流技能。使用 `$sb-workflow` 加自然语言选择研究、质询、规划、界面设计、执行、审查、工程交付或提交说明阶段,让需求、授权、任务进度和验证证据能够接续。
[快速开始](#快速开始) · [八个阶段](#八个阶段) · [目录结构](#目录结构) · [参与维护](CONTRIBUTING.md) · [更新记录](CHANGELOG.md) · [来源与许可](NOTICE.md)
## 适合处理什么
- 调查陌生项目、定位问题,并区分已知事实与待验证假设。
- 对方案中的关键决策进行质询,形成可执行的计划和验收条件。
- 在已授权范围内持续实施、检查和自审,保留复杂任务的恢复记录。
- 按实际需要处理 UI/UX 原型、代码审查、打包交付和提交说明。
技能采用单入口和按需加载的参考文档,无需每次走完全部阶段。普通概念问答、文案和插画无需完整流程。
## 快速开始
### 直接在本仓库使用
需要 Git、支持本地 Skills 的 Codex,以及本私有仓库的访问权限。技能本身是 Markdown 与 YAML 文件,没有需要安装的运行时依赖;实际任务使用的工具和权限由宿主环境提供。
```shell
git clone https://stupidbrain.sbs/FuDie0915/SB-Workflow.git
cd SB-Workflow
```
在 Codex 中打开克隆后的项目。本仓库已提交 `.agents/skills/sb-workflow/`,用于项目级技能发现。
输入以下内容开始使用:
```text
$sb-workflow 研究这个项目
```
也可以直接描述需求:
```text
$sb-workflow 帮我调查这个报错的原因,先给出证据和修复方案
```
### 安装到其他项目
将本仓库的 `sb-workflow/` 整个目录复制到目标项目的 `.agents/skills/sb-workflow/`。保留 `references/` 和 `agents/` 子目录,不能只复制 `SKILL.md`。
以下 PowerShell 示例从本仓库根目录运行;先把目标路径改为你的项目路径:
```powershell
$targetProject = 'D:\path\to\your-project'
$source = (Resolve-Path -LiteralPath '.\sb-workflow').Path
$destination = Join-Path $targetProject '.agents\skills\sb-workflow'
if (-not (Test-Path -LiteralPath $targetProject -PathType Container)) {
throw '目标项目目录不存在,请先修改 targetProject。'
}
if (Test-Path -LiteralPath $destination) {
throw '目标已安装 sb-workflow,请先比较版本,再决定如何更新。'
}
New-Item -ItemType Directory -Path (Split-Path -Parent $destination) -Force | Out-Null
Copy-Item -LiteralPath $source -Destination $destination -Recurse
```
其他系统也按相同的目录结构完整复制即可。
安装后在 Codex 中打开目标项目,再使用 `$sb-workflow`。Codex 会检测技能变化;若未显示,可重启 Codex。项目级目录及发现规则见 [OpenAI 官方 Skills 文档](https://learn.chatgpt.com/docs/build-skills)。
## 八个阶段
| 阶段 | 调用示例 | 主要产出 |
| --- | --- | --- |
| 研究 / RESEARCH | `$sb-workflow 研究这个项目` | 事实、证据、范围与未知项 |
| 质询 / GRILL | `$sb-workflow 质询这个方案中的关键决策` | 关键决策、取舍与待解决问题 |
| 规划 / PLAN | `$sb-workflow 规划这个需求` | 实施步骤、分层 TODO 与验收条件 |
| 界面设计 / UIUX | `$sb-workflow 为这个页面设计原型` | 按确认的简报和候选数量制作原型 |
| 执行 / EXECUTE | `$sb-workflow 执行当前计划` | 已授权的实现、检查与自审证据 |
| 审查 / REVIEW | `$sb-workflow 审查当前修改` | 基于实际差异的审查结论 |
| 工程交付 / DEVOPS | `$sb-workflow 为这个项目制定打包交付方案` | 适合项目的环境、验证与交付方案 |
| 提交说明 / COMMIT | `$sb-workflow 生成提交说明` | 基于实际修改的提交说明草稿 |
这些是同一技能的自然语言调用示例。可以明确指定阶段,也可以让技能根据需求和当前任务状态选择。
## 工作方式
**按事实推进。** 技能强调先复用、保持任务聚焦、区分事实与假设、解释复杂度、暴露失败,并以实际证据完成交付。
**保留可恢复的任务状态。** 短任务可在对话中记录计划和结果;复杂任务优先沿用项目已有约定,否则使用 `.tasks/<task-slug>.md` 保存计划、授权、分层 TODO 和验证证据。
**遵循当前授权与宿主能力。** 研究、规划、审查与提交说明各有范围;审查和提交说明不会自动修改源码或 Git 状态。实现、提交、推送或部署应遵循用户的实际授权。阶段名称描述工作职责,不能改变宿主权限或实际运行模式。
详细约定见 [技能入口](sb-workflow/SKILL.md) 和 [阶段与授权规则](sb-workflow/references/workflow.md)。
## 目录结构
```text
SB-Workflow/
├── README.md # 项目介绍、安装与用法
├── CONTRIBUTING.md # 维护约定与检查方法
├── CHANGELOG.md # 更新记录
├── NOTICE.md # 来源与许可状态
├── .gitignore # 本地配置、凭据及临时文件忽略规则
├── .gitattributes # 文本换行与上游快照保留规则
├── .editorconfig # 编辑器编码与格式约定
├── sb-workflow/ # 维护与安装使用的技能源目录
│ ├── SKILL.md # 单入口、路由与共同约束
│ ├── agents/openai.yaml # Codex 界面元数据
│ └── references/ # 11 份按需读取的参考文档
├── .agents/skills/sb-workflow/ # 本仓库的项目级安装副本
├── .tasks/sb-workflow.md # 适配、安装与仓库维护记录
└── upstream/fd-engineering/ # 原始参考快照,保留原样
```
`sb-workflow/` 是维护源目录,`.agents/skills/sb-workflow/` 应与其保持一致。安装到其他项目时只需复制技能目录;`upstream/` 是来源参考,无需一并安装。
## 验证与当前状态
仓库维护检查包括 Markdown 引用、技能文件完整性、源目录与安装副本一致性,以及上游快照是否保持原样。具体要求见 [贡献指南](CONTRIBUTING.md),已有适配和本机技能发现的检查证据保存在 [维护记录](.tasks/sb-workflow.md)。
静态检查和技能发现检查覆盖文件结构与加载状态。真实模型的隐式触发、阶段选择及业务执行效果仍需在具体宿主和任务中验证。
## 反馈与维护
有访问权限的协作者可在 [Issues](https://stupidbrain.sbs/FuDie0915/SB-Workflow/issues) 报告问题或提出建议,通过 [Pull Requests](https://stupidbrain.sbs/FuDie0915/SB-Workflow/pulls) 提交修改。请附上触发示例、预期行为、实际结果和必要的脱敏证据。
本仓库尚未声明开源许可证。原始参考来源及许可状态见 [NOTICE.md](NOTICE.md)。