Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 37 additions & 8 deletions README.ko.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,13 +43,27 @@ AI가 바로 파일을 고치게 두지 않고, 작업 목적과 범위, 검증

## 바로 설치

### 기존 저장소

AI 코딩 도구에 다음 한 줄을 보내세요.

```text
https://github.com/postmelee/hyper-waterfall 의 하이퍼-워터폴 방법론을 이 저장소에 적용해줘.
```

AI는 [`docs/agent-entrypoint.md`](docs/agent-entrypoint.md)부터 읽어 적용 절차를 따릅니다. 소스 변경 전 반드시 작업지시자 승인을 받게 되어 있습니다.
### 새 프로젝트

프로젝트 아이디어를 저장소로 시작할 시점이 되면 먼저 빈 GitHub 저장소나 로컬 저장소를 만드세요. 그 빈 저장소에서 다음 프롬프트를 보내면 됩니다.

```text
이 빈 저장소에서 새 프로젝트를 시작하려고 합니다.

먼저 https://github.com/postmelee/hyper-waterfall 의 하이퍼-워터폴 방법론을 이 저장소에 적용해줘.

프로젝트 기획서나 요구사항 초안이 첨부되어 있다면 참고 맥락으로만 사용해줘. 적용 단계에서는 제품 계획서, 아키텍처 문서, 소스 코드를 만들지 말고, 적용 후 첫 제품 작업을 별도 GitHub Issue로 등록할 수 있게 도와줘.
```

두 경로 모두 AI는 [`docs/agent-entrypoint.md`](docs/agent-entrypoint.md)부터 읽어 적용 절차를 따릅니다. 소스 변경 전 반드시 작업지시자 승인을 받게 되어 있습니다.

| AI가 먼저 보고할 것 | 내용 |
|---|---|
Expand All @@ -59,15 +73,30 @@ AI는 [`docs/agent-entrypoint.md`](docs/agent-entrypoint.md)부터 읽어 적용

### 언어 지원

기본 locale은 `en`입니다. 지원 locale pack은 `en`, `ko`, `zh-CN`이며, 선택한 locale source가 없으면 fallback 후보를 사용하기 전에 먼저 보고합니다. 특정 언어로 적용하려면 프롬프트나 CLI dry-run에 locale을 명시하세요.
기본 locale은 `en`입니다. 지원 locale pack은 `en`, `ko`, `zh-CN`이며, 선택한 locale source가 없으면 fallback 후보를 사용하기 전에 먼저 보고합니다.

| 언어 | AI 적용 프롬프트 | CLI dry-run |
|---|---|---|
| English | `Apply the Hyper-Waterfall methodology from https://github.com/postmelee/hyper-waterfall to this repository. Use locale en.` | `npx hyper-waterfall@0.3.0 init --repo . --locale en --dry-run` |
| 한국어 | `https://github.com/postmelee/hyper-waterfall 의 하이퍼-워터폴 방법론을 이 저장소에 적용해줘. locale은 ko로 사용해줘.` | `npx hyper-waterfall@0.3.0 init --repo . --locale ko --dry-run` |
| 중국어 간체 | `将 https://github.com/postmelee/hyper-waterfall 的 Hyper-Waterfall 方法论应用到这个仓库。使用 zh-CN locale。` | `npx hyper-waterfall@0.3.0 init --repo . --locale zh-CN --dry-run` |
| 언어 | Locale |
|---|---|
| English | `en` |
| 한국어 | `ko` |
| 중국어 간체 | `zh-CN` |

AI 코딩 도구를 사용할 때는 원하는 언어로 지시하세요. AI는 파일 변경 전 선택 locale을 먼저 보고합니다.

터미널에서 적용 판단을 확인하려면 locale을 명시해 실행하세요. 필요하면 `ko`를 `en` 또는 `zh-CN`으로 바꾸면 됩니다.

```sh
npx hyper-waterfall@0.3.0 init --repo . --locale ko --dry-run
```

macOS에서 자주 실행한다면 Homebrew로 CLI를 설치할 수 있습니다.

```sh
brew install postmelee/tap/hyper-waterfall
hyper-waterfall init --repo . --locale ko --dry-run
```

CLI 명령은 lifecycle 판단 결과만 출력합니다. 실제 파일 변경은 계속 승인 workflow를 거쳐 진행합니다.
`npx`와 Homebrew CLI 명령은 lifecycle 판단 결과만 출력합니다. 실제 파일 변경은 계속 승인 workflow를 거쳐 진행합니다.

도입 후에는 AI가 Hyper-Waterfall 방식을 지키며 작업을 진행합니다. 처음 시작하는 사용자는 AI에게 `"이거 구현해줘"`와 같은 자연어 명령을 내리면 됩니다.

Expand Down
45 changes: 37 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,13 +43,27 @@ As a result, every task is documented, and decisions plus verification results r

## Quick Start

### Existing repository

Send this one line to your AI coding tool.

```text
Apply the Hyper-Waterfall methodology from https://github.com/postmelee/hyper-waterfall to this repository.
```

The AI starts from [`docs/agent-entrypoint.en.md`](docs/agent-entrypoint.en.md) and follows the adoption procedure. It must ask for approval before changing source files.
### New project

When your project idea is ready to become a repository, create an empty GitHub or local repository first. Then send this prompt from that empty repository.

```text
I am starting a new project in this empty repository.

Apply the Hyper-Waterfall methodology from https://github.com/postmelee/hyper-waterfall to this repository first.

If a project brief or requirements draft is attached, use it for context only. Do not create product plans, architecture documents, or source code during adoption. After adoption, help me register the first product task as a separate GitHub Issue.
```

In both paths, the AI starts from [`docs/agent-entrypoint.en.md`](docs/agent-entrypoint.en.md) and follows the adoption procedure. It must ask for approval before changing source files.

| What the AI reports first | Content |
|---|---|
Expand All @@ -59,15 +73,30 @@ The AI starts from [`docs/agent-entrypoint.en.md`](docs/agent-entrypoint.en.md)

### Language support

The default locale is `en`. Supported locale packs are `en`, `ko`, and `zh-CN`; missing locale sources are reported before fallback candidates are used. To apply Hyper-Waterfall in a specific language, include the locale in the prompt or run the CLI dry-run first.
The default locale is `en`. Supported locale packs are `en`, `ko`, and `zh-CN`; missing locale sources are reported before fallback candidates are used.

| Language | AI prompt | CLI dry-run |
|---|---|---|
| English | `Apply the Hyper-Waterfall methodology from https://github.com/postmelee/hyper-waterfall to this repository. Use locale en.` | `npx hyper-waterfall@0.3.0 init --repo . --locale en --dry-run` |
| Korean | `https://github.com/postmelee/hyper-waterfall 의 하이퍼-워터폴 방법론을 이 저장소에 적용해줘. locale은 ko로 사용해줘.` | `npx hyper-waterfall@0.3.0 init --repo . --locale ko --dry-run` |
| Simplified Chinese | `将 https://github.com/postmelee/hyper-waterfall 的 Hyper-Waterfall 方法论应用到这个仓库。使用 zh-CN locale。` | `npx hyper-waterfall@0.3.0 init --repo . --locale zh-CN --dry-run` |
| Language | Locale |
|---|---|
| English | `en` |
| Korean | `ko` |
| Simplified Chinese | `zh-CN` |

When using an AI coding tool, ask in the language you want to use. The AI reports the selected locale before changing files.

To check adoption from a terminal, pass the locale explicitly. Replace `en` with `ko` or `zh-CN` as needed.

```sh
npx hyper-waterfall@0.3.0 init --repo . --locale en --dry-run
```

On macOS, install the CLI with Homebrew if you run it often.

```sh
brew install postmelee/tap/hyper-waterfall
hyper-waterfall init --repo . --locale en --dry-run
```

The CLI command prints a lifecycle judgment only. Actual file changes still move through the approval workflow.
The `npx` and Homebrew CLI commands print lifecycle judgment only. Actual file changes still move through the approval workflow.

After adoption, the AI proceeds according to the Hyper-Waterfall process. New users can simply ask the AI in natural language, such as `"Implement this."`

Expand Down
45 changes: 37 additions & 8 deletions README.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,13 +43,27 @@ Hyper-Waterfall 是一种方法论 harness,它把 AI 编码绑定到 Issue、b

## 快速开始

### 现有仓库

把下面这一行发送给你的 AI 编码工具。

```text
将 https://github.com/postmelee/hyper-waterfall 的 Hyper-Waterfall 方法论应用到这个仓库。
```

AI 会先阅读 [`docs/agent-entrypoint.zh-CN.md`](docs/agent-entrypoint.zh-CN.md),并按应用流程执行。在修改源码前,它必须先请求任务指示者批准。
### 新项目

当你的项目想法准备进入仓库时,先创建一个空的 GitHub 仓库或本地仓库。然后从这个空仓库发送下面的 prompt。

```text
我想在这个空仓库中开始一个新项目。

请先将 https://github.com/postmelee/hyper-waterfall 的 Hyper-Waterfall 方法论应用到这个仓库。

如果附带了项目简报或需求草案,请只把它作为上下文参考。不要在应用阶段创建产品计划、架构文档或源代码。应用完成后,请帮我把第一个产品任务注册为单独的 GitHub Issue。
```

在两种路径中,AI 都会先阅读 [`docs/agent-entrypoint.zh-CN.md`](docs/agent-entrypoint.zh-CN.md),并按应用流程执行。在修改源码前,它必须先请求任务指示者批准。

| AI 需要先报告的内容 | 内容 |
|---|---|
Expand All @@ -59,15 +73,30 @@ AI 会先阅读 [`docs/agent-entrypoint.zh-CN.md`](docs/agent-entrypoint.zh-CN.m

### 语言支持

默认 locale 是 `en`。支持的 locale pack 是 `en`、`ko`、`zh-CN`;如果所选 locale source 缺失,会先报告 fallback 候选,而不是静默替换。想用指定语言应用 Hyper-Waterfall 时,请在 prompt 或 CLI dry-run 中写明 locale。
默认 locale 是 `en`。支持的 locale pack 是 `en`、`ko`、`zh-CN`;如果所选 locale source 缺失,会先报告 fallback 候选,而不是静默替换。

| 语言 | AI 应用 prompt | CLI dry-run |
|---|---|---|
| English | `Apply the Hyper-Waterfall methodology from https://github.com/postmelee/hyper-waterfall to this repository. Use locale en.` | `npx hyper-waterfall@0.3.0 init --repo . --locale en --dry-run` |
| 韩语 | `https://github.com/postmelee/hyper-waterfall 의 하이퍼-워터폴 방법론을 이 저장소에 적용해줘. locale은 ko로 사용해줘.` | `npx hyper-waterfall@0.3.0 init --repo . --locale ko --dry-run` |
| 简体中文 | `将 https://github.com/postmelee/hyper-waterfall 的 Hyper-Waterfall 方法论应用到这个仓库。使用 zh-CN locale。` | `npx hyper-waterfall@0.3.0 init --repo . --locale zh-CN --dry-run` |
| 语言 | Locale |
|---|---|
| English | `en` |
| 韩语 | `ko` |
| 简体中文 | `zh-CN` |

使用 AI 编码工具时,请用你想使用的语言提出请求。AI 会在修改文件前先报告选择的 locale。

要在终端中检查应用判断,请显式传入 locale。需要时可以把 `zh-CN` 替换为 `en` 或 `ko`。

```sh
npx hyper-waterfall@0.3.0 init --repo . --locale zh-CN --dry-run
```

在 macOS 上,如果经常运行 CLI,可以通过 Homebrew 安装。

```sh
brew install postmelee/tap/hyper-waterfall
hyper-waterfall init --repo . --locale zh-CN --dry-run
```

CLI 命令只输出 lifecycle 判断。实际文件变更仍然必须经过审批 workflow。
`npx` 和 Homebrew CLI 命令只输出 lifecycle 判断。实际文件变更仍然必须经过审批 workflow。

导入后,AI 会按照 Hyper-Waterfall 方式推进工作。第一次使用时,你可以直接用自然语言告诉 AI,例如 `"请实现这个功能"`。

Expand Down
1 change: 1 addition & 0 deletions mydocs/orders/20260528.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,4 @@
|------|--------|------|------|
| #79 | 다국어 배포 진입점 보강과 v0.3.0 release readiness | 완료 | 완료: 10:42, 최종 보고서 작성 및 PR 게시 진행 |
| #81 | v0.3.0 release 실행과 post-publish 검증 | 완료 | 완료: 12:52, 최종 보고서 작성 및 PR 준비 완료 |
| #83 | README Quick Start and Language support guidance | 완료 | 완료: 13:51, final report written and PR publication approval pending |
140 changes: 140 additions & 0 deletions mydocs/plans/task_m050_83.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,140 @@
# Task M050 #83 Task Plan

GitHub Issue: [#83](https://github.com/postmelee/hyper-waterfall/issues/83)
Milestone: M050
Working locale: `en`

## Purpose

Clarify the README onboarding path for users who want to start a new project with Hyper-Waterfall from day one, while preserving the existing path for applying Hyper-Waterfall to an existing repository.

This task also improves the Language support section so multilingual users can scan supported locales quickly and copy the prompt or CLI dry-run command for their language without fighting a wide table.

## Background

The current Quick Start presents one prompt that applies Hyper-Waterfall to "this repository." That works for existing repositories, but it leaves a new-project user with a few ambiguous choices: whether to create a blank repository first, whether to attach a project brief, and whether to ask the AI to create product plans, architecture documents, or source code at the same time as adoption.

In this thread, the task requester decided that external project briefs are acceptable as reference material, but Hyper-Waterfall adoption should not be combined with product planning, architecture writing, or product code generation. Adoption should install the workflow rails first; the first product task should then be tracked as a separate GitHub Issue.

The current Language support table is useful for comparison, but long prompts and CLI commands inside table cells are less convenient to copy, especially on narrow screens. The preferred structure is a compact locale summary table plus language-specific fenced code blocks.

## Scope

### Included

- Update `README.md`.
- Update `README.ko.md`.
- Update `README.zh-CN.md`.
- Add Quick Start guidance for new projects.
- Clarify that an existing project brief can be attached as reference only during adoption.
- Discourage combining adoption with product plans, architecture documents, or source code generation.
- Replace the long Language support command table with a compact locale overview plus copyable prompt and CLI code blocks per supported language.
- Keep English, Korean, and Simplified Chinese READMEs structurally aligned.

### Excluded

- No changes to `templates/`, locale packs, lifecycle documents, CLI behavior, or package metadata.
- No changes to README sections outside the Quick Start and Language support area unless needed for local link consistency.
- No new supported locale.
- No release, npm, Homebrew, plugin, or migration work.
- No product-project plan, architecture document, or source code generation.

## Design Direction

- Keep the Quick Start immediately actionable instead of turning it into a long lifecycle explanation.
- Separate "Existing repository" and "New project" as two user paths under Quick Start.
- State the new-project sequence directly: create an empty repository, apply Hyper-Waterfall before product code, then register the first product task as a GitHub Issue.
- Allow externally generated project briefs as reference material, but make clear they should not be adopted as product artifacts during the Hyper-Waterfall adoption step.
- Preserve the locale summary table for scanability and move copyable prompts/commands into fenced code blocks.
- Use the same structure across `README.md`, `README.ko.md`, and `README.zh-CN.md`, with localized natural-language text and unchanged command/code identifiers.

## Document Location Decision

| File | Classification | Audience | Selected Location | Alternative Location | Reason |
|---|---|---|---|---|---|
| `README.md` | Official user-facing documentation | English users and maintainers | Repository root | `docs/` | Quick Start is the primary public entry point. |
| `README.ko.md` | Official user-facing documentation | Korean users and maintainers | Repository root | `docs/` | Existing localized README mirror. |
| `README.zh-CN.md` | Official user-facing documentation | Simplified Chinese users and maintainers | Repository root | `docs/` | Existing localized README mirror. |
| `mydocs/plans/task_m050_83.md` | Task artifact | Maintainers and agents | `mydocs/plans/` | `docs/` | Hyper-Waterfall task plan artifact. |
| `mydocs/orders/20260528.md` | Task board artifact | Maintainers and agents | `mydocs/orders/` | `docs/` | Daily task board artifact. |

## Expected Changed Files

New:

- `mydocs/plans/task_m050_83.md`

Modified:

- `mydocs/orders/20260528.md`
- `README.md`
- `README.ko.md`
- `README.zh-CN.md`

Task artifacts expected later:

- `mydocs/plans/task_m050_83_impl.md`
- `mydocs/working/task_m050_83_stage1.md`
- `mydocs/working/task_m050_83_stage2.md`
- `mydocs/working/task_m050_83_stage3.md`
- `mydocs/report/task_m050_83_report.md`

## Tentative Stages

- **Stage 1 — Quick Start Path Split**
- Update the three README Quick Start sections to distinguish existing-repository adoption from new-project adoption.
- Add the project-brief-as-reference boundary and the "first product task as a separate GitHub Issue" rule.
- Validate by reviewing the three localized Quick Start sections side by side.

- **Stage 2 — Copyable Language Support**
- Convert the Language support table into a compact locale summary plus language-specific prompt and CLI code blocks.
- Preserve the existing locale list: `en`, `ko`, `zh-CN`.
- Validate copyability and command consistency across the three READMEs.

- **Stage 3 — Cross-Locale Consistency and Final Polish**
- Check headings, link targets, prompt wording, CLI version consistency, and structural alignment across the three READMEs.
- Run whitespace and search-based validation.
- Prepare the Stage 3 report and final report path after implementation is complete.

## Validation Plan

### Stage Validation

- Stage 1
- `rg -n "Existing repository|New project|project brief|기존 저장소|새 프로젝트|프로젝트 기획서|现有仓库|新项目|项目简报" README.md README.ko.md README.zh-CN.md`
- Manual side-by-side review of Quick Start structure.

- Stage 2
- `rg -n "Language support|언어 지원|语言支持|npx hyper-waterfall@0.3.0 init --repo \\. --locale" README.md README.ko.md README.zh-CN.md`
- Manual check that each supported locale has copyable prompt and CLI blocks.

- Stage 3
- `rg -n "New project|Existing repository|Language support|언어 지원|语言支持|새 프로젝트|新项目" README.md README.ko.md README.zh-CN.md`
- `git diff --check`

### Integrated Validation

- The three README files remain structurally aligned in the changed sections.
- Adoption and product-work boundaries are explicit for new-project users.
- Prompt and CLI examples are easy to copy and keep locale codes unchanged.
- `git status --short` is clean before PR publication.
- `git diff --check` passes without warnings.

## Risks

- **Overloading Quick Start**: Adding too much lifecycle detail could make the entry path harder to scan. Mitigation: keep the new guidance short and link behavior through existing adoption wording.
- **Locale drift**: The three READMEs could diverge structurally. Mitigation: edit the same section shape in all three files and validate with targeted searches.
- **Adoption/product boundary ambiguity**: Project briefs might be read as permission to generate product artifacts during adoption. Mitigation: state "reference only" and require a separate GitHub Issue for the first product task.
- **Template-language mismatch**: Older repository templates are Korean-first, while this task is intentionally dogfooding English. Mitigation: follow the M050 locale policy for internal task artifacts and keep structural identifiers unchanged.

## Approval Request

Please approve this task plan, including:

- The new-project Quick Start guidance.
- The reference-only treatment for externally generated project briefs.
- The decision not to combine Hyper-Waterfall adoption with product plans, architecture documents, or source code generation.
- The Language support restructure into a compact locale overview plus fenced copy blocks.
- The tentative three-stage implementation plan.

After approval, I will write `mydocs/plans/task_m050_83_impl.md` with concrete stage outputs, validation commands, and commit messages before editing any README file.
Loading
Loading