Skip to content

Commit 0ffebd5

Browse files
author
mizuki
authored
Translate README to English and refine documentation layout (#9)
1 parent 7c96741 commit 0ffebd5

File tree

1 file changed

+101
-121
lines changed

1 file changed

+101
-121
lines changed

‎README.md‎

Lines changed: 101 additions & 121 deletions
Original file line numberDiff line numberDiff line change
@@ -1,196 +1,176 @@
1-
[![MseeP.ai Security Assessment Badge](https://mseep.net/pr/mzkmnk-spec-pilot-badge.png)](https://mseep.ai/app/mzkmnk-spec-pilot)
2-
31
# Spec Pilot
42

5-
**スペック駆動開発をサポートするMCP (Model Context Protocol) サーバー**
3+
**An MCP (Model Context Protocol) server that supports specification-driven development**
64

7-
Spec Pilotは、システム仕様の作成から設計まで、開発プロセス全体を構造化されたワークフローで支援するMCPサーバーです。EARS (Easy Approach to Requirements Syntax) 形式での要件定義と包括的な設計ドキュメント生成を自動化します。
5+
Spec Pilot is an MCP server that supports specification-driven development through a structured workflow that spans everything from drafting system specifications to delivering design assets. It automates requirement definition in the EARS (Easy Approach to Requirements Syntax) format and generates comprehensive design documents.
86

9-
## 概要
7+
## Overview
108

11-
- **構造化された開発プロセス**: 仕様 → 要件 → 設計の段階的なワークフロー
12-
- **EARS形式の要件管理**: テスト可能で明確な受け入れ基準
13-
- **包括的な設計生成**: アーキテクチャから実装戦略まで
14-
- **多言語サポート**: 日本語・英語での出力対応
15-
- **MCPプロトコル**: AI エージェントとの統合が容易
9+
- **Structured development workflow**: Step-by-step process from specifications → requirements → design
10+
- **EARS-based requirements management**: Clear, testable acceptance criteria
11+
- **Comprehensive design generation**: From architecture to implementation strategies
12+
- **Multilingual support**: Output available in Japanese and English
13+
- **MCP protocol**: Easy integration with AI agents
1614

17-
## 主な機能
15+
### Verified By
1816

19-
### 1. ワークスペース初期化 (`spec.init`)
17+
This project has been independently assessed by MseeP.ai.
2018

21-
- `.kiro/specs/<slug>` ディレクトリの作成
22-
- プロジェクト設定ファイルの生成
23-
- 言語設定の保存
24-
25-
### 2. 要件収集 (`spec.create-requirements`)
19+
[![MseeP.ai Security Assessment Badge](https://mseep.net/pr/mzkmnk-spec-pilot-badge.png)](https://mseep.ai/app/mzkmnk-spec-pilot)
2620

27-
- ユーザーストーリーの構造化
28-
- EARS形式の受け入れ基準生成
29-
- テスト可能な要件ドキュメント作成
21+
## Key Features
3022

31-
### 3. 設計ドキュメント生成 (`spec.design`)
23+
### 1. Workspace Initialization (`spec.init`)
3224

33-
- システムアーキテクチャの設計
34-
- コンポーネント設計とAPI仕様
35-
- 移行戦略とテスト戦略
36-
- パフォーマンスとセキュリティ考慮事項
25+
- Create the `.kiro/specs/<slug>` directory
26+
- Generate project configuration files
27+
- Save language settings
3728

38-
### 4. 挨拶機能 (`greeting`)
29+
### 2. Requirements Collection (`spec.create-requirements`)
3930

40-
- 基本的な挨拶とポリシー表示
31+
- Structure user stories
32+
- Generate acceptance criteria in the EARS format
33+
- Produce testable requirements documents
4134

42-
## 使用方法
35+
### 3. Design Document Generation (`spec.design`)
4336

44-
Spec Pilotは4つのMCPプロンプトを提供します。各プロンプトは特定の引数を受け取り、構造化されたプロンプトを生成します。
37+
- Design system architecture
38+
- Define component designs and API specifications
39+
- Plan migration and testing strategies
40+
- Address performance and security considerations
4541

46-
### 利用可能なプロンプト
42+
### 4. Greeting (`greeting`)
4743

48-
| プロンプト名 | 説明 | 必須引数 | オプション引数 |
49-
| -------------------------- | -------------------- | -------------------------- | ---------------- |
50-
| `greeting` | 挨拶とポリシー表示 | `name` (string) | - |
51-
| `spec.init` | ワークスペース初期化 | `specDescription` (string) | `locale` (ja/en) |
52-
| `spec.create-requirements` | 要件定義生成 | `specName` (string) | - |
53-
| `spec.design` | 設計ドキュメント生成 | `specName` (string) | - |
44+
- Provide a basic greeting and display project policies
5445

55-
### 使用例
46+
## Usage
5647

57-
#### Claude Desktopの場合
48+
Spec Pilot exposes four MCP prompts. Each one accepts defined arguments and returns structured responses.
5849

59-
**プロジェクト初期化:**
50+
### Available Prompts
6051

61-
```
62-
@spec.init specDescription="ユーザー認証システムの構築" locale="ja"
63-
```
52+
| Prompt Name | Description | Required Arguments | Optional Arguments |
53+
| -------------------------- | ------------------------ | -------------------------- | ------------------ |
54+
| `greeting` | Greeting and policy info | `name` (string) | - |
55+
| `spec.init` | Initialize workspace | `specDescription` (string) | `locale` (ja/en) |
56+
| `spec.create-requirements` | Generate requirements | `specName` (string) | - |
57+
| `spec.design` | Generate design document | `specName` (string) | - |
6458

65-
**要件定義生成:**
59+
### Examples
6660

67-
```
68-
@spec.create-requirements specName="user-auth-system"
69-
```
61+
#### Amazon Q CLI
7062

71-
**設計ドキュメント生成:**
63+
**Initialize a project:**
7264

7365
```
74-
@spec.design specName="user-auth-system"
66+
@spec.init "Build a user authentication system" "en"
7567
```
7668

77-
#### Amazon Q CLIの場合
78-
79-
**プロジェクト初期化:**
80-
81-
```
82-
@spec.init "ユーザー認証システムの構築" "ja"
83-
```
84-
85-
**要件定義生成:**
69+
**Generate requirements:**
8670

8771
```
8872
@spec.create-requirements "user-auth-system"
8973
```
9074

91-
**設計ドキュメント生成:**
75+
**Generate a design document:**
9276

9377
```
9478
@spec.design "user-auth-system"
9579
```
9680

97-
## ファイル詳細
81+
## File Details
9882

99-
### グローバル設定 (`.kiro/spec-pilot.json`)
83+
### Global Settings (`.kiro/spec-pilot.json`)
10084

10185
```json
10286
{
10387
"locale": "ja"
10488
}
10589
```
10690

107-
### プロジェクト設定 (`config.json`)
91+
### Project Settings (`config.json`)
10892

10993
```json
11094
{
11195
"title": "project-name",
112-
"description": "プロジェクトの説明"
96+
"description": "Project description"
11397
}
11498
```
11599

116-
### 生成されるドキュメント
100+
### Generated Documents
117101

118-
- **`requirements.md`**: EARS形式の受け入れ基準を含む構造化された要件ドキュメント
119-
- **`design.md`**: アーキテクチャ、コンポーネント設計、移行戦略等を含む包括的な設計ドキュメント
102+
- **`requirements.md`**: Structured requirements document with EARS-based acceptance criteria
103+
- **`design.md`**: Comprehensive design document covering architecture, component design, migration strategy, and more
120104

121-
## 設定
105+
## Configuration
122106

123-
### サポート言語
107+
### Supported Languages
124108

125-
- `ja` (日本語) - デフォルト
126-
- `en` (英語)
109+
- `ja` (Japanese) - default
110+
- `en` (English)
127111

128-
言語設定は`.kiro/spec-pilot.json`ファイルで管理され、初回実行時に自動作成されます。
112+
Language settings are managed in `.kiro/spec-pilot.json`, which is created automatically during the first run.
129113

130-
## 開発・ビルド
114+
## Development & Build
131115

132-
### 開発スクリプト
116+
### Development Scripts
133117

134118
```bash
135-
# 開発
136-
pnpm build # TypeScriptビルド
137-
pnpm test # テスト実行
138-
pnpm test:watch # テスト監視モード
139-
140-
# コード品質
141-
pnpm lint # ESLintチェック
142-
pnpm lint:fix # ESLint自動修正
143-
pnpm format # Prettierチェック
144-
pnpm format:write # Prettier自動フォーマット
145-
pnpm typecheck # 型チェック
146-
147-
# その他
148-
pnpm clean # ビルド成果物削除
119+
# Development
120+
pnpm build # TypeScript build
121+
pnpm test # Run tests
122+
pnpm test:watch # Watch mode for tests
123+
124+
# Code quality
125+
pnpm lint # Run ESLint checks
126+
pnpm lint:fix # Auto-fix ESLint issues
127+
pnpm format # Check formatting with Prettier
128+
pnpm format:write # Automatically format with Prettier
129+
pnpm typecheck # Run type checking
130+
131+
# Miscellaneous
132+
pnpm clean # Remove build artifacts
149133
```
150134

151-
### ビルド成果物
152-
153-
- `dist/index.js` - メインのMCPサーバー
154-
- `dist/index.d.ts` - TypeScript型定義
155-
- `prompts/` - プロンプトテンプレート
156-
157-
## ロードマップ
135+
### Build Artifacts
158136

159-
### 完了済み機能
137+
- `dist/index.js` - Main MCP server
138+
- `dist/index.d.ts` - TypeScript type definitions
139+
- `prompts/` - Prompt templates
160140

161-
- [x] ワークスペース初期化 (`spec.init`)
162-
- [x] 要件定義生成 (`spec.create-requirements`)
163-
- [x] 設計ドキュメント生成 (`spec.design`)
164-
- [x] 多言語サポート (日本語・英語)
165-
- [x] EARS形式の受け入れ基準生成
141+
## Roadmap
166142

167-
### 開発予定機能
143+
### Completed Features
168144

169-
- [ ] **タスク生成機能 (`spec.tasks`)** - 要件・設計からの実装タスク自動生成
170-
- [ ] 要件に基づく開発タスクの分解
171-
- [ ] 設計ドキュメントからの実装手順生成
172-
- [ ] GitHub Issues / プロジェクト管理ツール連携
173-
- [ ] 優先度付けとスケジューリング支援
145+
- [x] Workspace initialization (`spec.init`)
146+
- [x] Requirements generation (`spec.create-requirements`)
147+
- [x] Design document generation (`spec.design`)
148+
- [x] Multilingual support (Japanese & English)
149+
- [x] Generation of EARS-based acceptance criteria
174150

175-
- [ ] **npmパッケージ公開**
176-
- [ ] パッケージメタデータの最適化
177-
- [ ] バージョン管理自動化
178-
- [ ] CI/CDパイプラインによる自動公開
179-
- [ ] npmレジストリへの安定版リリース
151+
### Planned Features
180152

181-
## 技術仕様
153+
- [ ] **Task generation (`spec.tasks`)** - Automatically create implementation tasks from requirements and design
154+
- [ ] Break down development tasks based on requirements
155+
- [ ] Generate implementation steps from design documents
156+
- [ ] Integrate with GitHub Issues / project management tools
157+
- [ ] Support prioritization and scheduling
182158

183-
- **言語**: TypeScript 5.6+
184-
- **ランタイム**: Node.js 22+
185-
- **パッケージマネージャー**: pnpm
186-
- **ビルドツール**: tsdown
187-
- **テストフレームワーク**: Vitest
188-
- **プロトコル**: Model Context Protocol 1.18+
159+
- [ ] **Publish as an npm package**
160+
- [ ] Optimize package metadata
161+
- [ ] Automate version management
162+
- [ ] Set up CI/CD pipelines for automated publishing
163+
- [ ] Release stable versions to the npm registry
189164

190-
## ライセンス
165+
## Technical Specifications
191166

192-
MIT License - 詳細は [LICENSE](./LICENSE) を参照
167+
- **Language**: TypeScript 5.6+
168+
- **Runtime**: Node.js 22+
169+
- **Package Manager**: pnpm
170+
- **Build Tool**: tsdown
171+
- **Test Framework**: Vitest
172+
- **Protocol**: Model Context Protocol 1.18+
193173

194-
## 作者
174+
## License
195175

196-
mzkmnk
176+
MIT License — see [LICENSE](./LICENSE) for details.

0 commit comments

Comments
 (0)