Skip to content

Commit 6b9975b

Browse files
authored
Merge pull request #93 from gotalab/bugfix/after-v2.0.0
docs: Improve README clarity and visual consistency
2 parents 0d47934 + 8594eac commit 6b9975b

File tree

4 files changed

+42
-39
lines changed

4 files changed

+42
-39
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# cc-sdd: Customize spec-driven development for your team's workflow
1+
# cc-sdd: Spec-driven development for your team's workflow
22

33
<!-- npm badges -->
44
[![npm version](https://img.shields.io/npm/v/cc-sdd?logo=npm)](https://www.npmjs.com/package/cc-sdd?activeTab=readme)
@@ -13,7 +13,7 @@
1313

1414
**One command. Hours instead of weeks. Requirements → Design → Tasks → Implementation.**
1515

16-
🇰 **Kiro-inspired** — Similar Spec-Driven, AI-DLC style as Kiro IDE, so existing Kiro specs remain compatible and portable.
16+
👻 **Kiro-inspired** — Similar Spec-Driven, AI-DLC style as Kiro IDE, so existing Kiro specs remain compatible and portable.
1717

1818
Stop losing 70% of development time to meetings, documentation ceremonies, and scattered context. cc-sdd brings structured **AI-DLC** (AI-Driven Development Lifecycle) and **Spec-Driven Development** to Claude Code, Cursor, Gemini CLI, Codex CLI, GitHub Copilot, Qwen Code, and Windsurf.
1919

@@ -37,7 +37,7 @@ npx cc-sdd@latest --claude --lang en ## Claude Code
3737

3838
**Installation takes 30 seconds.** Supports 7 agents (Claude (Commands / Subagents), Cursor, Gemini, Codex, Copilot, Qwen, Windsurf) × 12 languages.
3939

40-
📖 **Next steps:** [All installation options](#-advanced-installation) | [Command Reference](docs/guides/command-reference.md) | [Spec-Driven Guide](docs/guides/spec-driven.md)
40+
📖 **Next steps:** [All installation options](#%EF%B8%8F-advanced-installation) | [Command Reference](docs/guides/command-reference.md) | [Spec-Driven Guide](docs/guides/spec-driven.md)
4141

4242
## 📋 See It In Action
4343

tools/cc-sdd/README.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# cc-sdd: Customize spec-driven development for your team's workflow
1+
# cc-sdd: Spec-driven development for your team's workflow
22

33
[![npm version](https://img.shields.io/npm/v/cc-sdd?logo=npm)](https://www.npmjs.com/package/cc-sdd?activeTab=readme)
44
[![install size](https://packagephobia.com/badge?p=cc-sdd)](https://packagephobia.com/result?p=cc-sdd)
@@ -8,19 +8,20 @@
88
English | <a href="./README_ja.md">日本語</a> | <a href="./README_zh-TW.md">繁體中文</a>
99
</sub></div>
1010

11-
**Transform Claude Code / Cursor IDE / Gemini CLI / Codex CLI / GitHub Copilot / Qwen Code / Windsurf from prototype to production-ready development, while customizing every spec and steering template so requirements, design docs, tasks, and project memory match your team workflow.**
11+
**Transform Claude Code / Cursor IDE / Gemini CLI / Codex CLI / GitHub Copilot / Qwen Code / Windsurf from prototype to production-ready development.**
1212

13-
🇰 **Kiro-inspired** — Similar Spec-Driven, AI-DLC style as Kiro IDE, so existing Kiro specs remain compatible and portable.
13+
👻 **Kiro-inspired** — Similar Spec-Driven, AI-DLC style as Kiro IDE, so existing Kiro specs remain compatible and portable.
1414

15-
**Key highlights (v2.0.0):**
16-
- **Design.md = detailed Design Doc** with Summary tables, Req Coverage, Supporting References, lean Components/Interfaces so reviewers spend less time parsing.
17-
- **Research.md + validate-gap/design/impl** – discovery notes live in Research.md while Design.md stays concise; validation gates keep both greenfield and brownfield work safe (parallel-task markers included).
18-
- **Customize once** via `.kiro/settings/templates/` & `.kiro/settings/rules/` — every agent shares the same outputs.
19-
- **7 agents × 12 languages** run the same 11-command workflow; mix Claude, Cursor, Codex, Gemini, Copilot, Qwen, Windsurf freely.
15+
**What's New in v2.0.0:**
16+
-**Fast-to-Review Designs** — Structured format with summary tables makes reviews 5x faster
17+
-**Separate Research** — Keep discovery notes (Research.md) separate from final design (Design.md)
18+
-**Quality Gates** — validate-gap/design/impl commands catch integration issues before coding
19+
-**Customize Once** — Adapt templates to your team's process; all agents follow the same workflow
20+
-**Universal Workflow** — 7 agents × 12 languages share the same 11-command process
2021

2122
---
2223

23-
> Need the legacy flow? Use `npx cc-sdd@1.1.5 --claude-code`. Upgrading from v1.x?
24+
> Need the legacy flow? Use `npx cc-sdd@1.1.5`. Upgrading from v1.x?
2425
> See the Migration Guide: [English](../../docs/guides/migration-guide.md) | [日本語](../../docs/guides/ja/migration-guide.md).
2526
2627
## 🚀 Installation
@@ -38,7 +39,7 @@ npx cc-sdd@latest --lang es # Spanish
3839
... (en, ja, zh-TW, zh, es, pt, de, fr, ru, it, ko, ar supported)
3940

4041
# With agent options (default: claude-code / --claude)
41-
npx cc-sdd@latest --claude --lang en # Claude Code (11 commands, en/ja/zh-TW/...)
42+
npx cc-sdd@latest --claude # Claude Code (11 commands, en/ja/zh-TW/...)
4243
npx cc-sdd@latest --claude-agent --lang ja # Claude Code Subagents (12 commands + 9 subagents)
4344
npx cc-sdd@latest --cursor --lang zh-TW # Cursor IDE (choose any supported lang)
4445
npx cc-sdd@latest --gemini --lang es # Gemini CLI

tools/cc-sdd/README_ja.md

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,14 @@
1010

1111
**Claude Code / Cursor IDE / Gemini CLI / Codex CLI / GitHub Copilot / Qwen Code / Windsurf をプロトタイプから本番仕様駆動へ。要件・設計・タスク・プロジェクトメモリをチームのワークフローに沿うようカスタマイズできます。**
1212

13-
🇰 **Kiro互換** — Kiro IDE に似た Spec-Driven / AI-DLC スタイルで、既存の Kiro 仕様書もそのまま扱えます。
13+
👻 **Kiro互換** — Kiro IDE に似た Spec-Driven / AI-DLC スタイルで、既存の Kiro 仕様書もそのまま扱えます。
1414

15-
**v2.0.0 主な強化点**
16-
- **Design.md = 詳細設計書** — 要約表 / Req Coverage / Supporting References / 軽量化した Components & Interfaces でレビューの認知負荷を削減。
17-
- **Research.md + validate 系** — 調査メモは Research.md に切り出し、Design.md は要点のみ。validate-gap/design/impl と並列タスク分析で新規機能も既存拡張も安全。
18-
- **カスタマイズは `.kiro/settings/templates & rules` に集約** — 1回の編集で全エージェントの出力が揃う。
19-
- **7エージェント × 12言語** — Claude / Cursor / Codex / Gemini / Copilot / Qwen / Windsurf が同じ11コマンドを共有。
15+
**v2.0.0 の新機能:**
16+
-**レビューしやすい設計書** — 構造化フォーマットと要約表でレビュー時間を5倍高速化
17+
-**Research の分離** — 調査メモ(Research.md)と最終設計(Design.md)を分けて管理
18+
-**品質ゲート** — validate-gap/design/impl コマンドでコーディング前に統合問題を検出
19+
-**一度だけカスタマイズ** — テンプレートをチームプロセスに適応、全エージェントが同じワークフローに従う
20+
-**統一ワークフロー** — 7エージェント × 12言語で同じ11コマンドプロセスを共有
2021

2122

2223
> インストール手順だけ知りたい場合は [インストール](#-インストール) へジャンプ。v1.1.5 維持なら `npx cc-sdd@1.1.5 --claude-code ...`、v2 移行は [Migration Guide](../../docs/guides/migration-guide.md) / [日本語版](../../docs/guides/ja/migration-guide.md) を参照。
@@ -38,13 +39,13 @@ npx cc-sdd@latest --lang es # スペイン語
3839
...(対応言語: en, ja, zh-TW, zh, es, pt, de, fr, ru, it, ko, ar)
3940

4041
# エージェントオプション(デフォルト: claude-code / --claude)
41-
npx cc-sdd@latest --claude --lang en # Claude Code(11コマンド、対応言語は任意)
42+
npx cc-sdd@latest --claude --lang ja # Claude Code(11コマンド、対応言語は任意)
4243
npx cc-sdd@latest --claude-agent --lang ja # Claude Code Subagents(12コマンド + 9サブエージェント)
43-
npx cc-sdd@latest --cursor --lang zh-TW # Cursor IDE
44-
npx cc-sdd@latest --gemini --lang es # Gemini CLI
45-
npx cc-sdd@latest --codex --lang fr # Codex CLI
46-
npx cc-sdd@latest --copilot --lang pt # GitHub Copilot
47-
npx cc-sdd@latest --qwen --lang de # Qwen Code
44+
npx cc-sdd@latest --cursor --lang ja # Cursor IDE
45+
npx cc-sdd@latest --gemini --lang ja # Gemini CLI
46+
npx cc-sdd@latest --codex --lang ja # Codex CLI
47+
npx cc-sdd@latest --copilot --lang ja # GitHub Copilot
48+
npx cc-sdd@latest --qwen --lang ja # Qwen Code
4849
npx cc-sdd@latest --windsurf --lang ja # Windsurf IDE
4950

5051
# 注: @nextは今後のアルファ/ベータ版用に予約されています

tools/cc-sdd/README_zh-TW.md

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,14 @@
1010

1111
**將 Claude Code / Cursor IDE / Gemini CLI / Codex CLI / GitHub Copilot / Qwen Code / Windsurf 直接帶入 Spec-Driven / AI-DLC 的生產級流程,需求・設計・任務・指導文件一次對齊團隊審核。**
1212

13-
🇰 **Kiro 相容** — 與 Kiro IDE 相似的 Spec-Driven / AI-DLC 風格,可沿用既有 Kiro 規格並保持互通。
13+
👻 **Kiro 相容** — 與 Kiro IDE 相似的 Spec-Driven / AI-DLC 風格,可沿用既有 Kiro 規格並保持互通。
1414

15-
**v2.0.0 重點**
16-
- **Design.md = 詳細設計文件**:摘要表、Req Coverage、Supporting References、精簡的 Components/Interfaces,降低審查認知負荷。
17-
- **Research.md + validate 系**:調查筆記獨立在 Research.md,Design.md 保持精簡;`validate-gap/design/impl` 與平行任務分析讓 Greenfield / Brownfield 都安全。
18-
- **一次自訂即可套用**`.kiro/settings/templates & rules` 集中調整,所有代理共享同一輸出。
19-
- **7 代理 × 12 語言**:Claude / Cursor / Codex / Gemini / Copilot / Qwen / Windsurf 共用 11 指令,混用也不用重建模板。
15+
**v2.0.0 新功能:**
16+
-**易於審查的設計** — 結構化格式與摘要表讓審查速度提升 5 倍
17+
-**分離研究** — 將探索筆記(Research.md)與最終設計(Design.md)分開管理
18+
-**品質關卡** — validate-gap/design/impl 指令在編碼前捕捉整合問題
19+
-**一次自訂** — 將模板適應至團隊流程;所有代理遵循相同工作流程
20+
-**統一工作流程** — 7 代理 × 12 語言共享相同的 11 指令流程
2021

2122
> 只想看安裝?跳到 [安裝](#-安裝)。若要維持 1.1.5,使用 `npx cc-sdd@1.1.5 --claude-code ...`;升級 v2.0.0 請參考 [Migration Guide](../../docs/guides/migration-guide.md)[日文版](../../docs/guides/ja/migration-guide.md)
2223
@@ -35,14 +36,14 @@ npx cc-sdd@latest --lang es # 西班牙語
3536
...(支援語言:en, ja, zh-TW, zh, es, pt, de, fr, ru, it, ko, ar)
3637

3738
# 代理選項(預設:claude-code / --claude)
38-
npx cc-sdd@latest --claude --lang en # Claude Code(11 個指令,語言可任選)
39-
npx cc-sdd@latest --claude-agent --lang zh-TW # Claude Code Subagents(12 個指令 + 9 個子代理)
40-
npx cc-sdd@latest --cursor --lang ja # Cursor IDE
41-
npx cc-sdd@latest --gemini --lang es # Gemini CLI
42-
npx cc-sdd@latest --codex --lang fr # Codex CLI
43-
npx cc-sdd@latest --copilot --lang pt # GitHub Copilot
44-
npx cc-sdd@latest --qwen --lang de # Qwen Code
45-
npx cc-sdd@latest --windsurf --lang zh-TW # Windsurf IDE
39+
npx cc-sdd@latest --claude --lang zh-TW # Claude Code(11 個指令,語言可任選)
40+
npx cc-sdd@latest --claude-agent --lang zh-TW # Claude Code Subagents(12 個指令 + 9 個子代理)
41+
npx cc-sdd@latest --cursor --lang zh-TW # Cursor IDE
42+
npx cc-sdd@latest --gemini --lang zh-TW # Gemini CLI
43+
npx cc-sdd@latest --codex --lang zh-TW # Codex CLI
44+
npx cc-sdd@latest --copilot --lang zh-TW # GitHub Copilot
45+
npx cc-sdd@latest --qwen --lang zh-TW # Qwen Code
46+
npx cc-sdd@latest --windsurf --lang zh-TW # Windsurf IDE
4647

4748
# 注意:@next 現已保留給未來的 alpha/beta 版本
4849
```

0 commit comments

Comments
 (0)