update readme

This commit is contained in:
cexll
2025-11-24 21:52:24 +08:00
parent b5183c7711
commit 9a18a03061
3 changed files with 105 additions and 105 deletions

View File

@@ -1,163 +1,163 @@
# /dev - 极简开发工作流
# /dev - Minimal Dev Workflow
## 概述
## Overview
全新设计的轻量级开发工作流,无历史包袱,专注快速交付高质量代码。
A freshly designed lightweight development workflow with no legacy baggage, focused on delivering high-quality code fast.
## 工作流程
## Flow
```
/dev 触发
/dev trigger
AskUserQuestion(需求澄清)
AskUserQuestion (requirements clarification)
Codex 分析(提取要点和任务)
Codex analysis (extract key points and tasks)
develop-doc-generator(生成开发文档)
develop-doc-generator (create dev doc)
Codex 并发开发2-5个任务
Codex concurrent development (25 tasks)
Codex 测试验证≥90%覆盖率)
Codex testing & verification (≥90% coverage)
完成(生成总结)
Done (generate summary)
```
## 6个步骤
## The 6 Steps
### 1. 需求澄清
- 使用 **AskUserQuestion** 直接问用户
- 无评分系统,无复杂逻辑
- 2-3 轮问答直到需求明确
### 1. Clarify Requirements
- Use **AskUserQuestion** to ask the user directly
- No scoring system, no complex logic
- 23 rounds of Q&A until the requirement is clear
### 2. Codex 分析
- 调用 codex 分析需求
- 提取核心功能、技术要点、任务列表2-5个
- 输出结构化分析结果
### 2. Codex Analysis
- Call codex to analyze the request
- Extract: core functions, technical points, task list (25 items)
- Output a structured analysis
### 3. 生成开发文档
- 调用 **develop-doc-generator** agent
- 生成 `dev-plan.md`(单一开发文档)
- 包含:任务分解、文件范围、依赖关系、测试命令
### 3. Generate Dev Doc
- Call the **develop-doc-generator** agent
- Produce a single `dev-plan.md`
- Include: task breakdown, file scope, dependencies, test commands
### 4. 并发开发
- 基于 dev-plan.md 的任务列表
- 无依赖任务 → 并发执行
- 有冲突任务 → 串行执行
### 4. Concurrent Development
- Work from the task list in dev-plan.md
- Independent tasks → run in parallel
- Conflicting tasks → run serially
### 5. 测试验证
- 每个 codex 任务自己:
- 实现功能
- 编写测试
- 运行覆盖率
- 报告结果(≥90%
### 5. Testing & Verification
- Each codex task:
- Implements the feature
- Writes tests
- Runs coverage
- Reports results (≥90%)
### 6. 完成
- 汇总任务状态
- 记录覆盖率
### 6. Complete
- Summarize task status
- Record coverage
## 使用方法
## Usage
```bash
/dev "实现用户登录功能,支持邮箱和密码验证"
/dev "Implement user login with email + password"
```
**无选项**,流程固定,开箱即用。
**No options**, fixed workflow, works out of the box.
## 输出结构
## Output Structure
```
.claude/specs/{feature_name}/
── dev-plan.md # 开发文档(agent生成)
── dev-plan.md # Dev document generated by agent
```
仅 2 个文件,极简清晰。
Only one file—minimal and clear.
## 核心组件
## Core Components
### 工具
- **AskUserQuestion**:交互式需求澄清
- **codex**:分析、开发、测试
- **develop-doc-generator**生成开发文档subagent节省上下文
### Tools
- **AskUserQuestion**: interactive requirement clarification
- **codex**: analysis, development, testing
- **develop-doc-generator**: generate dev doc (subagent, saves context)
## 核心特性
## Key Features
### ✅ 全新设计
- 无历史项目残留
- 无复杂评分逻辑
- 无多余抽象层
### ✅ Fresh Design
- No legacy project residue
- No complex scoring logic
- No extra abstraction layers
### ✅ 极简编排
- orchestrator 直接控制流程
- 只用 3 个工具/组件
- 步骤清晰易懂
### ✅ Minimal Orchestration
- Orchestrator controls the flow directly
- Only three tools/components
- Steps are straightforward
### ✅ 并发能力
- 2-5 个任务并行
- 自动检测依赖和冲突
- codex 独立执行
### ✅ Concurrency
- 25 tasks in parallel
- Auto-detect dependencies and conflicts
- Codex executes independently
### ✅ 质量保证
- 强制 90% 覆盖率
- codex 自己测试和验证
- 失败自动重试
### ✅ Quality Assurance
- Enforces 90% coverage
- Codex tests and verifies its own work
- Automatic retry on failure
## 示例
## Example
```bash
# 触发
/dev "添加用户登录功能"
# Trigger
/dev "Add user login feature"
# 步骤 1: 需求澄清
Q: 支持哪些登录方式?
A: 邮箱 + 密码
Q: 需要记住登录状态吗?
A: 是,使用 JWT token
# Step 1: Clarify requirements
Q: What login methods are supported?
A: Email + password
Q: Should login be remembered?
A: Yes, use JWT token
# 步骤 2: Codex 分析
输出:
- 核心功能:邮箱密码登录 + JWT认证
- 任务 1后端 API
- 任务 2密码加密
- 任务 3前端表单
# Step 2: Codex analysis
Output:
- Core: email/password login + JWT auth
- Task 1: Backend API
- Task 2: Password hashing
- Task 3: Frontend form
# 步骤 3: 生成文档
dev-plan.md 已生成
# Step 3: Generate doc
dev-plan.md generated
# 步骤 4-5: 并发开发
[task-1] 后端API → 测试 → 92% ✓
[task-2] 密码加密 → 测试 → 95% ✓
[task-3] 前端表单 → 测试 → 91% ✓
# Step 4-5: Concurrent development
[task-1] Backend API → tests → 92% ✓
[task-2] Password hashing → tests → 95% ✓
[task-3] Frontend form → tests → 91% ✓
```
## 目录结构
## Directory Structure
```
dev-workflow/
├── README.md # 本文档
├── README.md # This doc
├── commands/
│ └── dev.md # 工作流定义
│ └── dev.md # Workflow definition
└── agents/
└── develop-doc-generator.md # 文档生成器
└── develop-doc-generator.md # Doc generator
```
极简结构,只有 3 个文件。
Minimal structure, only three files.
## 适用场景
## When to Use
**适合**
- 任何规模的功能开发
- 需要快速迭代
- 需要高测试覆盖率
- 希望并发提速
**Good for**:
- Any feature size
- Fast iterations
- High test coverage needs
- Wanting concurrent speed-up
## 设计原则
## Design Principles
1. **KISS**:保持简单愚蠢
2. **即用即抛**:无持久化配置
3. **质量优先**:强制 90% 覆盖率
4. **并发优先**:充分利用 codex 能力
5. **无历史包袱**:全新设计,不受其他项目影响
1. **KISS**: keep it simple
2. **Disposable**: no persistent config
3. **Quality first**: enforce 90% coverage
4. **Concurrency first**: leverage codex
5. **No legacy baggage**: clean-slate design
---
**哲学**:像 Linus 一样对复杂度零容忍,交付能立刻用的最小方案。
**Philosophy**: zero tolerance for complexity—ship the smallest usable solution, like Linus would.