cc-devflow 1.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.claude/CLAUDE.md +83 -0
- package/.claude/agents/architecture-designer.md +443 -0
- package/.claude/agents/bug-analyzer.md +382 -0
- package/.claude/agents/checklist-agent.md +175 -0
- package/.claude/agents/clarify-analyst.md +50 -0
- package/.claude/agents/code-reviewer.md +71 -0
- package/.claude/agents/codex-analyzer.md +39 -0
- package/.claude/agents/compatibility-checker.md +580 -0
- package/.claude/agents/consistency-checker.md +532 -0
- package/.claude/agents/impact-analyzer.md +441 -0
- package/.claude/agents/planner.md +230 -0
- package/.claude/agents/prd-writer.md +320 -0
- package/.claude/agents/project-guidelines-generator.md +1329 -0
- package/.claude/agents/qa-tester.md +313 -0
- package/.claude/agents/release-manager.md +295 -0
- package/.claude/agents/security-reviewer.md +314 -0
- package/.claude/agents/style-guide-generator.md +458 -0
- package/.claude/agents/tech-architect.md +516 -0
- package/.claude/agents/ui-designer.md +485 -0
- package/.claude/commands/code-review-high.md +58 -0
- package/.claude/commands/core-architecture.md +429 -0
- package/.claude/commands/core-guidelines.md +486 -0
- package/.claude/commands/core-roadmap.md +439 -0
- package/.claude/commands/core-style.md +293 -0
- package/.claude/commands/flow-archive.md +245 -0
- package/.claude/commands/flow-checklist.md +260 -0
- package/.claude/commands/flow-clarify.md +136 -0
- package/.claude/commands/flow-constitution.md +82 -0
- package/.claude/commands/flow-dev.md +134 -0
- package/.claude/commands/flow-epic.md +150 -0
- package/.claude/commands/flow-fix.md +104 -0
- package/.claude/commands/flow-ideate.md +214 -0
- package/.claude/commands/flow-init.md +313 -0
- package/.claude/commands/flow-new.md +394 -0
- package/.claude/commands/flow-prd.md +131 -0
- package/.claude/commands/flow-qa.md +93 -0
- package/.claude/commands/flow-release.md +92 -0
- package/.claude/commands/flow-restart.md +98 -0
- package/.claude/commands/flow-status.md +64 -0
- package/.claude/commands/flow-tech.md +142 -0
- package/.claude/commands/flow-ui.md +189 -0
- package/.claude/commands/flow-update.md +111 -0
- package/.claude/commands/flow-upgrade.md +115 -0
- package/.claude/commands/flow-verify.md +96 -0
- package/.claude/commands/problem-analyzer.md +60 -0
- package/.claude/config/quality-rules.yml +161 -0
- package/.claude/docs/SPEC_KIT_CONSTITUTION_ANALYSIS.md +426 -0
- package/.claude/docs/design/consistency-conflict-detection-algorithms.md +658 -0
- package/.claude/docs/design/intent-driven-input-design.md +380 -0
- package/.claude/docs/design/prd-version-management-design.md +437 -0
- package/.claude/docs/guides/INIT_TROUBLESHOOTING.md +117 -0
- package/.claude/docs/guides/NEW_TROUBLESHOOTING.md +151 -0
- package/.claude/docs/guides/ROADMAP_TROUBLESHOOTING.md +188 -0
- package/.claude/docs/guides/TASK_COMPLETION_MARKING.md +338 -0
- package/.claude/docs/templates/ARCHITECTURE_TEMPLATE.md +633 -0
- package/.claude/docs/templates/BACKLOG_TEMPLATE.md +261 -0
- package/.claude/docs/templates/CHECKLIST_TEMPLATE.md +52 -0
- package/.claude/docs/templates/CLARIFICATION_REPORT_TEMPLATE.md +206 -0
- package/.claude/docs/templates/CODE_REVIEW_TEMPLATE.md +71 -0
- package/.claude/docs/templates/EPIC_TEMPLATE.md +805 -0
- package/.claude/docs/templates/INIT_FLOW_TEMPLATE.md +213 -0
- package/.claude/docs/templates/INTENT_CLARIFICATION_TEMPLATE.md +57 -0
- package/.claude/docs/templates/NEW_ORCHESTRATION_TEMPLATE.md +148 -0
- package/.claude/docs/templates/PRD_TEMPLATE.md +562 -0
- package/.claude/docs/templates/RESEARCH_TEMPLATE.md +276 -0
- package/.claude/docs/templates/REVIEW-HIGH.md +57 -0
- package/.claude/docs/templates/ROADMAP_DIALOGUE_TEMPLATE.md +198 -0
- package/.claude/docs/templates/ROADMAP_TEMPLATE.md +310 -0
- package/.claude/docs/templates/STYLE_TEMPLATE.md +1266 -0
- package/.claude/docs/templates/TASKS_TEMPLATE.md +523 -0
- package/.claude/docs/templates/TECH_DESIGN_TEMPLATE.md +1019 -0
- package/.claude/docs/templates/UI_PROTOTYPE_TEMPLATE.md +1436 -0
- package/.claude/guides/agent-guides/agent-coordination-guide.md +459 -0
- package/.claude/guides/project-guidelines-system.md +463 -0
- package/.claude/guides/technical-guides/datetime-handling-guide.md +563 -0
- package/.claude/guides/technical-guides/git-github-guide.md +642 -0
- package/.claude/guides/technical-guides/test-execution-guide.md +618 -0
- package/.claude/guides/workflow-guides/bug-fix-orchestrator.md +217 -0
- package/.claude/guides/workflow-guides/flow-orchestrator.md +282 -0
- package/.claude/hooks/checklist-gate.js +397 -0
- package/.claude/hooks/error-handling-reminder.sh +12 -0
- package/.claude/hooks/error-handling-reminder.ts +459 -0
- package/.claude/hooks/post-tool-use-tracker.sh +280 -0
- package/.claude/hooks/pre-tool-use-guardrail.sh +36 -0
- package/.claude/hooks/pre-tool-use-guardrail.ts +342 -0
- package/.claude/hooks/skill-activation-prompt.sh +36 -0
- package/.claude/hooks/skill-activation-prompt.ts +214 -0
- package/.claude/hooks/state/skills-used-test-guard.json +3 -0
- package/.claude/rules/devflow-conventions.md +305 -0
- package/.claude/rules/project-constitution.md +748 -0
- package/.claude/schemas/constitution.schema.json +43 -0
- package/.claude/scripts/analyze-upgrade-impact.sh +200 -0
- package/.claude/scripts/archive-requirement.sh +351 -0
- package/.claude/scripts/calculate-checklist-completion.sh +243 -0
- package/.claude/scripts/calculate-quarter.sh +206 -0
- package/.claude/scripts/check-dependencies.sh +409 -0
- package/.claude/scripts/check-prerequisites.sh +232 -0
- package/.claude/scripts/check-task-status.sh +264 -0
- package/.claude/scripts/checklist-errors.sh +131 -0
- package/.claude/scripts/common.sh +570 -0
- package/.claude/scripts/consolidate-research.sh +182 -0
- package/.claude/scripts/create-requirement.sh +426 -0
- package/.claude/scripts/export-contracts.sh +117 -0
- package/.claude/scripts/extract-data-model.sh +78 -0
- package/.claude/scripts/generate-clarification-questions.sh +377 -0
- package/.claude/scripts/generate-clarification-report.sh +463 -0
- package/.claude/scripts/generate-quickstart.sh +146 -0
- package/.claude/scripts/generate-research-tasks.sh +157 -0
- package/.claude/scripts/generate-status-report.sh +523 -0
- package/.claude/scripts/generate-tech-analysis.sh +46 -0
- package/.claude/scripts/locate-requirement-in-roadmap.sh +233 -0
- package/.claude/scripts/manage-constitution.sh +602 -0
- package/.claude/scripts/mark-task-complete.sh +198 -0
- package/.claude/scripts/populate-research-tasks.sh +259 -0
- package/.claude/scripts/recover-workflow.sh +460 -0
- package/.claude/scripts/run-clarify-scan.sh +601 -0
- package/.claude/scripts/run-high-review.sh +62 -0
- package/.claude/scripts/run-problem-analysis.sh +68 -0
- package/.claude/scripts/setup-epic.sh +173 -0
- package/.claude/scripts/sync-roadmap-progress.sh +300 -0
- package/.claude/scripts/sync-task-marks.sh +199 -0
- package/.claude/scripts/test-clarify-scan.sh +515 -0
- package/.claude/scripts/update-agent-context.sh +806 -0
- package/.claude/scripts/validate-constitution.sh +567 -0
- package/.claude/scripts/validate-hooks.sh +487 -0
- package/.claude/scripts/validate-research.sh +332 -0
- package/.claude/scripts/validate-scope-boundary.sh +493 -0
- package/.claude/scripts/verify-setup.sh +37 -0
- package/.claude/settings.json +76 -0
- package/.claude/skills/_reference-implementations/README.md +96 -0
- package/.claude/skills/_reference-implementations/backend-express-prisma/SKILL.md +302 -0
- package/.claude/skills/_reference-implementations/backend-express-prisma/resources/architecture-overview.md +451 -0
- package/.claude/skills/_reference-implementations/backend-express-prisma/resources/async-and-errors.md +307 -0
- package/.claude/skills/_reference-implementations/backend-express-prisma/resources/complete-examples.md +638 -0
- package/.claude/skills/_reference-implementations/backend-express-prisma/resources/configuration.md +275 -0
- package/.claude/skills/_reference-implementations/backend-express-prisma/resources/database-patterns.md +224 -0
- package/.claude/skills/_reference-implementations/backend-express-prisma/resources/middleware-guide.md +213 -0
- package/.claude/skills/_reference-implementations/backend-express-prisma/resources/routing-and-controllers.md +756 -0
- package/.claude/skills/_reference-implementations/backend-express-prisma/resources/sentry-and-monitoring.md +336 -0
- package/.claude/skills/_reference-implementations/backend-express-prisma/resources/services-and-repositories.md +789 -0
- package/.claude/skills/_reference-implementations/backend-express-prisma/resources/testing-guide.md +235 -0
- package/.claude/skills/_reference-implementations/backend-express-prisma/resources/validation-patterns.md +754 -0
- package/.claude/skills/_reference-implementations/frontend-react-mui/SKILL.md +399 -0
- package/.claude/skills/_reference-implementations/frontend-react-mui/resources/common-patterns.md +331 -0
- package/.claude/skills/_reference-implementations/frontend-react-mui/resources/complete-examples.md +872 -0
- package/.claude/skills/_reference-implementations/frontend-react-mui/resources/component-patterns.md +502 -0
- package/.claude/skills/_reference-implementations/frontend-react-mui/resources/data-fetching.md +767 -0
- package/.claude/skills/_reference-implementations/frontend-react-mui/resources/file-organization.md +502 -0
- package/.claude/skills/_reference-implementations/frontend-react-mui/resources/loading-and-error-states.md +501 -0
- package/.claude/skills/_reference-implementations/frontend-react-mui/resources/performance.md +406 -0
- package/.claude/skills/_reference-implementations/frontend-react-mui/resources/routing-guide.md +364 -0
- package/.claude/skills/_reference-implementations/frontend-react-mui/resources/styling-guide.md +428 -0
- package/.claude/skills/_reference-implementations/frontend-react-mui/resources/typescript-standards.md +418 -0
- package/.claude/skills/cc-devflow-orchestrator/SKILL.md +229 -0
- package/.claude/skills/constitution-guardian/SKILL.md +306 -0
- package/.claude/skills/devflow-constitution-quick-ref/SKILL.md +374 -0
- package/.claude/skills/devflow-file-standards/SKILL.md +353 -0
- package/.claude/skills/devflow-tdd-enforcer/SKILL.md +192 -0
- package/.claude/skills/skill-developer/ADVANCED.md +197 -0
- package/.claude/skills/skill-developer/HOOK_MECHANISMS.md +306 -0
- package/.claude/skills/skill-developer/PATTERNS_LIBRARY.md +152 -0
- package/.claude/skills/skill-developer/SKILL.md +426 -0
- package/.claude/skills/skill-developer/SKILL_RULES_REFERENCE.md +315 -0
- package/.claude/skills/skill-developer/TRIGGER_TYPES.md +305 -0
- package/.claude/skills/skill-developer/TROUBLESHOOTING.md +514 -0
- package/.claude/skills/skill-rules.json +213 -0
- package/.claude/tests/README.md +300 -0
- package/.claude/tests/TODO.md +69 -0
- package/.claude/tests/__pycache__/test_analyze_upgrade_impact.cpython-311-pytest-7.2.2.pyc +0 -0
- package/.claude/tests/__pycache__/test_consolidate_research.cpython-311-pytest-7.2.2.pyc +0 -0
- package/.claude/tests/__pycache__/test_export_contracts.cpython-311-pytest-7.2.2.pyc +0 -0
- package/.claude/tests/__pycache__/test_extract_data_model.cpython-311-pytest-7.2.2.pyc +0 -0
- package/.claude/tests/__pycache__/test_generate_quickstart.cpython-311-pytest-7.2.2.pyc +0 -0
- package/.claude/tests/__pycache__/test_generate_research_tasks.cpython-311-pytest-7.2.2.pyc +0 -0
- package/.claude/tests/constitution/run_all_constitution_tests.sh +111 -0
- package/.claude/tests/constitution/test_agent_assignment.sh +207 -0
- package/.claude/tests/constitution/test_article_coverage.sh +201 -0
- package/.claude/tests/constitution/test_template_completeness.sh +150 -0
- package/.claude/tests/constitution/test_version_consistency.sh +120 -0
- package/.claude/tests/fixtures/spec_delta_full.md +16 -0
- package/.claude/tests/fixtures/tasks_progress_sample.md +5 -0
- package/.claude/tests/run-all-tests.sh +229 -0
- package/.claude/tests/scripts/run.sh +30 -0
- package/.claude/tests/scripts/test-framework.sh +128 -0
- package/.claude/tests/scripts/test_check_prerequisites.sh +511 -0
- package/.claude/tests/scripts/test_check_prerequisites.sh.bak +504 -0
- package/.claude/tests/scripts/test_check_prerequisites.sh.bak2 +505 -0
- package/.claude/tests/scripts/test_check_prerequisites.sh.bak3 +506 -0
- package/.claude/tests/scripts/test_check_prerequisites.sh.bak4 +507 -0
- package/.claude/tests/scripts/test_check_prerequisites.sh.bak5 +508 -0
- package/.claude/tests/scripts/test_check_task_status.sh +499 -0
- package/.claude/tests/scripts/test_common.sh +244 -0
- package/.claude/tests/scripts/test_generate_status_report.sh +71 -0
- package/.claude/tests/scripts/test_mark_task_complete.sh +441 -0
- package/.claude/tests/scripts/test_mark_task_complete.sh.backup +410 -0
- package/.claude/tests/scripts/test_recover_workflow.sh +304 -0
- package/.claude/tests/scripts/test_setup_epic.sh +437 -0
- package/.claude/tests/scripts/test_sync_task_marks.sh +196 -0
- package/.claude/tests/scripts/test_validate_constitution.sh +74 -0
- package/.claude/tests/scripts/test_validate_research.sh +462 -0
- package/.claude/tests/slugify.bats +82 -0
- package/.claude/tests/test-framework.sh +732 -0
- package/.claude/tests/test_analyze_upgrade_impact.py +34 -0
- package/.claude/tests/test_consolidate_research.py +48 -0
- package/.claude/tests/test_export_contracts.py +43 -0
- package/.claude/tests/test_extract_data_model.py +33 -0
- package/.claude/tests/test_generate_quickstart.py +50 -0
- package/.claude/tests/test_generate_research_tasks.py +52 -0
- package/.claude/tsc-cache/6e64f818-6398-49ca-8623-581a9af85c44/edited-files.log +1 -0
- package/.claude/tsc-cache/795ba6e3-b98a-423b-bab2-51aa62812569/affected-repos.txt +1 -0
- package/.claude/tsc-cache/795ba6e3-b98a-423b-bab2-51aa62812569/edited-files.log +1 -0
- package/.claude/tsc-cache/ae335694-be5a-4ba4-a1a0-b676c09a7906/affected-repos.txt +1 -0
- package/.claude/tsc-cache/ae335694-be5a-4ba4-a1a0-b676c09a7906/edited-files.log +1 -0
- package/CHANGELOG.md +507 -0
- package/LICENSE +21 -0
- package/README.md +534 -0
- package/README.zh-CN.md +530 -0
- package/bin/adapt.js +240 -0
- package/bin/cc-devflow-cli.js +185 -0
- package/bin/cc-devflow.js +78 -0
- package/config/adapters.yml +5 -0
- package/config/schema/adapters.schema.json +44 -0
- package/docs/CLAUDE.md +26 -0
- package/docs/commands/README.md +61 -0
- package/docs/commands/README.zh-CN.md +55 -0
- package/docs/commands/core-roadmap.md +106 -0
- package/docs/commands/core-roadmap.zh-CN.md +102 -0
- package/docs/commands/core-style.md +405 -0
- package/docs/commands/core-style.zh-CN.md +405 -0
- package/docs/commands/flow-init.md +134 -0
- package/docs/commands/flow-init.zh-CN.md +163 -0
- package/docs/commands/flow-new.md +274 -0
- package/docs/commands/flow-new.zh-CN.md +270 -0
- package/docs/guides/getting-started.md +204 -0
- package/docs/guides/getting-started.zh-CN.md +152 -0
- package/lib/adapters/adapter-interface.js +57 -0
- package/lib/adapters/claude-adapter.js +74 -0
- package/lib/adapters/codex-adapter.js +40 -0
- package/lib/adapters/config-validator.js +68 -0
- package/lib/adapters/logger.js +42 -0
- package/lib/adapters/registry.js +153 -0
- package/lib/compiler/CLAUDE.md +92 -0
- package/lib/compiler/__tests__/drift.test.js +215 -0
- package/lib/compiler/__tests__/errors.test.js +184 -0
- package/lib/compiler/__tests__/incremental.test.js +174 -0
- package/lib/compiler/__tests__/integration.test.js +174 -0
- package/lib/compiler/__tests__/manifest.test.js +233 -0
- package/lib/compiler/__tests__/parser.test.js +456 -0
- package/lib/compiler/__tests__/schemas.test.js +301 -0
- package/lib/compiler/__tests__/skills-registry.test.js +125 -0
- package/lib/compiler/__tests__/transformer.test.js +286 -0
- package/lib/compiler/emitters/antigravity-emitter.js +171 -0
- package/lib/compiler/emitters/base-emitter.js +73 -0
- package/lib/compiler/emitters/codex-emitter.js +52 -0
- package/lib/compiler/emitters/cursor-emitter.js +31 -0
- package/lib/compiler/emitters/index.js +50 -0
- package/lib/compiler/emitters/qwen-emitter.js +39 -0
- package/lib/compiler/errors.js +119 -0
- package/lib/compiler/index.js +256 -0
- package/lib/compiler/manifest.js +242 -0
- package/lib/compiler/parser.js +258 -0
- package/lib/compiler/platforms.js +113 -0
- package/lib/compiler/resource-copier.js +320 -0
- package/lib/compiler/rules-emitters/__tests__/antigravity-rules-emitter.test.js +191 -0
- package/lib/compiler/rules-emitters/__tests__/codex-rules-emitter.test.js +109 -0
- package/lib/compiler/rules-emitters/__tests__/cursor-rules-emitter.test.js +123 -0
- package/lib/compiler/rules-emitters/__tests__/qwen-rules-emitter.test.js +123 -0
- package/lib/compiler/rules-emitters/antigravity-rules-emitter.js +253 -0
- package/lib/compiler/rules-emitters/base-rules-emitter.js +83 -0
- package/lib/compiler/rules-emitters/codex-rules-emitter.js +116 -0
- package/lib/compiler/rules-emitters/cursor-rules-emitter.js +98 -0
- package/lib/compiler/rules-emitters/index.js +71 -0
- package/lib/compiler/rules-emitters/qwen-rules-emitter.js +70 -0
- package/lib/compiler/schemas.js +144 -0
- package/lib/compiler/skills-registry.js +225 -0
- package/lib/compiler/transformer.js +236 -0
- package/package.json +50 -0
|
@@ -0,0 +1,405 @@
|
|
|
1
|
+
# `/core-style` - 生成项目设计风格指南
|
|
2
|
+
|
|
3
|
+
[English](./core-style.md) | [中文文档](./core-style.zh-CN.md)
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## 📋 概述
|
|
8
|
+
|
|
9
|
+
通过参考设计或现有代码分析,生成项目级设计风格指南(STYLE.md),确保整个项目的视觉一致性。
|
|
10
|
+
|
|
11
|
+
## 🎯 语法
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
/core-style # 生成新的设计风格指南
|
|
15
|
+
/core-style --update # 更新现有设计风格指南
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
## 🎬 使用场景
|
|
19
|
+
|
|
20
|
+
### ✅ 推荐场景
|
|
21
|
+
- 项目初始化时建立设计标准
|
|
22
|
+
- 需要统一项目视觉风格
|
|
23
|
+
- 从参考设计中提取设计系统
|
|
24
|
+
- 从现有代码中整理设计规范
|
|
25
|
+
- 设计风格变更时更新指南
|
|
26
|
+
|
|
27
|
+
### ❌ 不推荐场景
|
|
28
|
+
- 单个需求的 UI 设计 → 使用 `/flow-ui`
|
|
29
|
+
- 临时的样式调整 → 直接修改组件代码
|
|
30
|
+
|
|
31
|
+
## 🧭 定位
|
|
32
|
+
|
|
33
|
+
**项目级别命令**(类似 `/core-roadmap`)
|
|
34
|
+
|
|
35
|
+
- `/core-roadmap` 定义产品路线图(功能规划)
|
|
36
|
+
- `/core-style` 定义设计风格指南(视觉规范)
|
|
37
|
+
- 两者都是项目的 **SSOT(单一真理源)**
|
|
38
|
+
|
|
39
|
+
## 💡 核心理念
|
|
40
|
+
|
|
41
|
+
> "设计系统是视觉语言的语法,代码是语法的实现。无语法,则无一致性。"
|
|
42
|
+
|
|
43
|
+
**STYLE.md 的作用**:
|
|
44
|
+
- ✅ 项目设计的唯一真理源(SSOT)
|
|
45
|
+
- ✅ `/flow-ui` 生成 UI 原型时的首要参考
|
|
46
|
+
- ✅ `/flow-dev` 前端开发时的强制规范
|
|
47
|
+
- ✅ 确保所有需求的 UI 视觉一致
|
|
48
|
+
|
|
49
|
+
## 🔄 执行流程(三阶段)
|
|
50
|
+
|
|
51
|
+
```text
|
|
52
|
+
阶段 1: Entry Gate & 项目类型检测
|
|
53
|
+
├─ 检测现有风格指南(STYLE.md 是否存在)
|
|
54
|
+
├─ 检测项目类型(新项目 vs 现有项目)
|
|
55
|
+
└─ 路由选择(新项目 → 参考设计采集 / 现有项目 → 代码分析)
|
|
56
|
+
|
|
57
|
+
阶段 2: 参考设计采集与复刻(仅新项目)
|
|
58
|
+
├─ 引导用户提供参考设计(URL / 截图 / HTML+CSS)
|
|
59
|
+
├─ 生成单 HTML 文件复刻(reference-001.html)
|
|
60
|
+
├─ 用户微调循环(reference-002.html, reference-003.html...)
|
|
61
|
+
└─ 确认最终版本(reference-final.html)
|
|
62
|
+
|
|
63
|
+
阶段 3: 风格分析与 STYLE.md 生成
|
|
64
|
+
├─ 分析输入源(reference-final.html 或项目代码)
|
|
65
|
+
├─ 生成风格分析文档(research/style_analysis.md)
|
|
66
|
+
├─ 调用 style-guide-generator Agent
|
|
67
|
+
└─ 输出 STYLE.md
|
|
68
|
+
|
|
69
|
+
Exit Gate: 文件检查 + 宪法校验 + 状态更新
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
## 📂 输出文件
|
|
73
|
+
|
|
74
|
+
```
|
|
75
|
+
devflow/
|
|
76
|
+
├── STYLE.md # 项目设计风格指南(SSOT)
|
|
77
|
+
├── research/
|
|
78
|
+
│ ├── style_analysis.md # 风格分析文档
|
|
79
|
+
│ └── style_reference_designs/ # 参考设计(新项目)
|
|
80
|
+
│ ├── reference-001.html # 第 1 版复刻
|
|
81
|
+
│ ├── reference-002.html # 第 2 版(微调)
|
|
82
|
+
│ └── reference-final.html # 最终确认版本
|
|
83
|
+
├── project_status.json # 项目状态(更新)
|
|
84
|
+
└── EXECUTION_LOG.md # 执行日志(更新)
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
## 📋 STYLE.md 包含内容
|
|
88
|
+
|
|
89
|
+
STYLE.md 是一份详尽的设计风格指南,包含以下 15 个核心部分:
|
|
90
|
+
|
|
91
|
+
1. **Overview** - 设计系统概述(名称、版本、理念、更新历史)
|
|
92
|
+
2. **Color Palette** - 色板系统(主色、辅色、语义色、中性色,包含 Hex/RGB/HSL)
|
|
93
|
+
3. **Typography** - 字体系统(字体族、字阶、响应式字体、组合规律)
|
|
94
|
+
4. **Spacing System** - 间距系统(基础单位、间距等级、使用场景)
|
|
95
|
+
5. **Component Styles** - 组件样式库(Button, Input, Card, Modal 等,包含变体、尺寸、状态)
|
|
96
|
+
6. **Shadows & Elevation** - 阴影与层级系统(阴影等级、使用场景)
|
|
97
|
+
7. **Animations & Transitions** - 动画与过渡(时长、缓动函数、常用动画)
|
|
98
|
+
8. **Border Radius** - 圆角系统(圆角等级、使用场景)
|
|
99
|
+
9. **Opacity & Transparency** - 透明度系统(透明度等级、使用场景)
|
|
100
|
+
10. **Common Tailwind CSS Usage** - Tailwind 使用规范(如适用)
|
|
101
|
+
11. **Example Component Reference Design Code** - 示例组件代码(至少 3 个完整实现)
|
|
102
|
+
12. **Design Principles** - 设计原则(简洁性、一致性、可访问性等)
|
|
103
|
+
13. **Responsive Design** - 响应式设计(断点、策略、示例)
|
|
104
|
+
14. **Accessibility** - 可访问性(色彩对比度、键盘导航、ARIA 属性)
|
|
105
|
+
15. **Assets** - 资源规范(Icon、Image、Logo 等,如适用)
|
|
106
|
+
|
|
107
|
+
**所有定义都包含**:
|
|
108
|
+
- 具体值(不是 "待定义" 或占位符)
|
|
109
|
+
- 语义化命名(如 `--color-primary`, `--spacing-md`)
|
|
110
|
+
- 使用场景说明
|
|
111
|
+
- 示例代码(CSS Variables / Tailwind Config)
|
|
112
|
+
|
|
113
|
+
**示例代码特点**:
|
|
114
|
+
- ✅ 可直接复用(Copy-paste ready)
|
|
115
|
+
- ✅ 包含完整的 HTML 结构和 CSS/Tailwind classes
|
|
116
|
+
- ✅ 注释清晰,说明设计决策
|
|
117
|
+
- ❌ 不是伪代码或占位符
|
|
118
|
+
|
|
119
|
+
## 🆕 新项目流程示例
|
|
120
|
+
|
|
121
|
+
### 场景:你有一个喜欢的设计,想要作为项目的设计基础
|
|
122
|
+
|
|
123
|
+
```bash
|
|
124
|
+
# Step 1: 运行命令
|
|
125
|
+
/core-style
|
|
126
|
+
|
|
127
|
+
# Step 2: Agent 引导
|
|
128
|
+
Agent: 检测到这是一个新项目(无前端代码)。
|
|
129
|
+
|
|
130
|
+
请提供你想要参考的设计,可以包括:
|
|
131
|
+
- 网站 URL(我会抓取并分析)
|
|
132
|
+
- 设计截图(PNG/JPG)
|
|
133
|
+
- 提取的 HTML + CSS 代码
|
|
134
|
+
|
|
135
|
+
我将帮你复刻这个设计到单 HTML 文件中。
|
|
136
|
+
|
|
137
|
+
# Step 3: 用户提供参考
|
|
138
|
+
User: 我想参考 https://example.com/design,这里是截图和提取的 CSS...
|
|
139
|
+
|
|
140
|
+
# Step 4: Agent 生成复刻
|
|
141
|
+
Agent: 已生成 devflow/research/style_reference_designs/reference-001.html
|
|
142
|
+
|
|
143
|
+
请打开文件查看效果。你满意吗?如果不满意,请告诉我需要调整的地方:
|
|
144
|
+
- 颜色(如:主色调太鲜艳,改为更柔和的蓝色)
|
|
145
|
+
- 字体(如:标题字体太粗,改为 medium weight)
|
|
146
|
+
- 间距(如:卡片间距太小,增加到 24px)
|
|
147
|
+
- 组件样式(如:按钮圆角太大,改为 4px)
|
|
148
|
+
|
|
149
|
+
# Step 5: 用户微调
|
|
150
|
+
User: 主色调改为 #3B82F6,按钮圆角改为 6px。
|
|
151
|
+
|
|
152
|
+
# Step 6: Agent 调整并再次确认
|
|
153
|
+
Agent: 已调整,生成 reference-002.html。请查看。满意吗?
|
|
154
|
+
|
|
155
|
+
User: 满意!
|
|
156
|
+
|
|
157
|
+
# Step 7: Agent 生成 STYLE.md
|
|
158
|
+
Agent: 正在分析 reference-final.html,生成 STYLE.md...
|
|
159
|
+
|
|
160
|
+
✅ STYLE.md 已生成!
|
|
161
|
+
|
|
162
|
+
生成内容统计:
|
|
163
|
+
- 颜色定义: 15 个
|
|
164
|
+
- 字体定义: 8 个
|
|
165
|
+
- 间距等级: 10 个
|
|
166
|
+
- 组件样式: 12 个
|
|
167
|
+
- 示例代码: 3 个
|
|
168
|
+
|
|
169
|
+
下一步建议:
|
|
170
|
+
1. 审阅 devflow/STYLE.md 确保完整性
|
|
171
|
+
2. 运行 /flow-prd 开始需求开发
|
|
172
|
+
```
|
|
173
|
+
|
|
174
|
+
## 🏢 现有项目流程示例
|
|
175
|
+
|
|
176
|
+
### 场景:你有一个已有前端代码的项目,想要整理设计规范
|
|
177
|
+
|
|
178
|
+
```bash
|
|
179
|
+
# Step 1: 运行命令
|
|
180
|
+
/core-style
|
|
181
|
+
|
|
182
|
+
# Step 2: Agent 自动分析
|
|
183
|
+
Agent: 检测到这是一个现有项目(发现 src/components/, styles/ 等)。
|
|
184
|
+
|
|
185
|
+
正在分析项目代码,提取设计风格...
|
|
186
|
+
- 分析文件: src/components/**/*.tsx, styles/**/*.css
|
|
187
|
+
- 提取颜色: 主色 #3B82F6, 辅色 #8B5CF6, ...
|
|
188
|
+
- 提取字体: Inter, Roboto Mono
|
|
189
|
+
- 提取间距: 4px, 8px, 16px, 24px, 32px...
|
|
190
|
+
|
|
191
|
+
已生成 devflow/research/style_analysis.md,正在生成 STYLE.md...
|
|
192
|
+
|
|
193
|
+
✅ STYLE.md 已生成!
|
|
194
|
+
|
|
195
|
+
生成内容统计:
|
|
196
|
+
- 颜色定义: 18 个
|
|
197
|
+
- 字体定义: 6 个
|
|
198
|
+
- 间距等级: 8 个
|
|
199
|
+
- 组件样式: 15 个
|
|
200
|
+
- 示例代码: 3 个
|
|
201
|
+
|
|
202
|
+
技术栈:
|
|
203
|
+
- 框架: React
|
|
204
|
+
- CSS: Tailwind CSS
|
|
205
|
+
|
|
206
|
+
下一步建议:
|
|
207
|
+
1. 审阅 devflow/STYLE.md 确保完整性
|
|
208
|
+
2. 根据 STYLE.md 调整不一致的组件(如有)
|
|
209
|
+
```
|
|
210
|
+
|
|
211
|
+
## 🔄 更新模式示例
|
|
212
|
+
|
|
213
|
+
### 场景:设计风格有变化,需要更新 STYLE.md
|
|
214
|
+
|
|
215
|
+
```bash
|
|
216
|
+
# Step 1: 运行命令
|
|
217
|
+
/core-style --update
|
|
218
|
+
|
|
219
|
+
# Step 2: Agent 分析并更新
|
|
220
|
+
Agent: 检测到现有 STYLE.md(v1.0.0),进入更新模式。
|
|
221
|
+
|
|
222
|
+
正在分析最新代码,检测新增设计模式...
|
|
223
|
+
- 发现新颜色: Warning #F59E0B
|
|
224
|
+
- 发现新组件: Tooltip, Pagination
|
|
225
|
+
- 发现新间距: 96px
|
|
226
|
+
|
|
227
|
+
已合并到 STYLE.md(v1.1.0)。
|
|
228
|
+
|
|
229
|
+
更新内容:
|
|
230
|
+
- 新增颜色: 1 个
|
|
231
|
+
- 新增组件: 2 个
|
|
232
|
+
- 新增间距: 1 个
|
|
233
|
+
|
|
234
|
+
✅ STYLE.md 更新完成!
|
|
235
|
+
|
|
236
|
+
下一步建议:
|
|
237
|
+
1. 审阅变更内容
|
|
238
|
+
2. 更新现有 UI 原型(如有)
|
|
239
|
+
```
|
|
240
|
+
|
|
241
|
+
## 🔗 与其他工作流的集成
|
|
242
|
+
|
|
243
|
+
### `/flow-ui` 集成
|
|
244
|
+
|
|
245
|
+
**变更前**(无 STYLE.md):
|
|
246
|
+
- `/flow-ui` 使用默认采样策略(80+ 设计大师)
|
|
247
|
+
- 每个需求的 UI 可能风格不一致
|
|
248
|
+
|
|
249
|
+
**变更后**(有 STYLE.md):
|
|
250
|
+
- `/flow-ui` 优先加载 `devflow/STYLE.md`
|
|
251
|
+
- 所有颜色、字体、间距、组件严格遵循 STYLE.md
|
|
252
|
+
- 仅在 STYLE.md 未覆盖的部分,才使用默认采样策略
|
|
253
|
+
|
|
254
|
+
**示例**:
|
|
255
|
+
```bash
|
|
256
|
+
# 运行 /flow-ui
|
|
257
|
+
/flow-ui "REQ-001"
|
|
258
|
+
|
|
259
|
+
# Agent 自动引用 STYLE.md
|
|
260
|
+
Agent: 检测到 devflow/STYLE.md(v1.0.0),将严格遵循设计风格指南。
|
|
261
|
+
|
|
262
|
+
正在生成 UI 原型...
|
|
263
|
+
- 主色: #3B82F6(来自 STYLE.md)
|
|
264
|
+
- 字体: Inter(来自 STYLE.md)
|
|
265
|
+
- 按钮圆角: 6px(来自 STYLE.md)
|
|
266
|
+
|
|
267
|
+
✅ UI_PROTOTYPE.html 已生成,所有样式符合 STYLE.md。
|
|
268
|
+
```
|
|
269
|
+
|
|
270
|
+
### `/flow-dev` 集成
|
|
271
|
+
|
|
272
|
+
**变更后**(有 STYLE.md):
|
|
273
|
+
- `/flow-dev` 在生成前端代码时自动加载 `devflow/STYLE.md`
|
|
274
|
+
- 所有组件实现必须遵循 STYLE.md 的样式定义
|
|
275
|
+
- 特别注意:颜色使用、字体使用、间距使用、组件结构
|
|
276
|
+
|
|
277
|
+
**示例**:
|
|
278
|
+
```bash
|
|
279
|
+
# 运行 /flow-dev
|
|
280
|
+
/flow-dev "REQ-001"
|
|
281
|
+
|
|
282
|
+
# Agent 自动引用 STYLE.md
|
|
283
|
+
Agent: 检测到 devflow/STYLE.md(v1.0.0),所有前端代码将遵循设计风格指南。
|
|
284
|
+
|
|
285
|
+
正在实现 Task T003: 实现登录按钮...
|
|
286
|
+
- 使用 STYLE.md 的 Button Primary 样式
|
|
287
|
+
- 颜色: var(--color-primary)
|
|
288
|
+
- 圆角: var(--radius-md)
|
|
289
|
+
- 间距: var(--spacing-2) var(--spacing-4)
|
|
290
|
+
|
|
291
|
+
✅ 登录按钮实现完成,样式符合 STYLE.md。
|
|
292
|
+
```
|
|
293
|
+
|
|
294
|
+
## 💡 设计哲学
|
|
295
|
+
|
|
296
|
+
### 1. SSOT 原则(单一真理源)
|
|
297
|
+
- STYLE.md 是项目设计的唯一真理源
|
|
298
|
+
- 所有 UI 相关工作必须以 STYLE.md 为准
|
|
299
|
+
- 避免设计风格的碎片化和不一致
|
|
300
|
+
|
|
301
|
+
### 2. 一致性优先
|
|
302
|
+
- 统一的视觉语言提升产品专业度
|
|
303
|
+
- 一致的组件样式降低开发和维护成本
|
|
304
|
+
- 用户体验更流畅、可预测
|
|
305
|
+
|
|
306
|
+
### 3. 可复用性
|
|
307
|
+
- 所有定义都是具体、可执行的
|
|
308
|
+
- 示例代码可直接复用,不是伪代码
|
|
309
|
+
- 减少重复劳动,提高开发效率
|
|
310
|
+
|
|
311
|
+
### 4. 演进性
|
|
312
|
+
- 通过 `--update` 参数支持风格指南的迭代
|
|
313
|
+
- 版本控制(v1.0.0, v1.1.0...)
|
|
314
|
+
- 记录每次更新的原因和变更内容
|
|
315
|
+
|
|
316
|
+
### 5. 用户中心
|
|
317
|
+
- 新项目通过参考设计采集 + 微调循环
|
|
318
|
+
- 确保用户满意度
|
|
319
|
+
- 避免后期大规模重构
|
|
320
|
+
|
|
321
|
+
## 📊 工作流位置
|
|
322
|
+
|
|
323
|
+
```
|
|
324
|
+
/flow-init → research.md + tasks.json
|
|
325
|
+
↓
|
|
326
|
+
/core-roadmap → ROADMAP.md + BACKLOG.md (可选,项目级)
|
|
327
|
+
↓
|
|
328
|
+
/core-style → STYLE.md (可选,项目级设计风格指南) ⭐ 新增
|
|
329
|
+
↓
|
|
330
|
+
/flow-prd → PRD.md
|
|
331
|
+
↓
|
|
332
|
+
/flow-tech → TECH_DESIGN.md + data-model + contracts
|
|
333
|
+
↓
|
|
334
|
+
/flow-ui → UI_PROTOTYPE.html (必须参考 STYLE.md) ⭐ 变更
|
|
335
|
+
↓
|
|
336
|
+
/flow-epic → EPIC.md + TASKS.md
|
|
337
|
+
↓
|
|
338
|
+
/flow-dev → TASKS.md execution (前端代码必须参考 STYLE.md) ⭐ 变更
|
|
339
|
+
↓
|
|
340
|
+
/flow-qa → QA reports
|
|
341
|
+
↓
|
|
342
|
+
/flow-release → PR creation
|
|
343
|
+
```
|
|
344
|
+
|
|
345
|
+
## ⚠️ 错误处理
|
|
346
|
+
|
|
347
|
+
| 错误场景 | 处理方式 |
|
|
348
|
+
|----------|----------|
|
|
349
|
+
| **STYLE.md 已存在且无 --update 参数** | 询问是否覆盖,用户拒绝则退出 |
|
|
350
|
+
| **项目无前端特征且用户未提供参考设计** | 提示用户提供参考设计或确认是纯后端项目 |
|
|
351
|
+
| **参考设计复刻失败** | 要求用户提供更详细的设计信息(HTML/CSS/截图) |
|
|
352
|
+
| **Agent 生成失败** | 保留 style_analysis.md,提示用户检查后重试 |
|
|
353
|
+
| **宪法校验失败** | 根据 severity 决定是否阻塞(warning 级别仅提示) |
|
|
354
|
+
|
|
355
|
+
## 🎯 下一步
|
|
356
|
+
|
|
357
|
+
1. **审阅 STYLE.md** - 确保设计风格指南完整且符合项目需求
|
|
358
|
+
2. **更新现有组件**(现有项目)- 根据 STYLE.md 调整不一致的组件
|
|
359
|
+
3. **运行 /flow-prd** - 开始需求开发(如适用)
|
|
360
|
+
4. **运行 /core-roadmap** - 生成产品路线图(如适用)
|
|
361
|
+
|
|
362
|
+
## 🔗 相关命令
|
|
363
|
+
|
|
364
|
+
- [`/core-roadmap`](./core-roadmap.zh-CN.md) - 生成产品路线图
|
|
365
|
+
- [`/flow-ui`](./flow-ui.zh-CN.md) - 生成 UI 原型(将引用 STYLE.md)
|
|
366
|
+
- [`/flow-dev`](./flow-dev.zh-CN.md) - 执行开发任务(将引用 STYLE.md)
|
|
367
|
+
- [`/flow-verify`](./flow-verify.zh-CN.md) - 一致性检查(可检查代码是否符合 STYLE.md)
|
|
368
|
+
|
|
369
|
+
## 📚 深入阅读
|
|
370
|
+
|
|
371
|
+
- [设计系统指南](../guides/design-system-guide.md)(待创建)
|
|
372
|
+
- [视觉一致性管理](../guides/visual-consistency.md)(待创建)
|
|
373
|
+
- [STYLE_TEMPLATE](../../.claude/docs/templates/STYLE_TEMPLATE.md)
|
|
374
|
+
|
|
375
|
+
## ❓ 常见问题
|
|
376
|
+
|
|
377
|
+
### Q: 什么时候应该运行 `/core-style`?
|
|
378
|
+
A:
|
|
379
|
+
- ✅ 项目初始化时(建立设计标准)
|
|
380
|
+
- ✅ 有参考设计想要复刻时
|
|
381
|
+
- ✅ 现有项目需要整理设计规范时
|
|
382
|
+
- ✅ 设计风格发生变化时(使用 `--update`)
|
|
383
|
+
|
|
384
|
+
### Q: `/core-style` 和 `/flow-ui` 的区别?
|
|
385
|
+
A:
|
|
386
|
+
- **core-style**: 生成**项目级**设计风格指南(STYLE.md),一次性或按需更新
|
|
387
|
+
- **flow-ui**: 为**特定需求**生成 UI 原型(UI_PROTOTYPE.html),每个需求都要运行
|
|
388
|
+
|
|
389
|
+
### Q: 如果我的项目是纯后端,需要运行 `/core-style` 吗?
|
|
390
|
+
A: 不需要。`/core-style` 是为前端项目或全栈项目设计的。纯后端项目无需设计风格指南。
|
|
391
|
+
|
|
392
|
+
### Q: STYLE.md 生成后可以手动修改吗?
|
|
393
|
+
A: 可以。STYLE.md 是 Markdown 文件,你可以手动编辑。但建议使用 `/core-style --update` 命令更新,确保版本控制和一致性。
|
|
394
|
+
|
|
395
|
+
### Q: 如果参考设计复刻不满意怎么办?
|
|
396
|
+
A: Agent 会提供微调循环,你可以多次调整直到满意。每次调整都会生成新版本(reference-002.html, reference-003.html...),你可以随时回退。
|
|
397
|
+
|
|
398
|
+
### Q: STYLE.md 会自动应用到代码吗?
|
|
399
|
+
A: 不会自动修改代码。但 `/flow-ui` 和 `/flow-dev` 会自动引用 STYLE.md,确保新生成的代码符合风格指南。现有代码需要手动调整(或使用 `/flow-verify` 检查不一致)。
|
|
400
|
+
|
|
401
|
+
### Q: 如果我的项目使用 Tailwind CSS,STYLE.md 会包含 Tailwind 配置吗?
|
|
402
|
+
A: 会。Agent 会自动检测技术栈,如果使用 Tailwind CSS,STYLE.md 会包含 Tailwind Config 示例代码。
|
|
403
|
+
|
|
404
|
+
### Q: STYLE.md 包含哪些内容?
|
|
405
|
+
A: 包含 15 个核心部分:Overview, Color Palette, Typography, Spacing System, Component Styles, Shadows, Animations, Border Radius, Opacity, Tailwind Usage, Example Code, Design Principles, Responsive Design, Accessibility, Assets。详见 [STYLE_TEMPLATE](../../.claude/docs/templates/STYLE_TEMPLATE.md)。
|
|
@@ -0,0 +1,134 @@
|
|
|
1
|
+
# `/flow-init` - Initialize Requirement Structure
|
|
2
|
+
|
|
3
|
+
[中文文档](./flow-init.zh-CN.md) | [English](./flow-init.md)
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## 📋 Overview
|
|
8
|
+
|
|
9
|
+
Initialize requirement directory structure and load roadmap and architecture context (if exists). This is the first stage of `/flow-new` and can also be used independently.
|
|
10
|
+
|
|
11
|
+
## 🎯 Syntax
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
/flow-init "REQ-ID|Feature Title"
|
|
15
|
+
# or
|
|
16
|
+
/flow-init --interactive
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
## 📖 Parameters
|
|
20
|
+
|
|
21
|
+
| Parameter | Description | Required | Example |
|
|
22
|
+
|-----------|-------------|----------|---------|
|
|
23
|
+
| **REQ-ID** | Requirement number | ✅ | `REQ-123` |
|
|
24
|
+
| **Feature Title** | Brief description | ✅ | `User Authentication Feature` |
|
|
25
|
+
| **--interactive** | Interactive ID selection | ❌ | Auto-select next available ID |
|
|
26
|
+
|
|
27
|
+
## 🎬 Use Cases
|
|
28
|
+
|
|
29
|
+
### ✅ Recommended Scenarios
|
|
30
|
+
- Initialize requirement structure alone
|
|
31
|
+
- Have roadmap, need to locate requirement
|
|
32
|
+
- Need to manually create document content
|
|
33
|
+
|
|
34
|
+
### ❌ Not Recommended Scenarios
|
|
35
|
+
- Complete development flow → Use `/flow-new`
|
|
36
|
+
- Resume development → Use `/flow-restart`
|
|
37
|
+
|
|
38
|
+
## 🔄 Execution Flow (includes Stage 1.5)
|
|
39
|
+
|
|
40
|
+
```text
|
|
41
|
+
/flow-init "REQ-123|User Authentication Feature"
|
|
42
|
+
↓
|
|
43
|
+
Stage 1: Prerequisites validation
|
|
44
|
+
├─ Check Git repository
|
|
45
|
+
├─ Check devflow/ directory
|
|
46
|
+
└─ Verify REQ-ID uniqueness
|
|
47
|
+
↓
|
|
48
|
+
Stage 1.5: Roadmap & Architecture context loading (NEW)
|
|
49
|
+
├─ Check ROADMAP.md existence
|
|
50
|
+
├─ Locate requirement in roadmap
|
|
51
|
+
│ ├─ RM-ID (Roadmap Item ID)
|
|
52
|
+
│ ├─ Milestone (M{n}-Q{q}-{yyyy})
|
|
53
|
+
│ └─ Cluster (Feature cluster)
|
|
54
|
+
├─ Load ARCHITECTURE.md
|
|
55
|
+
└─ Display architecture context
|
|
56
|
+
├─ Feature Architecture (feature layers)
|
|
57
|
+
├─ Technical Architecture (tech stack)
|
|
58
|
+
└─ Module Structure (target modules)
|
|
59
|
+
↓
|
|
60
|
+
Stage 2: Directory structure creation
|
|
61
|
+
├─ Create devflow/requirements/REQ-XXX/
|
|
62
|
+
├─ Initialize orchestration_status.json
|
|
63
|
+
└─ Create EXECUTION_LOG.md
|
|
64
|
+
↓
|
|
65
|
+
Stage 2.6: Research task dispatch & decision integration
|
|
66
|
+
├─ Generate research tasks
|
|
67
|
+
├─ Populate research decisions
|
|
68
|
+
└─ Consolidate research findings
|
|
69
|
+
↓
|
|
70
|
+
Stage 3: Git branch creation
|
|
71
|
+
└─ Create feature/REQ-XXX-title branch
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
## 💡 Examples
|
|
75
|
+
|
|
76
|
+
### Example 1: Basic Usage
|
|
77
|
+
|
|
78
|
+
```bash
|
|
79
|
+
/flow-init "REQ-123|User Authentication Feature"
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
### Example 2: Interactive Mode
|
|
83
|
+
|
|
84
|
+
```bash
|
|
85
|
+
/flow-init --interactive
|
|
86
|
+
# System will auto-select next available ID
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
### Example 3: Output with Roadmap Context
|
|
90
|
+
|
|
91
|
+
```
|
|
92
|
+
===================================================================
|
|
93
|
+
📍 Requirement Location in Roadmap
|
|
94
|
+
===================================================================
|
|
95
|
+
|
|
96
|
+
📋 Requirement: REQ-123
|
|
97
|
+
🎯 Roadmap Item: RM-05
|
|
98
|
+
📝 Feature: User Management
|
|
99
|
+
📌 Derived From: Product Backlog
|
|
100
|
+
|
|
101
|
+
📅 Timeline:
|
|
102
|
+
Quarter: Q2 2025
|
|
103
|
+
Milestone: M2-Q2-2025
|
|
104
|
+
Cluster: Core Features
|
|
105
|
+
===================================================================
|
|
106
|
+
|
|
107
|
+
🏗️ Architecture Context
|
|
108
|
+
===================================================================
|
|
109
|
+
|
|
110
|
+
🎯 Feature Architecture:
|
|
111
|
+
Layer: Core (Core Feature Layer)
|
|
112
|
+
Related Features: Authentication, Authorization
|
|
113
|
+
|
|
114
|
+
🔧 Technical Architecture:
|
|
115
|
+
Tech Stack Layer: Business Logic + Data Access
|
|
116
|
+
Key Technologies: Node.js, PostgreSQL, Redis
|
|
117
|
+
|
|
118
|
+
📦 Module Structure:
|
|
119
|
+
Target Modules: src/auth/, src/user/
|
|
120
|
+
===================================================================
|
|
121
|
+
```
|
|
122
|
+
|
|
123
|
+
## 📂 Output
|
|
124
|
+
|
|
125
|
+
- `devflow/requirements/REQ-XXX/` complete directory
|
|
126
|
+
- `orchestration_status.json`
|
|
127
|
+
- `EXECUTION_LOG.md`
|
|
128
|
+
- Roadmap and architecture context (if exists)
|
|
129
|
+
|
|
130
|
+
## 🔗 Related Commands
|
|
131
|
+
|
|
132
|
+
- [`/core-roadmap`](./core-roadmap.md) - Generate roadmap first
|
|
133
|
+
- [`/core-architecture`](./core-architecture.md) - Generate architecture first
|
|
134
|
+
- [`/flow-new`](./flow-new.md) - Complete development flow
|
|
@@ -0,0 +1,163 @@
|
|
|
1
|
+
# `/flow-init` - 初始化需求结构
|
|
2
|
+
|
|
3
|
+
## 📋 概述
|
|
4
|
+
|
|
5
|
+
初始化需求目录结构,加载路线图和架构上下文(如果存在)。这是 `/flow-new` 的第一个阶段,也可以单独使用。
|
|
6
|
+
|
|
7
|
+
## 🎯 语法
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
/flow-init "REQ-ID|功能标题"
|
|
11
|
+
# 或
|
|
12
|
+
/flow-init --interactive
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## 📖 参数详解
|
|
16
|
+
|
|
17
|
+
| 参数 | 说明 | 必填 | 示例 |
|
|
18
|
+
|------|------|------|------|
|
|
19
|
+
| **REQ-ID** | 需求编号 | ✅ | `REQ-123` |
|
|
20
|
+
| **功能标题** | 简短描述 | ✅ | `用户认证功能` |
|
|
21
|
+
| **--interactive** | 交互式选择 ID | ❌ | 自动选择下一个可用 ID |
|
|
22
|
+
|
|
23
|
+
## 🎬 使用场景
|
|
24
|
+
|
|
25
|
+
### ✅ 推荐场景
|
|
26
|
+
- 单独初始化需求结构
|
|
27
|
+
- 已有路线图,需要定位需求
|
|
28
|
+
- 需要手动创建文档内容
|
|
29
|
+
|
|
30
|
+
### ❌ 不推荐场景
|
|
31
|
+
- 完整开发流程 → 使用 `/flow-new`
|
|
32
|
+
- 恢复开发 → 使用 `/flow-restart`
|
|
33
|
+
|
|
34
|
+
## 🔄 执行流程
|
|
35
|
+
|
|
36
|
+
```text
|
|
37
|
+
/flow-init "REQ-123|用户认证功能"
|
|
38
|
+
↓
|
|
39
|
+
Stage 1: 前置条件验证
|
|
40
|
+
├─ 检查 Git 仓库
|
|
41
|
+
├─ 检查 devflow/ 目录
|
|
42
|
+
└─ 验证 REQ-ID 唯一性
|
|
43
|
+
↓
|
|
44
|
+
Stage 1.5: 路线图与架构上下文加载(NEW)
|
|
45
|
+
├─ 检查 ROADMAP.md 存在性
|
|
46
|
+
├─ 定位需求在路线图中的位置
|
|
47
|
+
│ ├─ RM-ID (Roadmap Item ID)
|
|
48
|
+
│ ├─ Milestone (M{n}-Q{q}-{yyyy})
|
|
49
|
+
│ └─ Cluster (功能群组)
|
|
50
|
+
├─ 加载 ARCHITECTURE.md
|
|
51
|
+
└─ 显示架构上下文
|
|
52
|
+
├─ Feature Architecture (功能分层)
|
|
53
|
+
├─ Technical Architecture (技术栈)
|
|
54
|
+
└─ Module Structure (目标模块)
|
|
55
|
+
↓
|
|
56
|
+
Stage 2: 目录结构创建
|
|
57
|
+
├─ 创建 devflow/requirements/REQ-123/
|
|
58
|
+
├─ 创建子目录 tasks/, research/
|
|
59
|
+
├─ 初始化 orchestration_status.json
|
|
60
|
+
└─ 初始化 EXECUTION_LOG.md
|
|
61
|
+
↓
|
|
62
|
+
Stage 2.6: 调研任务分派与决策整合(FIXED)
|
|
63
|
+
├─ 生成研究任务 (generate-research-tasks.sh)
|
|
64
|
+
├─ 填充研究决策 (populate-research-tasks.sh)
|
|
65
|
+
└─ 整合研究结论 (consolidate-research.sh)
|
|
66
|
+
↓
|
|
67
|
+
Stage 3: Git 分支创建
|
|
68
|
+
└─ 创建 feature/REQ-123-user-auth 分支
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
## 💡 示例
|
|
72
|
+
|
|
73
|
+
### 示例 1: 基础用法
|
|
74
|
+
|
|
75
|
+
```bash
|
|
76
|
+
/flow-init "REQ-123|用户认证功能"
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
**输出示例(带路线图上下文)**:
|
|
80
|
+
|
|
81
|
+
```text
|
|
82
|
+
===================================================================
|
|
83
|
+
📍 Requirement Location in Roadmap
|
|
84
|
+
===================================================================
|
|
85
|
+
|
|
86
|
+
📋 Requirement: REQ-123
|
|
87
|
+
🎯 Roadmap Item: RM-05
|
|
88
|
+
📝 Feature: User Management
|
|
89
|
+
📌 Derived From: Product Backlog
|
|
90
|
+
|
|
91
|
+
📅 Timeline:
|
|
92
|
+
Quarter: Q2 2025
|
|
93
|
+
Milestone: M2-Q2-2025
|
|
94
|
+
Cluster: Core Features
|
|
95
|
+
===================================================================
|
|
96
|
+
|
|
97
|
+
🏗️ Architecture Context
|
|
98
|
+
===================================================================
|
|
99
|
+
|
|
100
|
+
🎯 Feature Architecture:
|
|
101
|
+
Layer: Core (核心功能层)
|
|
102
|
+
Related Features: Authentication, Authorization
|
|
103
|
+
|
|
104
|
+
🔧 Technical Architecture:
|
|
105
|
+
Tech Stack Layer: Business Logic + Data Access
|
|
106
|
+
Key Technologies: Node.js, PostgreSQL, Redis
|
|
107
|
+
|
|
108
|
+
📦 Module Structure:
|
|
109
|
+
Target Modules: src/auth/, src/user/
|
|
110
|
+
===================================================================
|
|
111
|
+
```
|
|
112
|
+
|
|
113
|
+
### 示例 2: 交互式模式
|
|
114
|
+
|
|
115
|
+
```bash
|
|
116
|
+
/flow-init --interactive
|
|
117
|
+
```
|
|
118
|
+
|
|
119
|
+
**效果**:
|
|
120
|
+
- 自动扫描现有需求编号
|
|
121
|
+
- 提示下一个可用 ID(如 REQ-124)
|
|
122
|
+
- 引导输入功能标题
|
|
123
|
+
|
|
124
|
+
## 📂 输出文件结构
|
|
125
|
+
|
|
126
|
+
```
|
|
127
|
+
devflow/requirements/REQ-123/
|
|
128
|
+
├── orchestration_status.json # 状态管理
|
|
129
|
+
├── EXECUTION_LOG.md # 审计轨迹
|
|
130
|
+
├── tasks/ # 任务产物目录
|
|
131
|
+
├── research/ # 研究材料目录
|
|
132
|
+
└── (等待后续阶段生成其他文档)
|
|
133
|
+
```
|
|
134
|
+
|
|
135
|
+
## 🔗 相关命令
|
|
136
|
+
|
|
137
|
+
- [`/flow-new`](./flow-new.md) - 完整开发流程
|
|
138
|
+
- [`/core-roadmap`](./core-roadmap.md) - 先生成路线图
|
|
139
|
+
- [`/core-architecture`](./core-architecture.md) - 先生成架构
|
|
140
|
+
- [`/flow-status`](./flow-status.md) - 查看进度
|
|
141
|
+
|
|
142
|
+
## 🚨 常见问题
|
|
143
|
+
|
|
144
|
+
### Q: Stage 1.5 没有加载路线图上下文?
|
|
145
|
+
|
|
146
|
+
**A**: 检查以下条件:
|
|
147
|
+
1. `devflow/ROADMAP.md` 文件是否存在
|
|
148
|
+
2. ROADMAP.md 中是否有对应的 RM-ID 映射
|
|
149
|
+
3. 使用 `/core-roadmap` 先生成路线图
|
|
150
|
+
|
|
151
|
+
### Q: 如何手动定位需求到路线图?
|
|
152
|
+
|
|
153
|
+
**A**: 编辑 `devflow/ROADMAP.md`,在 Implementation Tracking 表格中添加映射:
|
|
154
|
+
|
|
155
|
+
```markdown
|
|
156
|
+
| RM-05 | User Management | ... | REQ-123 | ... |
|
|
157
|
+
```
|
|
158
|
+
|
|
159
|
+
## 📚 深度阅读
|
|
160
|
+
|
|
161
|
+
- [路线图系统](../guides/roadmap-guide.md)
|
|
162
|
+
- [架构上下文加载](../architecture/context-loading.md)
|
|
163
|
+
- [目录结构规范](../architecture/directory-structure.md)
|