109 lines
4.9 KiB
Markdown
109 lines
4.9 KiB
Markdown
# claude-code-book-chapter8
|
|
|
|
This repository is the GitHub repository that manages the sample code for ["Practical Claude Code Introduction - A Way of Thinking About AI Coding for Real-World Use"](https://www.amazon.co.jp/dp/4297153548), published by Gijutsu-Hyohron Co., Ltd.
|
|
|
|
For detailed explanations of the code and prompts in this repository, please refer to the book.
|
|
|
|
For questions about the book's content or to report errata, please use the issues in the following repository.
|
|
|
|
https://github.com/GenerativeAgents/claude-code-book
|
|
|
|
## Development Workflow (Step by Step)
|
|
|
|
How a project goes from idea to working code with this boilerplate:
|
|
|
|
```
|
|
Idea → /setup-project → /define-design → refine design → /generate-app → /add-feature (repeat)
|
|
```
|
|
|
|
### Step 1 — Write down your idea
|
|
Put your brainstorming notes, requirements, and constraints into
|
|
`docs/ideas/initial-requirements.md` (free-form; replace the sample content with your own).
|
|
|
|
### Step 2 — Create the specification: `/setup-project`
|
|
Automatically creates the six persistent documents that define **what to build**:
|
|
PRD, functional design, architecture, repository structure, development guidelines, and glossary
|
|
(all under `docs/`). Review them and request edits in normal conversation if needed.
|
|
|
|
### Step 3 — Define the UI/UX design: `/define-design`
|
|
Creates the design specification under `docs/design/`: design brief, design tokens,
|
|
**`ui-blueprint.json` (the source of truth for UI generation)**, platform mapping, and SVG
|
|
wireframes (visual references only). You'll be asked once about platform, style, screens,
|
|
navigation, branding, and accessibility.
|
|
|
|
### Step 4 — Review and refine the design **before writing any code**
|
|
This is the key design-decision gate: iterate on the design while it is still cheap to change.
|
|
|
|
- `/update-design <change>` — targeted refinements (e.g. `add a profile screen`)
|
|
- Re-run `/define-design` — change the overall direction
|
|
- Repeat until you approve the design (especially `ui-blueprint.json`)
|
|
|
|
### Step 5 — Generate the initial app: `/generate-app web | flutter | winui3`
|
|
Scaffolds the app shell from the approved design: theme (from tokens), routes, screens, and
|
|
reusable components. No feature logic yet.
|
|
|
|
### Step 6 — Implement features: `/add-feature <feature>`
|
|
A fully autonomous loop, one feature at a time. Each run:
|
|
|
|
1. Creates `.steering/[YYYYMMDD]-[feature]/` (requirements, design, tasklist)
|
|
2. Reads the design spec first — and updates it first if the feature changes the UI
|
|
3. Implements every task in `tasklist.md`, checking items off as it goes
|
|
4. Validates quality with the `implementation-validator` subagent
|
|
5. Runs `npm test`, `npm run lint`, `npm run typecheck` until green
|
|
6. Records a retrospective and reconciles all six `docs/` documents with the feature
|
|
|
|
### Step 7 — Repeat and maintain
|
|
- More features → `/add-feature <feature>` (again and again)
|
|
- UI changes → `/update-design <change>` first, then `/add-feature`
|
|
- Document quality checks → `/review-docs <path>`
|
|
|
|
**A feature is "done" when**: all tasks in its tasklist are `[x]`, validation passes,
|
|
test/lint/typecheck succeed, and the persistent documents are back in sync with the code.
|
|
|
|
## Notes
|
|
|
|
The content of this repository may be changed to improve prompt performance based on feedback from readers. Differences will be reflected in the book as needed, but please be aware that there may be discrepancies with the edition you have on hand.
|
|
|
|
## Usage
|
|
|
|
### 1. Clone the repository
|
|
|
|
```bash
|
|
git clone [this repository] claude-code-book-chapter8
|
|
cd claude-code-book-chapter8
|
|
```
|
|
|
|
### 2. Open via Dev Container
|
|
|
|
When you select "Reopen in Container" in Visual Studio Code, the environment is automatically set up as follows.
|
|
|
|
- Building a Node.js LTS environment
|
|
- Running npm install
|
|
- Installing the latest version of Claude Code
|
|
|
|
* When using Dev Container, you need to install Docker in advance.
|
|
|
|
### 3. Start Claude Code and follow the workflow
|
|
|
|
```bash
|
|
claude
|
|
> /setup-project
|
|
> /define-design
|
|
> /update-design [refinement] # repeat until the design is approved
|
|
> /generate-app web # or flutter | winui3
|
|
> /add-feature [feature name]
|
|
```
|
|
|
|
See [Development Workflow (Step by Step)](#development-workflow-step-by-step) above for what each step does.
|
|
|
|
## Commands Reference
|
|
|
|
| Command | Description | Example |
|
|
|---|---|---|
|
|
| `/setup-project` | Create the six persistent documents automatically | `/setup-project` |
|
|
| `/define-design` | Create the UI/UX design spec under `docs/design/` | `/define-design` |
|
|
| `/update-design` | Refine the design before generation, or update it when a feature changes the UI | `/update-design add a profile screen` |
|
|
| `/generate-app` | Scaffold the initial app for a target platform | `/generate-app web` |
|
|
| `/add-feature` | Implement a feature end-to-end (autonomous) | `/add-feature User profile editing` |
|
|
| `/review-docs` | Detailed document review via subagent | `/review-docs docs/architecture.md` |
|