Skip to content

Commit deee097

Browse files
shinprclaude
andcommitted
docs: update READMEs to include project-inject command workflow
- Add /project-inject to slash commands list - Update project configuration section to use interactive command - Update FAQ for customization method - Clarify initial setup workflow with project context injection - Apply same updates to both Japanese and English versions The project-inject command enables proper project context setup when starting with the boilerplate for production use. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>
1 parent 0c0f101 commit deee097

File tree

2 files changed

+36
-20
lines changed

2 files changed

+36
-20
lines changed

README.ja.md

Lines changed: 18 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -153,6 +153,7 @@ Claude Codeで使える便利なコマンド一覧
153153
| `/task` | ルールベース実行 | 単一タスク実行時 |
154154
| `/review` | Design Doc準拠検証 | 実装完了後の検証 |
155155
| `/rule-maintenance` | ルール管理 | ルール追加・更新時 |
156+
| `/project-inject` | プロジェクトコンテキスト注入 | ボイラープレート利用開始時 |
156157
| `/onboard` | ルール読み込み | プロジェクト開始時 |
157158

158159
詳細は `.claude/commands/` 内の各定義ファイルを参照してください。
@@ -170,22 +171,28 @@ npm install
170171

171172
### プロジェクト固有の設定
172173

174+
プロジェクトに合わせたコンテキスト設定を行います:
175+
176+
```bash
177+
# 1. Claude Codeでプロジェクトコンテキストを注入
178+
/project-inject
179+
180+
# このコマンドが対話的に以下を収集・設定します:
181+
# - プロジェクトが解決する問題
182+
# - ターゲットユーザーと利用シーン
183+
# - ビジネス制約と開発体制
184+
# → docs/rules/project-context.md を自動更新
185+
```
186+
173187
```json
174-
// package.json
188+
// 2. package.json の基本情報を更新(必要に応じて)
175189
{
176190
"name": "your-project-name",
177191
"description": "プロジェクトの説明",
178192
"author": "あなたの名前"
179193
}
180194
```
181195

182-
```bash
183-
# docs/rules-ja/project-context.md のプレースホルダーを置き換え
184-
# [プロジェクト名] → 実際のプロジェクト名
185-
# [プロダクト名をここに記載] → 実際のプロダクト名
186-
# [ターゲットユーザーの職種をここに記載] → 実際のターゲット
187-
```
188-
189196
## 💻 開発コマンド
190197

191198
### 基本コマンド
@@ -288,10 +295,11 @@ A: quality-fixerが修正を試みます。自動修正できない場合は、
288295
A: `npm run lang:ja`(日本語)または`npm run lang:en`(英語)で切り替え。
289296

290297
### Q: カスタマイズ方法は?
291-
A: `docs/rules/project-context.md`のプレースホルダーを置き換えるだけ
298+
A: `/project-inject`コマンドを実行して、対話的にプロジェクトコンテキストを設定
292299

293300
### Q: Claude Codeでの開発手順は?
294-
A: 1) ルールファイルを読み込み → 2) 計画立案・承認 → 3) 実装 → 4) 品質チェック → 5) コミット
301+
A: 【初回】1) `/project-inject`でコンテキスト設定 → 2) `/onboard`でルール読み込み
302+
【開発】3) `/implement`または`/task`で実装 → 4) 品質チェック → 5) コミット
295303

296304
## 📄 ライセンス
297305

README.md

Lines changed: 18 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -132,6 +132,7 @@ Powerful commands available in Claude Code
132132
| `/task` | Rule-based execution | Single task execution |
133133
| `/review` | Design Doc compliance check | Post-implementation validation |
134134
| `/rule-maintenance` | Rule management | Adding/updating rules |
135+
| `/project-inject` | Inject project context | When starting with boilerplate |
135136
| `/onboard` | Load project rules | Project initialization |
136137

137138
See individual definition files in `.claude/commands/` for details.
@@ -149,22 +150,28 @@ npm install
149150

150151
### Project Configuration
151152

153+
Configure project-specific context for your project:
154+
155+
```bash
156+
# 1. Inject project context using Claude Code
157+
/project-inject
158+
159+
# This command interactively collects and configures:
160+
# - The problem your project solves
161+
# - Target users and usage scenarios
162+
# - Business constraints and development structure
163+
# → Automatically updates docs/rules/project-context.md
164+
```
165+
152166
```json
153-
// package.json
167+
// 2. Update package.json basics (if needed)
154168
{
155169
"name": "your-project-name",
156170
"description": "Your project description",
157171
"author": "Your name"
158172
}
159173
```
160174

161-
```bash
162-
# Replace placeholders in docs/rules/project-context.md
163-
# [Project Name] → Your actual project name
164-
# [Product Name Here] → Your actual product name
165-
# [Target User Role Here] → Your actual target users
166-
```
167-
168175
## 💻 Development Commands
169176

170177
### Essential Commands
@@ -290,10 +297,11 @@ A: quality-fixer attempts automatic fixes. If it can't resolve them, it provides
290297
A: Run `npm run lang:ja` (Japanese) or `npm run lang:en` (English).
291298

292299
### Q: How do I customize the boilerplate?
293-
A: Replace placeholders in `docs/rules/project-context.md`.
300+
A: Run `/project-inject` to interactively configure project context.
294301

295302
### Q: What's the Claude Code development workflow?
296-
A: 1) Load rules → 2) Plan & approve → 3) Implement → 4) Quality check → 5) Commit
303+
A: [Initial] 1) `/project-inject` for context setup → 2) `/onboard` to load rules
304+
[Development] 3) `/implement` or `/task` to build → 4) Quality check → 5) Commit
297305

298306
## 📄 License
299307

0 commit comments

Comments
 (0)