From 2b3a3bd1a855da85840a2eddba81435b769a78a6 Mon Sep 17 00:00:00 2001 From: postmelee Date: Thu, 28 May 2026 13:10:39 +0900 Subject: [PATCH 1/8] Task #83: task plan and todo update --- mydocs/orders/20260528.md | 1 + mydocs/plans/task_m050_83.md | 140 +++++++++++++++++++++++++++++++++++ 2 files changed, 141 insertions(+) create mode 100644 mydocs/plans/task_m050_83.md diff --git a/mydocs/orders/20260528.md b/mydocs/orders/20260528.md index 2174e1a..9736b7f 100644 --- a/mydocs/orders/20260528.md +++ b/mydocs/orders/20260528.md @@ -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 | 진행중 | M050, task plan approval pending | diff --git a/mydocs/plans/task_m050_83.md b/mydocs/plans/task_m050_83.md new file mode 100644 index 0000000..448ded2 --- /dev/null +++ b/mydocs/plans/task_m050_83.md @@ -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. From 65579be26eda34bfbc9d9cd1d7d6a94eb2e113fa Mon Sep 17 00:00:00 2001 From: postmelee Date: Thu, 28 May 2026 13:13:11 +0900 Subject: [PATCH 2/8] Task #83: implementation plan --- mydocs/orders/20260528.md | 2 +- mydocs/plans/task_m050_83_impl.md | 214 ++++++++++++++++++++++++++++++ 2 files changed, 215 insertions(+), 1 deletion(-) create mode 100644 mydocs/plans/task_m050_83_impl.md diff --git a/mydocs/orders/20260528.md b/mydocs/orders/20260528.md index 9736b7f..34157b3 100644 --- a/mydocs/orders/20260528.md +++ b/mydocs/orders/20260528.md @@ -6,4 +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 | 진행중 | M050, task plan approval pending | +| #83 | README Quick Start and Language support guidance | 진행중 | M050, implementation plan approval pending | diff --git a/mydocs/plans/task_m050_83_impl.md b/mydocs/plans/task_m050_83_impl.md new file mode 100644 index 0000000..7f16f69 --- /dev/null +++ b/mydocs/plans/task_m050_83_impl.md @@ -0,0 +1,214 @@ +# Task M050 #83 Implementation Plan + +Task plan: [`task_m050_83.md`](task_m050_83.md) +GitHub Issue: [#83](https://github.com/postmelee/hyper-waterfall/issues/83) +Milestone: M050 +Working locale: `en` + +## Stage Overview + +| Stage | Title | Primary Output | Validation | +|---|---|---|---| +| 1 | Quick Start Path Split | `README.md`, `README.ko.md`, `README.zh-CN.md`, `mydocs/working/task_m050_83_stage1.md` | New-project and existing-repository paths exist in all three READMEs | +| 2 | Copyable Language Support | `README.md`, `README.ko.md`, `README.zh-CN.md`, `mydocs/working/task_m050_83_stage2.md` | Locale overview table plus copyable prompt/CLI blocks exist in all three READMEs | +| 3 | Cross-Locale Consistency and Final Polish | `README.md`, `README.ko.md`, `README.zh-CN.md`, `mydocs/working/task_m050_83_stage3.md` | Cross-locale structure, command consistency, and whitespace checks pass | + +## Document Location Check + +The stage outputs match the task plan's document location decision. + +| File | Task Plan Location | Stage Output Path | Match | Notes | +|---|---|---|---|---| +| `README.md` | Repository root | Stage 1-3 | OK | English user-facing Quick Start and Language support. | +| `README.ko.md` | Repository root | Stage 1-3 | OK | Korean localized mirror. | +| `README.zh-CN.md` | Repository root | Stage 1-3 | OK | Simplified Chinese localized mirror. | +| `mydocs/working/task_m050_83_stage1.md` | `mydocs/working/` | Stage 1 | OK | Stage 1 completion report. | +| `mydocs/working/task_m050_83_stage2.md` | `mydocs/working/` | Stage 2 | OK | Stage 2 completion report. | +| `mydocs/working/task_m050_83_stage3.md` | `mydocs/working/` | Stage 3 | OK | Stage 3 completion report. | +| `mydocs/report/task_m050_83_report.md` | `mydocs/report/` | Final report | OK | Final result report after all stages. | + +## Stage 1 — Quick Start Path Split + +### Outputs + +New: + +- `mydocs/working/task_m050_83_stage1.md` + +Modified: + +- `README.md` +- `README.ko.md` +- `README.zh-CN.md` +- `mydocs/orders/20260528.md` + +### Changes + +- Split the Quick Start section into two explicit paths: + - Existing repository adoption. + - New project adoption. +- Preserve the existing one-line adoption prompt for existing repositories. +- Add the new-project sequence: + - Create an empty repository first. + - Apply Hyper-Waterfall before product code or product documents. + - Treat any external project brief as reference material only. + - Start the first product task as a separate GitHub Issue after adoption. +- Explicitly avoid recommending adoption combined with product planning, architecture documents, or source code generation. +- Keep the section compact so Quick Start remains immediately actionable. + +### Validation + +```bash +rg -n "Existing repository|New project|project brief|product plans|source code|기존 저장소|새 프로젝트|프로젝트 기획서|제품 계획서|소스 코드|现有仓库|新项目|项目简报|产品计划|源代码" README.md README.ko.md README.zh-CN.md +git diff --check +``` + +Manual validation: + +- Confirm all three README Quick Start sections have the same two-path structure. +- Confirm the new-project guidance does not imply product artifacts are created during adoption. +- Confirm external briefs are described as reference-only material. + +### Commit + +```text +Task #83 Stage 1: Quick Start new-project guidance +``` + +## Stage 2 — Copyable Language Support + +### Outputs + +New: + +- `mydocs/working/task_m050_83_stage2.md` + +Modified: + +- `README.md` +- `README.ko.md` +- `README.zh-CN.md` +- `mydocs/orders/20260528.md` + +### Changes + +- Replace the long Language support prompt/CLI table with: + - A compact supported-locale table. + - Per-language copyable prompt blocks. + - Per-language copyable CLI dry-run blocks. +- Preserve the supported locale list exactly: `en`, `ko`, `zh-CN`. +- Keep commands structurally unchanged: + - `npx hyper-waterfall@0.3.0 init --repo . --locale en --dry-run` + - `npx hyper-waterfall@0.3.0 init --repo . --locale ko --dry-run` + - `npx hyper-waterfall@0.3.0 init --repo . --locale zh-CN --dry-run` +- Keep language-specific prompt text localized, with locale codes unchanged. +- Preserve the statement that CLI dry-run prints lifecycle judgment only and actual file changes still require approval. + +### Validation + +```bash +rg -n "Language support|언어 지원|语言支持|Supported locale|지원 locale|支持的 locale|npx hyper-waterfall@0.3.0 init --repo \\. --locale" README.md README.ko.md README.zh-CN.md +rg -n "locale en|locale은 ko|使用 zh-CN locale|--locale en|--locale ko|--locale zh-CN" README.md README.ko.md README.zh-CN.md +git diff --check +``` + +Manual validation: + +- Confirm each README has copyable fenced code blocks for English, Korean, and Simplified Chinese prompts. +- Confirm each README has copyable fenced `sh` blocks for all three CLI dry-run commands. +- Confirm the summary table remains short enough to scan. + +### Commit + +```text +Task #83 Stage 2: Copyable language support examples +``` + +## Stage 3 — Cross-Locale Consistency and Final Polish + +### Outputs + +New: + +- `mydocs/working/task_m050_83_stage3.md` + +Modified: + +- `README.md` +- `README.ko.md` +- `README.zh-CN.md` +- `mydocs/orders/20260528.md` + +### Changes + +- Check that the changed Quick Start and Language support sections follow the same structure in all three README files. +- Confirm localized links point to the correct agent entrypoint files: + - `docs/agent-entrypoint.en.md` + - `docs/agent-entrypoint.md` + - `docs/agent-entrypoint.zh-CN.md` +- Confirm code identifiers, locale codes, command names, branch/Issue/PR vocabulary, and file paths are preserved. +- Tighten wording where needed so the adoption/product-work boundary is clear without overloading Quick Start. +- Run final whitespace and search-based validation before the final report stage. + +### Validation + +```bash +rg -n "Existing repository|New project|Language support|언어 지원|语言支持|새 프로젝트|新项目|npx hyper-waterfall@0.3.0" README.md README.ko.md README.zh-CN.md +rg -n "docs/agent-entrypoint\\.en\\.md|docs/agent-entrypoint\\.md|docs/agent-entrypoint\\.zh-CN\\.md" README.md README.ko.md README.zh-CN.md +rg -n "product plans|architecture documents|source code|제품 계획서|아키텍처 문서|소스 코드|产品计划|架构文档|源代码" README.md README.ko.md README.zh-CN.md +git diff --check +``` + +Manual validation: + +- Compare the changed section order across `README.md`, `README.ko.md`, and `README.zh-CN.md`. +- Confirm no unrelated README sections were rewritten. +- Confirm the final wording reflects all decisions from the thread. + +### Commit + +```text +Task #83 Stage 3: README locale consistency polish +``` + +## Validation Rules + +- Each Stage validation command must run before the Stage report is written. +- A failed validation blocks Stage completion until recovered inside the same Stage or until the plan is updated and re-approved. +- Stage reports are committed with their stage outputs. +- `git diff --check` must pass at every Stage boundary. +- The final report must summarize the changed README guidance, validation results, and any remaining limitations. + +## Commits + +- Stage commits include both the README changes for that Stage and the corresponding `mydocs/working/task_m050_83_stage{N}.md` report. +- Commit messages use the exact messages listed in each Stage section unless the approved plan is updated. +- The implementation plan itself is committed separately as: + +```text +Task #83: implementation plan +``` + +## Stage Dependencies + +- Stage 2 starts only after Stage 1 is reported and approved. +- Stage 3 starts only after Stage 2 is reported and approved. +- Final reporting starts only after Stage 3 is reported and approved. + +## Risks and Responses + +- **Quick Start bloat**: The new-project path could make the entry section too long. Response: keep each path short and defer lifecycle details to the existing adoption procedure text. +- **Cross-locale drift**: One README could gain different guidance from the others. Response: keep the section structure parallel and validate with targeted searches. +- **Copy block duplication errors**: Repeated prompts and commands can drift by locale. Response: validate locale codes and CLI command strings explicitly. +- **Ambiguous project brief wording**: Readers could still interpret a brief as a request to create product artifacts during adoption. Response: use direct reference-only wording and explicitly move product work to a separate first Issue. + +## Approval Request + +Please approve: + +- The three-stage implementation split. +- The Stage outputs and validation commands. +- The planned commit messages. +- The rule that each Stage stops for approval after its report before the next Stage begins. + +After approval, I will start Stage 1 and edit only the Quick Start sections plus the Stage 1 report and todo state. From 9bfe5a7adfc30fa56ba8b4e280408cfa9080c471 Mon Sep 17 00:00:00 2001 From: postmelee Date: Thu, 28 May 2026 13:16:43 +0900 Subject: [PATCH 3/8] Task #83 Stage 1: Quick Start new-project guidance --- README.ko.md | 12 +++++- README.md | 12 +++++- README.zh-CN.md | 12 +++++- mydocs/orders/20260528.md | 2 +- mydocs/working/task_m050_83_stage1.md | 55 +++++++++++++++++++++++++++ 5 files changed, 89 insertions(+), 4 deletions(-) create mode 100644 mydocs/working/task_m050_83_stage1.md diff --git a/README.ko.md b/README.ko.md index 0e1597e..f679111 100644 --- a/README.ko.md +++ b/README.ko.md @@ -43,13 +43,23 @@ AI가 바로 파일을 고치게 두지 않고, 작업 목적과 범위, 검증 ## 바로 설치 +### 기존 저장소 + AI 코딩 도구에 다음 한 줄을 보내세요. ```text https://github.com/postmelee/hyper-waterfall 의 하이퍼-워터폴 방법론을 이 저장소에 적용해줘. ``` -AI는 [`docs/agent-entrypoint.md`](docs/agent-entrypoint.md)부터 읽어 적용 절차를 따릅니다. 소스 변경 전 반드시 작업지시자 승인을 받게 되어 있습니다. +### 새 프로젝트 + +먼저 빈 GitHub 저장소나 로컬 저장소를 만드세요. 제품 코드나 제품 문서를 추가하기 전에, 그 빈 저장소에서 같은 적용 프롬프트를 AI 코딩 도구에 보내세요. + +다른 에이전트가 만든 프로젝트 기획서나 요구사항 초안이 이미 있다면 참고 자료로만 첨부할 수 있습니다. Hyper-Waterfall 적용 단계에서 제품 계획서, 아키텍처 문서, 소스 코드 생성을 함께 요청하지 마세요. + +적용 후 첫 제품 작업은 별도 GitHub Issue로 등록하고 일반 Hyper-Waterfall workflow로 진행합니다. + +두 경로 모두 AI는 [`docs/agent-entrypoint.md`](docs/agent-entrypoint.md)부터 읽어 적용 절차를 따릅니다. 소스 변경 전 반드시 작업지시자 승인을 받게 되어 있습니다. | AI가 먼저 보고할 것 | 내용 | |---|---| diff --git a/README.md b/README.md index 6e50c48..5867405 100644 --- a/README.md +++ b/README.md @@ -43,13 +43,23 @@ 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 + +Create an empty GitHub or local repository first. Before adding product code or product documents, send the same adoption prompt to your AI coding tool from that empty repository. + +If you already have a project brief or requirements draft from another agent, attach it as reference material only. Do not ask the AI to adopt Hyper-Waterfall and create product plans, architecture documents, or source code in the same step. + +After adoption, register the first product task as a separate GitHub Issue and proceed through the normal Hyper-Waterfall workflow. + +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 | |---|---| diff --git a/README.zh-CN.md b/README.zh-CN.md index 2f667dc..e772ac0 100644 --- a/README.zh-CN.md +++ b/README.zh-CN.md @@ -43,13 +43,23 @@ 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 发送给你的 AI 编码工具。 + +如果你已经有其他 agent 生成的项目简报或需求草案,可以只把它作为参考材料附上。不要要求 AI 在同一步骤中应用 Hyper-Waterfall,同时创建产品计划、架构文档或源代码。 + +导入后,把第一个产品任务注册为单独的 GitHub Issue,然后按正常的 Hyper-Waterfall workflow 推进。 + +在两种路径中,AI 都会先阅读 [`docs/agent-entrypoint.zh-CN.md`](docs/agent-entrypoint.zh-CN.md),并按应用流程执行。在修改源码前,它必须先请求任务指示者批准。 | AI 需要先报告的内容 | 内容 | |---|---| diff --git a/mydocs/orders/20260528.md b/mydocs/orders/20260528.md index 34157b3..f1c8f50 100644 --- a/mydocs/orders/20260528.md +++ b/mydocs/orders/20260528.md @@ -6,4 +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 | 진행중 | M050, implementation plan approval pending | +| #83 | README Quick Start and Language support guidance | 진행중 | M050, Stage 1 report approval pending | diff --git a/mydocs/working/task_m050_83_stage1.md b/mydocs/working/task_m050_83_stage1.md new file mode 100644 index 0000000..a1fb9c6 --- /dev/null +++ b/mydocs/working/task_m050_83_stage1.md @@ -0,0 +1,55 @@ +# Task M050 #83 Stage 1 Report + +GitHub Issue: [#83](https://github.com/postmelee/hyper-waterfall/issues/83) +Implementation plan: [`task_m050_83_impl.md`](../plans/task_m050_83_impl.md) +Stage: 1 + +## Stage Purpose + +Stage 1 split the Quick Start guidance into two explicit paths: applying Hyper-Waterfall to an existing repository and starting a brand-new project with Hyper-Waterfall from day one. + +The stage also added the agreed adoption boundary: external project briefs can be attached as reference only, while product plans, architecture documents, and source code must not be generated during the adoption step. + +## Outputs + +| File | Change Summary | +|---|---| +| `README.md` | Added `Existing repository` and `New project` Quick Start paths, with reference-only project brief guidance and separate first-Issue product work. | +| `README.ko.md` | Added the same Quick Start path split in Korean. | +| `README.zh-CN.md` | Added the same Quick Start path split in Simplified Chinese. | +| `mydocs/orders/20260528.md` | Updated #83 status note to Stage 1 report approval pending. | + +## Text Change Scope / Losslessness + +The README changes are limited to the Quick Start area before the Language support section. The existing adoption prompt, agent entrypoint link, approval-gate wording, and "What the AI reports first" table were preserved in each README. + +The Language support table remains unchanged in this Stage; it is the planned Stage 2 scope. + +## Validation Results + +Executed commands: + +```bash +rg -n "Existing repository|New project|project brief|product plans|source code|기존 저장소|새 프로젝트|프로젝트 기획서|제품 계획서|소스 코드|现有仓库|新项目|项目简报|产品计划|源代码" README.md README.ko.md README.zh-CN.md +git diff --check +``` + +Results: + +- OK: `rg` found the new existing-repository and new-project headings in all three READMEs. +- OK: `rg` found the reference-only brief wording and the product artifact boundary in all three READMEs. +- OK: `git diff --check` completed with no whitespace errors. +- OK: Manual side-by-side review confirmed the same two-path Quick Start structure across English, Korean, and Simplified Chinese READMEs. +- OK: Manual review confirmed the new-project guidance does not imply product artifacts are created during adoption. + +## Residual Risk + +- Stage 2 has not yet improved the Language support section, so the current long prompt/CLI table remains until the next approved stage. + +## Next Stage Impact + +- Stage 2 should preserve this new Quick Start structure while replacing the Language support table with a compact locale overview and copyable prompt/CLI blocks. + +## Approval Request + +- Approve the Stage 1 Quick Start guidance and validation results to proceed to Stage 2. From 12b2277dd99090ca95a55a5f34300fcdf8f6164b Mon Sep 17 00:00:00 2001 From: postmelee Date: Thu, 28 May 2026 13:25:28 +0900 Subject: [PATCH 4/8] Task #83 [Stage 1.1]: Quick Start new-project prompt guidance --- README.ko.md | 10 +++++++--- README.md | 10 +++++++--- README.zh-CN.md | 10 +++++++--- mydocs/orders/20260528.md | 2 +- mydocs/working/task_m050_83_stage1.md | 17 ++++++++++++----- 5 files changed, 34 insertions(+), 15 deletions(-) diff --git a/README.ko.md b/README.ko.md index f679111..d83eb3f 100644 --- a/README.ko.md +++ b/README.ko.md @@ -53,11 +53,15 @@ https://github.com/postmelee/hyper-waterfall 의 하이퍼-워터폴 방법론 ### 새 프로젝트 -먼저 빈 GitHub 저장소나 로컬 저장소를 만드세요. 제품 코드나 제품 문서를 추가하기 전에, 그 빈 저장소에서 같은 적용 프롬프트를 AI 코딩 도구에 보내세요. +프로젝트 아이디어를 저장소로 시작할 시점이 되면 먼저 빈 GitHub 저장소나 로컬 저장소를 만드세요. 그 빈 저장소에서 다음 프롬프트를 보내면 됩니다. -다른 에이전트가 만든 프로젝트 기획서나 요구사항 초안이 이미 있다면 참고 자료로만 첨부할 수 있습니다. Hyper-Waterfall 적용 단계에서 제품 계획서, 아키텍처 문서, 소스 코드 생성을 함께 요청하지 마세요. +```text +이 빈 저장소에서 새 프로젝트를 시작하려고 합니다. + +먼저 https://github.com/postmelee/hyper-waterfall 의 하이퍼-워터폴 방법론을 이 저장소에 적용해줘. -적용 후 첫 제품 작업은 별도 GitHub Issue로 등록하고 일반 Hyper-Waterfall workflow로 진행합니다. +프로젝트 기획서나 요구사항 초안이 첨부되어 있다면 참고 맥락으로만 사용해줘. 적용 단계에서는 제품 계획서, 아키텍처 문서, 소스 코드를 만들지 말고, 적용 후 첫 제품 작업을 별도 GitHub Issue로 등록할 수 있게 도와줘. +``` 두 경로 모두 AI는 [`docs/agent-entrypoint.md`](docs/agent-entrypoint.md)부터 읽어 적용 절차를 따릅니다. 소스 변경 전 반드시 작업지시자 승인을 받게 되어 있습니다. diff --git a/README.md b/README.md index 5867405..bf64bd3 100644 --- a/README.md +++ b/README.md @@ -53,11 +53,15 @@ Apply the Hyper-Waterfall methodology from https://github.com/postmelee/hyper-wa ### New project -Create an empty GitHub or local repository first. Before adding product code or product documents, send the same adoption prompt to your AI coding tool from that empty repository. +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. -If you already have a project brief or requirements draft from another agent, attach it as reference material only. Do not ask the AI to adopt Hyper-Waterfall and create product plans, architecture documents, or source code in the same step. +```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. -After adoption, register the first product task as a separate GitHub Issue and proceed through the normal Hyper-Waterfall workflow. +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. diff --git a/README.zh-CN.md b/README.zh-CN.md index e772ac0..4a98515 100644 --- a/README.zh-CN.md +++ b/README.zh-CN.md @@ -53,11 +53,15 @@ Hyper-Waterfall 是一种方法论 harness,它把 AI 编码绑定到 Issue、b ### 新项目 -先创建一个空的 GitHub 仓库或本地仓库。在添加产品代码或产品文档之前,从这个空仓库把同一个应用 prompt 发送给你的 AI 编码工具。 +当你的项目想法准备进入仓库时,先创建一个空的 GitHub 仓库或本地仓库。然后从这个空仓库发送下面的 prompt。 -如果你已经有其他 agent 生成的项目简报或需求草案,可以只把它作为参考材料附上。不要要求 AI 在同一步骤中应用 Hyper-Waterfall,同时创建产品计划、架构文档或源代码。 +```text +我想在这个空仓库中开始一个新项目。 + +请先将 https://github.com/postmelee/hyper-waterfall 的 Hyper-Waterfall 方法论应用到这个仓库。 -导入后,把第一个产品任务注册为单独的 GitHub Issue,然后按正常的 Hyper-Waterfall workflow 推进。 +如果附带了项目简报或需求草案,请只把它作为上下文参考。不要在应用阶段创建产品计划、架构文档或源代码。应用完成后,请帮我把第一个产品任务注册为单独的 GitHub Issue。 +``` 在两种路径中,AI 都会先阅读 [`docs/agent-entrypoint.zh-CN.md`](docs/agent-entrypoint.zh-CN.md),并按应用流程执行。在修改源码前,它必须先请求任务指示者批准。 diff --git a/mydocs/orders/20260528.md b/mydocs/orders/20260528.md index f1c8f50..b7f01c5 100644 --- a/mydocs/orders/20260528.md +++ b/mydocs/orders/20260528.md @@ -6,4 +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 | 진행중 | M050, Stage 1 report approval pending | +| #83 | README Quick Start and Language support guidance | 진행중 | M050, Stage 1 revision approval pending | diff --git a/mydocs/working/task_m050_83_stage1.md b/mydocs/working/task_m050_83_stage1.md index a1fb9c6..60f812f 100644 --- a/mydocs/working/task_m050_83_stage1.md +++ b/mydocs/working/task_m050_83_stage1.md @@ -8,21 +8,25 @@ Stage: 1 Stage 1 split the Quick Start guidance into two explicit paths: applying Hyper-Waterfall to an existing repository and starting a brand-new project with Hyper-Waterfall from day one. -The stage also added the agreed adoption boundary: external project briefs can be attached as reference only, while product plans, architecture documents, and source code must not be generated during the adoption step. +After task requester review, the new-project path was revised from explanation-oriented prose into a copyable prompt for users who discussed a project idea first, created an empty repository, and want to apply Hyper-Waterfall before product work begins. + +The stage also added the agreed adoption boundary inside that prompt: external project briefs can be attached as reference only, while product plans, architecture documents, and source code must not be generated during the adoption step. ## Outputs | File | Change Summary | |---|---| -| `README.md` | Added `Existing repository` and `New project` Quick Start paths, with reference-only project brief guidance and separate first-Issue product work. | -| `README.ko.md` | Added the same Quick Start path split in Korean. | -| `README.zh-CN.md` | Added the same Quick Start path split in Simplified Chinese. | -| `mydocs/orders/20260528.md` | Updated #83 status note to Stage 1 report approval pending. | +| `README.md` | Added `Existing repository` and `New project` Quick Start paths, with a copyable new-project prompt that treats briefs as context only and moves product work to the first Issue. | +| `README.ko.md` | Added the same Quick Start path split and copyable new-project prompt in Korean. | +| `README.zh-CN.md` | Added the same Quick Start path split and copyable new-project prompt in Simplified Chinese. | +| `mydocs/orders/20260528.md` | Updated #83 status note to Stage 1 revision approval pending. | ## Text Change Scope / Losslessness The README changes are limited to the Quick Start area before the Language support section. The existing adoption prompt, agent entrypoint link, approval-gate wording, and "What the AI reports first" table were preserved in each README. +The initial new-project explanatory paragraphs were replaced with copyable prompt blocks so a user can move from project idea discussion to empty repository adoption without translating policy guidance into their own prompt. + The Language support table remains unchanged in this Stage; it is the planned Stage 2 scope. ## Validation Results @@ -31,6 +35,7 @@ Executed commands: ```bash rg -n "Existing repository|New project|project brief|product plans|source code|기존 저장소|새 프로젝트|프로젝트 기획서|제품 계획서|소스 코드|现有仓库|新项目|项目简报|产品计划|源代码" README.md README.ko.md README.zh-CN.md +rg -n "empty repository|빈 저장소|空仓库|first product task|첫 제품 작업|第一个产品任务" README.md README.ko.md README.zh-CN.md git diff --check ``` @@ -38,6 +43,8 @@ Results: - OK: `rg` found the new existing-repository and new-project headings in all three READMEs. - OK: `rg` found the reference-only brief wording and the product artifact boundary in all three READMEs. +- OK: `rg` found empty-repository and first-product-task wording in all three README prompt blocks. +- OK: The revised new-project guidance provides copyable prompt blocks in English, Korean, and Simplified Chinese. - OK: `git diff --check` completed with no whitespace errors. - OK: Manual side-by-side review confirmed the same two-path Quick Start structure across English, Korean, and Simplified Chinese READMEs. - OK: Manual review confirmed the new-project guidance does not imply product artifacts are created during adoption. From c042abeb554300c5b16abb3b5c3ad3c8dbd0a091 Mon Sep 17 00:00:00 2001 From: postmelee Date: Thu, 28 May 2026 13:34:27 +0900 Subject: [PATCH 5/8] Task #83 Stage 2: Copyable language support examples --- README.ko.md | 53 +++++++++++++++++++---- README.md | 53 +++++++++++++++++++---- README.zh-CN.md | 53 +++++++++++++++++++---- mydocs/orders/20260528.md | 2 +- mydocs/plans/task_m050_83_impl.md | 9 ++-- mydocs/working/task_m050_83_stage2.md | 60 +++++++++++++++++++++++++++ 6 files changed, 205 insertions(+), 25 deletions(-) create mode 100644 mydocs/working/task_m050_83_stage2.md diff --git a/README.ko.md b/README.ko.md index d83eb3f..c4118bf 100644 --- a/README.ko.md +++ b/README.ko.md @@ -73,15 +73,54 @@ https://github.com/postmelee/hyper-waterfall 의 하이퍼-워터폴 방법론 ### 언어 지원 -기본 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 코딩 도구로 적용할 때는 프롬프트를 사용하세요. 터미널에서 설치 없이 lifecycle 판단만 실행하려면 `npx` dry-run을 사용합니다. + +#### English + +```text +Apply the Hyper-Waterfall methodology from https://github.com/postmelee/hyper-waterfall to this repository. Use locale en. +``` + +```sh +npx hyper-waterfall@0.3.0 init --repo . --locale en --dry-run +``` + +#### 한국어 + +```text +https://github.com/postmelee/hyper-waterfall 의 하이퍼-워터폴 방법론을 이 저장소에 적용해줘. locale은 ko로 사용해줘. +``` + +```sh +npx hyper-waterfall@0.3.0 init --repo . --locale ko --dry-run +``` + +#### 중국어 간체 + +```text +将 https://github.com/postmelee/hyper-waterfall 的 Hyper-Waterfall 方法论应用到这个仓库。使用 zh-CN locale。 +``` + +```sh +npx hyper-waterfall@0.3.0 init --repo . --locale zh-CN --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에게 `"이거 구현해줘"`와 같은 자연어 명령을 내리면 됩니다. diff --git a/README.md b/README.md index bf64bd3..6aed588 100644 --- a/README.md +++ b/README.md @@ -73,15 +73,54 @@ In both paths, the AI starts from [`docs/agent-entrypoint.en.md`](docs/agent-ent ### 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` | + +Use the AI prompt when adopting Hyper-Waterfall with an AI coding tool. Use `npx` when you want to run the lifecycle judgment from a terminal without installing the CLI. + +#### English + +```text +Apply the Hyper-Waterfall methodology from https://github.com/postmelee/hyper-waterfall to this repository. Use locale en. +``` + +```sh +npx hyper-waterfall@0.3.0 init --repo . --locale en --dry-run +``` + +#### Korean + +```text +https://github.com/postmelee/hyper-waterfall 의 하이퍼-워터폴 방법론을 이 저장소에 적용해줘. locale은 ko로 사용해줘. +``` + +```sh +npx hyper-waterfall@0.3.0 init --repo . --locale ko --dry-run +``` + +#### Simplified Chinese + +```text +将 https://github.com/postmelee/hyper-waterfall 的 Hyper-Waterfall 方法论应用到这个仓库。使用 zh-CN locale。 +``` + +```sh +npx hyper-waterfall@0.3.0 init --repo . --locale zh-CN --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."` diff --git a/README.zh-CN.md b/README.zh-CN.md index 4a98515..d7d3d06 100644 --- a/README.zh-CN.md +++ b/README.zh-CN.md @@ -73,15 +73,54 @@ Hyper-Waterfall 是一种方法论 harness,它把 AI 编码绑定到 Issue、b ### 语言支持 -默认 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 编码工具导入 Hyper-Waterfall 时,请复制 prompt。想在终端中不安装 CLI、只运行 lifecycle 判断时,请使用 `npx` dry-run。 + +#### English + +```text +Apply the Hyper-Waterfall methodology from https://github.com/postmelee/hyper-waterfall to this repository. Use locale en. +``` + +```sh +npx hyper-waterfall@0.3.0 init --repo . --locale en --dry-run +``` + +#### 韩语 + +```text +https://github.com/postmelee/hyper-waterfall 의 하이퍼-워터폴 방법론을 이 저장소에 적용해줘. locale은 ko로 사용해줘. +``` + +```sh +npx hyper-waterfall@0.3.0 init --repo . --locale ko --dry-run +``` + +#### 简体中文 + +```text +将 https://github.com/postmelee/hyper-waterfall 的 Hyper-Waterfall 方法论应用到这个仓库。使用 zh-CN locale。 +``` + +```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,例如 `"请实现这个功能"`。 diff --git a/mydocs/orders/20260528.md b/mydocs/orders/20260528.md index b7f01c5..01e4409 100644 --- a/mydocs/orders/20260528.md +++ b/mydocs/orders/20260528.md @@ -6,4 +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 | 진행중 | M050, Stage 1 revision approval pending | +| #83 | README Quick Start and Language support guidance | 진행중 | M050, Stage 2 report approval pending | diff --git a/mydocs/plans/task_m050_83_impl.md b/mydocs/plans/task_m050_83_impl.md index 7f16f69..9fcdbb7 100644 --- a/mydocs/plans/task_m050_83_impl.md +++ b/mydocs/plans/task_m050_83_impl.md @@ -95,7 +95,8 @@ Modified: - Replace the long Language support prompt/CLI table with: - A compact supported-locale table. - Per-language copyable prompt blocks. - - Per-language copyable CLI dry-run blocks. + - Per-language copyable `npx` CLI dry-run blocks. + - A short Homebrew install path for macOS users who run the CLI often. - Preserve the supported locale list exactly: `en`, `ko`, `zh-CN`. - Keep commands structurally unchanged: - `npx hyper-waterfall@0.3.0 init --repo . --locale en --dry-run` @@ -103,11 +104,12 @@ Modified: - `npx hyper-waterfall@0.3.0 init --repo . --locale zh-CN --dry-run` - Keep language-specific prompt text localized, with locale codes unchanged. - Preserve the statement that CLI dry-run prints lifecycle judgment only and actual file changes still require approval. +- Present `npx` and Homebrew as lifecycle judgment execution channels, not as automatic adoption or file-application buttons. ### Validation ```bash -rg -n "Language support|언어 지원|语言支持|Supported locale|지원 locale|支持的 locale|npx hyper-waterfall@0.3.0 init --repo \\. --locale" README.md README.ko.md README.zh-CN.md +rg -n "Language support|언어 지원|语言支持|Supported locale|지원 locale|支持的 locale|npx hyper-waterfall@0.3.0 init --repo \\. --locale|brew install postmelee/tap/hyper-waterfall|hyper-waterfall init --repo \\. --locale" README.md README.ko.md README.zh-CN.md rg -n "locale en|locale은 ko|使用 zh-CN locale|--locale en|--locale ko|--locale zh-CN" README.md README.ko.md README.zh-CN.md git diff --check ``` @@ -115,7 +117,8 @@ git diff --check Manual validation: - Confirm each README has copyable fenced code blocks for English, Korean, and Simplified Chinese prompts. -- Confirm each README has copyable fenced `sh` blocks for all three CLI dry-run commands. +- Confirm each README has copyable fenced `sh` blocks for all three `npx` CLI dry-run commands. +- Confirm each README has a Homebrew install example and an installed CLI dry-run example. - Confirm the summary table remains short enough to scan. ### Commit diff --git a/mydocs/working/task_m050_83_stage2.md b/mydocs/working/task_m050_83_stage2.md new file mode 100644 index 0000000..0bb432c --- /dev/null +++ b/mydocs/working/task_m050_83_stage2.md @@ -0,0 +1,60 @@ +# Task M050 #83 Stage 2 Report + +GitHub Issue: [#83](https://github.com/postmelee/hyper-waterfall/issues/83) +Implementation plan: [`task_m050_83_impl.md`](../plans/task_m050_83_impl.md) +Stage: 2 + +## Stage Purpose + +Stage 2 replaced the long Language support table with a more copyable structure: a compact locale table, language-specific AI prompt blocks, language-specific `npx` dry-run blocks, and a short Homebrew install path for macOS users who run the CLI often. + +This stage also incorporated the task requester's decision that `npx` and Homebrew should be visible near Quick Start, while still being described as lifecycle judgment execution channels rather than automatic adoption or file-application buttons. + +## Outputs + +| File | Change Summary | +|---|---| +| `README.md` | Reworked Language support into locale summary, copyable prompt blocks, `npx` dry-run blocks, and Homebrew CLI example. | +| `README.ko.md` | Applied the same Language support structure in Korean. | +| `README.zh-CN.md` | Applied the same Language support structure in Simplified Chinese. | +| `mydocs/plans/task_m050_83_impl.md` | Updated Stage 2 plan text and validation to include Homebrew guidance. | +| `mydocs/orders/20260528.md` | Updated #83 status note to Stage 2 report approval pending. | + +## Text Change Scope / Losslessness + +The README changes are limited to the Language support section. The supported locale list remains `en`, `ko`, and `zh-CN`. + +The existing lower README details about CLI and distribution channels remain in place. The new Quick Start-adjacent Homebrew mention is intentionally short and points only to the common install and dry-run path. + +The CLI boundary was preserved: `npx` and Homebrew commands print lifecycle judgment only, and actual file changes still require approval. + +## Validation Results + +Executed commands: + +```bash +rg -n "Language support|언어 지원|语言支持|Supported locale|지원 locale|支持的 locale|npx hyper-waterfall@0.3.0 init --repo \\. --locale|brew install postmelee/tap/hyper-waterfall|hyper-waterfall init --repo \\. --locale" README.md README.ko.md README.zh-CN.md +rg -n "locale en|locale은 ko|使用 zh-CN locale|--locale en|--locale ko|--locale zh-CN" README.md README.ko.md README.zh-CN.md +git diff --check +``` + +Results: + +- OK: `rg` found Language support headings in all three README files. +- OK: `rg` found all three `npx hyper-waterfall@0.3.0 init --repo . --locale ... --dry-run` commands in all three README files. +- OK: `rg` found `brew install postmelee/tap/hyper-waterfall` and installed `hyper-waterfall init --repo . --locale ... --dry-run` examples in all three README files. +- OK: locale prompt strings and `--locale en`, `--locale ko`, `--locale zh-CN` command examples were found. +- OK: `git diff --check` completed with no whitespace errors. +- OK: Manual review confirmed the three README Language support sections share the same structure. + +## Residual Risk + +- The lower README "CLI and Distribution Channels" section still contains detailed `npx` and Homebrew examples, so the README now has both quick copy examples and maintainer/detail examples. This is intentional, but Stage 3 should check that the two locations do not contradict each other. + +## Next Stage Impact + +- Stage 3 should verify cross-locale section order, entrypoint links, command consistency, and duplication boundaries between the Quick Start Language support section and the lower CLI/distribution detail section. + +## Approval Request + +- Approve the Stage 2 Language support structure and validation results to proceed to Stage 3. From 9d990607542e8b670ce646c325ac0f793032d2b1 Mon Sep 17 00:00:00 2001 From: postmelee Date: Thu, 28 May 2026 13:48:14 +0900 Subject: [PATCH 6/8] Task #83 [Stage 2.1]: Compact language support guidance --- README.ko.md | 28 ++------------------------- README.md | 28 ++------------------------- README.zh-CN.md | 28 ++------------------------- mydocs/orders/20260528.md | 2 +- mydocs/plans/task_m050_83_impl.md | 21 ++++++++++---------- mydocs/working/task_m050_83_stage2.md | 26 ++++++++++++++----------- 6 files changed, 32 insertions(+), 101 deletions(-) diff --git a/README.ko.md b/README.ko.md index c4118bf..b8f2d57 100644 --- a/README.ko.md +++ b/README.ko.md @@ -81,38 +81,14 @@ https://github.com/postmelee/hyper-waterfall 의 하이퍼-워터폴 방법론 | 한국어 | `ko` | | 중국어 간체 | `zh-CN` | -AI 코딩 도구로 적용할 때는 프롬프트를 사용하세요. 터미널에서 설치 없이 lifecycle 판단만 실행하려면 `npx` dry-run을 사용합니다. +AI 코딩 도구를 사용할 때는 원하는 언어로 지시하세요. AI는 파일 변경 전 선택 locale을 먼저 보고합니다. -#### English - -```text -Apply the Hyper-Waterfall methodology from https://github.com/postmelee/hyper-waterfall to this repository. Use locale en. -``` - -```sh -npx hyper-waterfall@0.3.0 init --repo . --locale en --dry-run -``` - -#### 한국어 - -```text -https://github.com/postmelee/hyper-waterfall 의 하이퍼-워터폴 방법론을 이 저장소에 적용해줘. locale은 ko로 사용해줘. -``` +터미널에서 적용 판단을 확인하려면 locale을 명시해 실행하세요. 필요하면 `ko`를 `en` 또는 `zh-CN`으로 바꾸면 됩니다. ```sh npx hyper-waterfall@0.3.0 init --repo . --locale ko --dry-run ``` -#### 중국어 간체 - -```text -将 https://github.com/postmelee/hyper-waterfall 的 Hyper-Waterfall 方法论应用到这个仓库。使用 zh-CN locale。 -``` - -```sh -npx hyper-waterfall@0.3.0 init --repo . --locale zh-CN --dry-run -``` - macOS에서 자주 실행한다면 Homebrew로 CLI를 설치할 수 있습니다. ```sh diff --git a/README.md b/README.md index 6aed588..579a973 100644 --- a/README.md +++ b/README.md @@ -81,38 +81,14 @@ The default locale is `en`. Supported locale packs are `en`, `ko`, and `zh-CN`; | Korean | `ko` | | Simplified Chinese | `zh-CN` | -Use the AI prompt when adopting Hyper-Waterfall with an AI coding tool. Use `npx` when you want to run the lifecycle judgment from a terminal without installing the CLI. +When using an AI coding tool, ask in the language you want to use. The AI reports the selected locale before changing files. -#### English - -```text -Apply the Hyper-Waterfall methodology from https://github.com/postmelee/hyper-waterfall to this repository. Use locale en. -``` +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 ``` -#### Korean - -```text -https://github.com/postmelee/hyper-waterfall 의 하이퍼-워터폴 방법론을 이 저장소에 적용해줘. locale은 ko로 사용해줘. -``` - -```sh -npx hyper-waterfall@0.3.0 init --repo . --locale ko --dry-run -``` - -#### Simplified Chinese - -```text -将 https://github.com/postmelee/hyper-waterfall 的 Hyper-Waterfall 方法论应用到这个仓库。使用 zh-CN locale。 -``` - -```sh -npx hyper-waterfall@0.3.0 init --repo . --locale zh-CN --dry-run -``` - On macOS, install the CLI with Homebrew if you run it often. ```sh diff --git a/README.zh-CN.md b/README.zh-CN.md index d7d3d06..b893be8 100644 --- a/README.zh-CN.md +++ b/README.zh-CN.md @@ -81,33 +81,9 @@ Hyper-Waterfall 是一种方法论 harness,它把 AI 编码绑定到 Issue、b | 韩语 | `ko` | | 简体中文 | `zh-CN` | -使用 AI 编码工具导入 Hyper-Waterfall 时,请复制 prompt。想在终端中不安装 CLI、只运行 lifecycle 判断时,请使用 `npx` dry-run。 +使用 AI 编码工具时,请用你想使用的语言提出请求。AI 会在修改文件前先报告选择的 locale。 -#### English - -```text -Apply the Hyper-Waterfall methodology from https://github.com/postmelee/hyper-waterfall to this repository. Use locale en. -``` - -```sh -npx hyper-waterfall@0.3.0 init --repo . --locale en --dry-run -``` - -#### 韩语 - -```text -https://github.com/postmelee/hyper-waterfall 의 하이퍼-워터폴 방법론을 이 저장소에 적용해줘. locale은 ko로 사용해줘. -``` - -```sh -npx hyper-waterfall@0.3.0 init --repo . --locale ko --dry-run -``` - -#### 简体中文 - -```text -将 https://github.com/postmelee/hyper-waterfall 的 Hyper-Waterfall 方法论应用到这个仓库。使用 zh-CN locale。 -``` +要在终端中检查应用判断,请显式传入 locale。需要时可以把 `zh-CN` 替换为 `en` 或 `ko`。 ```sh npx hyper-waterfall@0.3.0 init --repo . --locale zh-CN --dry-run diff --git a/mydocs/orders/20260528.md b/mydocs/orders/20260528.md index 01e4409..d8f7eff 100644 --- a/mydocs/orders/20260528.md +++ b/mydocs/orders/20260528.md @@ -6,4 +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 | 진행중 | M050, Stage 2 report approval pending | +| #83 | README Quick Start and Language support guidance | 진행중 | M050, Stage 2 revision approval pending | diff --git a/mydocs/plans/task_m050_83_impl.md b/mydocs/plans/task_m050_83_impl.md index 9fcdbb7..c1b95f8 100644 --- a/mydocs/plans/task_m050_83_impl.md +++ b/mydocs/plans/task_m050_83_impl.md @@ -94,30 +94,29 @@ Modified: - Replace the long Language support prompt/CLI table with: - A compact supported-locale table. - - Per-language copyable prompt blocks. - - Per-language copyable `npx` CLI dry-run blocks. + - A short note that AI coding tool users can ask in their desired language and that the AI reports selected locale before changing files. + - A single localized `npx` CLI dry-run example. - A short Homebrew install path for macOS users who run the CLI often. - Preserve the supported locale list exactly: `en`, `ko`, `zh-CN`. -- Keep commands structurally unchanged: - - `npx hyper-waterfall@0.3.0 init --repo . --locale en --dry-run` - - `npx hyper-waterfall@0.3.0 init --repo . --locale ko --dry-run` - - `npx hyper-waterfall@0.3.0 init --repo . --locale zh-CN --dry-run` -- Keep language-specific prompt text localized, with locale codes unchanged. +- Keep command structure unchanged: + - `npx hyper-waterfall@0.3.0 init --repo . --locale {locale} --dry-run` + - `hyper-waterfall init --repo . --locale {locale} --dry-run` - Preserve the statement that CLI dry-run prints lifecycle judgment only and actual file changes still require approval. - Present `npx` and Homebrew as lifecycle judgment execution channels, not as automatic adoption or file-application buttons. ### Validation ```bash -rg -n "Language support|언어 지원|语言支持|Supported locale|지원 locale|支持的 locale|npx hyper-waterfall@0.3.0 init --repo \\. --locale|brew install postmelee/tap/hyper-waterfall|hyper-waterfall init --repo \\. --locale" README.md README.ko.md README.zh-CN.md -rg -n "locale en|locale은 ko|使用 zh-CN locale|--locale en|--locale ko|--locale zh-CN" README.md README.ko.md README.zh-CN.md +rg -n "Language support|언어 지원|语言支持|npx hyper-waterfall@0.3.0 init --repo \\. --locale|brew install postmelee/tap/hyper-waterfall|hyper-waterfall init --repo \\. --locale" README.md README.ko.md README.zh-CN.md +rg -n "selected locale|선택 locale|选择的 locale|--locale en|--locale ko|--locale zh-CN" README.md README.ko.md README.zh-CN.md +bash -lc 'if rg -n "Use locale en|locale은 ko로 사용해줘|使用 zh-CN locale" README.md README.ko.md README.zh-CN.md; then exit 1; fi' git diff --check ``` Manual validation: -- Confirm each README has copyable fenced code blocks for English, Korean, and Simplified Chinese prompts. -- Confirm each README has copyable fenced `sh` blocks for all three `npx` CLI dry-run commands. +- Confirm no repeated per-language AI prompt blocks remain in the Language support section. +- Confirm each README has one localized `npx` CLI dry-run example. - Confirm each README has a Homebrew install example and an installed CLI dry-run example. - Confirm the summary table remains short enough to scan. diff --git a/mydocs/working/task_m050_83_stage2.md b/mydocs/working/task_m050_83_stage2.md index 0bb432c..c61a3f6 100644 --- a/mydocs/working/task_m050_83_stage2.md +++ b/mydocs/working/task_m050_83_stage2.md @@ -6,24 +6,26 @@ Stage: 2 ## Stage Purpose -Stage 2 replaced the long Language support table with a more copyable structure: a compact locale table, language-specific AI prompt blocks, language-specific `npx` dry-run blocks, and a short Homebrew install path for macOS users who run the CLI often. +Stage 2 replaced the long Language support table with a compact locale table, a short AI-language-selection note, a single localized `npx` dry-run example, and a short Homebrew install path for macOS users who run the CLI often. -This stage also incorporated the task requester's decision that `npx` and Homebrew should be visible near Quick Start, while still being described as lifecycle judgment execution channels rather than automatic adoption or file-application buttons. +After task requester review, the section was revised again to remove repeated per-language AI prompt blocks. The assumption is that when users ask an AI coding tool in their desired language, the AI can select and report the locale before file changes. `npx` and Homebrew remain visible near Quick Start, but only as lifecycle judgment execution channels rather than automatic adoption or file-application buttons. ## Outputs | File | Change Summary | |---|---| -| `README.md` | Reworked Language support into locale summary, copyable prompt blocks, `npx` dry-run blocks, and Homebrew CLI example. | -| `README.ko.md` | Applied the same Language support structure in Korean. | -| `README.zh-CN.md` | Applied the same Language support structure in Simplified Chinese. | -| `mydocs/plans/task_m050_83_impl.md` | Updated Stage 2 plan text and validation to include Homebrew guidance. | -| `mydocs/orders/20260528.md` | Updated #83 status note to Stage 2 report approval pending. | +| `README.md` | Reworked Language support into locale summary, AI-language-selection note, one `npx` dry-run example, and Homebrew CLI example. | +| `README.ko.md` | Applied the same compact Language support structure in Korean. | +| `README.zh-CN.md` | Applied the same compact Language support structure in Simplified Chinese. | +| `mydocs/plans/task_m050_83_impl.md` | Updated Stage 2 plan text and validation to remove repeated AI prompt blocks and include Homebrew guidance. | +| `mydocs/orders/20260528.md` | Updated #83 status note to Stage 2 revision approval pending. | ## Text Change Scope / Losslessness The README changes are limited to the Language support section. The supported locale list remains `en`, `ko`, and `zh-CN`. +Repeated AI prompt examples were removed from this section. The main Quick Start prompt remains the primary prompt example, and Language support now explains locale behavior without duplicating natural-language prompts. + The existing lower README details about CLI and distribution channels remain in place. The new Quick Start-adjacent Homebrew mention is intentionally short and points only to the common install and dry-run path. The CLI boundary was preserved: `npx` and Homebrew commands print lifecycle judgment only, and actual file changes still require approval. @@ -33,17 +35,19 @@ The CLI boundary was preserved: `npx` and Homebrew commands print lifecycle judg Executed commands: ```bash -rg -n "Language support|언어 지원|语言支持|Supported locale|지원 locale|支持的 locale|npx hyper-waterfall@0.3.0 init --repo \\. --locale|brew install postmelee/tap/hyper-waterfall|hyper-waterfall init --repo \\. --locale" README.md README.ko.md README.zh-CN.md -rg -n "locale en|locale은 ko|使用 zh-CN locale|--locale en|--locale ko|--locale zh-CN" README.md README.ko.md README.zh-CN.md +rg -n "Language support|언어 지원|语言支持|npx hyper-waterfall@0.3.0 init --repo \\. --locale|brew install postmelee/tap/hyper-waterfall|hyper-waterfall init --repo \\. --locale" README.md README.ko.md README.zh-CN.md +rg -n "selected locale|선택 locale|选择的 locale|--locale en|--locale ko|--locale zh-CN" README.md README.ko.md README.zh-CN.md +bash -lc 'if rg -n "Use locale en|locale은 ko로 사용해줘|使用 zh-CN locale" README.md README.ko.md README.zh-CN.md; then exit 1; fi' git diff --check ``` Results: - OK: `rg` found Language support headings in all three README files. -- OK: `rg` found all three `npx hyper-waterfall@0.3.0 init --repo . --locale ... --dry-run` commands in all three README files. +- OK: `rg` found localized `npx hyper-waterfall@0.3.0 init --repo . --locale ... --dry-run` commands in all three README files. - OK: `rg` found `brew install postmelee/tap/hyper-waterfall` and installed `hyper-waterfall init --repo . --locale ... --dry-run` examples in all three README files. -- OK: locale prompt strings and `--locale en`, `--locale ko`, `--locale zh-CN` command examples were found. +- OK: selected-locale wording and `--locale en`, `--locale ko`, `--locale zh-CN` command examples were found. +- OK: negative search confirmed repeated locale-specific natural-language prompt strings are no longer present in the README files. - OK: `git diff --check` completed with no whitespace errors. - OK: Manual review confirmed the three README Language support sections share the same structure. From f3c3204c104c8cae62a92288a67818c210203626 Mon Sep 17 00:00:00 2001 From: postmelee Date: Thu, 28 May 2026 13:50:32 +0900 Subject: [PATCH 7/8] Task #83 Stage 3: README locale consistency polish --- mydocs/orders/20260528.md | 2 +- mydocs/working/task_m050_83_stage3.md | 60 +++++++++++++++++++++++++++ 2 files changed, 61 insertions(+), 1 deletion(-) create mode 100644 mydocs/working/task_m050_83_stage3.md diff --git a/mydocs/orders/20260528.md b/mydocs/orders/20260528.md index d8f7eff..64d9e88 100644 --- a/mydocs/orders/20260528.md +++ b/mydocs/orders/20260528.md @@ -6,4 +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 | 진행중 | M050, Stage 2 revision approval pending | +| #83 | README Quick Start and Language support guidance | 진행중 | M050, Stage 3 report approval pending | diff --git a/mydocs/working/task_m050_83_stage3.md b/mydocs/working/task_m050_83_stage3.md new file mode 100644 index 0000000..74d7292 --- /dev/null +++ b/mydocs/working/task_m050_83_stage3.md @@ -0,0 +1,60 @@ +# Task M050 #83 Stage 3 Report + +GitHub Issue: [#83](https://github.com/postmelee/hyper-waterfall/issues/83) +Implementation plan: [`task_m050_83_impl.md`](../plans/task_m050_83_impl.md) +Stage: 3 + +## Stage Purpose + +Stage 3 verified cross-locale consistency after the Quick Start and Language support revisions. The focus was not to expand README content, but to confirm that the English, Korean, and Simplified Chinese READMEs keep the same structure, correct entrypoint links, consistent command examples, and clear adoption/product-work boundaries. + +## Outputs + +| File | Change Summary | +|---|---| +| `README.md` | Reviewed; no Stage 3 text change required. | +| `README.ko.md` | Reviewed; no Stage 3 text change required. | +| `README.zh-CN.md` | Reviewed; no Stage 3 text change required. | +| `mydocs/orders/20260528.md` | Updated #83 status note to Stage 3 report approval pending. | + +## Text Change Scope / Losslessness + +No README body changes were needed in Stage 3. Stage 1 and Stage 2 changes remain intact: + +- Quick Start keeps separate existing-repository and new-project paths. +- The new-project path uses copyable prompt blocks and treats attached briefs as reference only. +- Language support stays compact: locale table, AI-language-selection note, one localized `npx` dry-run example, and one Homebrew example. +- The lower CLI/distribution details remain as the maintainer/detail section and do not contradict the compact Language support examples. + +## Validation Results + +Executed commands: + +```bash +rg -n "Existing repository|New project|Language support|언어 지원|语言支持|새 프로젝트|新项目|npx hyper-waterfall@0.3.0" README.md README.ko.md README.zh-CN.md +rg -n "docs/agent-entrypoint\\.en\\.md|docs/agent-entrypoint\\.md|docs/agent-entrypoint\\.zh-CN\\.md" README.md README.ko.md README.zh-CN.md +rg -n "product plans|architecture documents|source code|제품 계획서|아키텍처 문서|소스 코드|产品计划|架构文档|源代码" README.md README.ko.md README.zh-CN.md +git diff --check +``` + +Results: + +- OK: Quick Start and Language support headings were found in the expected localized README files. +- OK: `npx hyper-waterfall@0.3.0` examples were found in the compact Language support section and lower CLI detail section. +- OK: localized entrypoint links point to `docs/agent-entrypoint.en.md`, `docs/agent-entrypoint.md`, and `docs/agent-entrypoint.zh-CN.md`. +- OK: adoption/product-work boundary wording is present in the new-project prompt blocks in all three README files. +- OK: `git diff --check` completed with no whitespace errors. +- OK: Manual review confirmed the changed section order is aligned across the three README files. +- OK: Manual review confirmed no unrelated README sections were rewritten in Stage 3. + +## Residual Risk + +- None for the README guidance changed by this task. + +## Next Stage Impact + +- The task is ready for final reporting. The final report should summarize Stage 1, Stage 1.1, Stage 2, Stage 2.1, and Stage 3, then verify that the final README guidance reflects the thread decisions. + +## Approval Request + +- Approve the Stage 3 validation results to proceed to the final report stage. From fc2860adfc302a0c5f0b697f38a467f5f25ead20 Mon Sep 17 00:00:00 2001 From: postmelee Date: Thu, 28 May 2026 13:52:50 +0900 Subject: [PATCH 8/8] Task #83: final report and todo completion --- mydocs/orders/20260528.md | 2 +- mydocs/report/task_m050_83_report.md | 117 +++++++++++++++++++++++++++ 2 files changed, 118 insertions(+), 1 deletion(-) create mode 100644 mydocs/report/task_m050_83_report.md diff --git a/mydocs/orders/20260528.md b/mydocs/orders/20260528.md index 64d9e88..c2163f8 100644 --- a/mydocs/orders/20260528.md +++ b/mydocs/orders/20260528.md @@ -6,4 +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 | 진행중 | M050, Stage 3 report approval pending | +| #83 | README Quick Start and Language support guidance | 완료 | 완료: 13:51, final report written and PR publication approval pending | diff --git a/mydocs/report/task_m050_83_report.md b/mydocs/report/task_m050_83_report.md new file mode 100644 index 0000000..0912eb8 --- /dev/null +++ b/mydocs/report/task_m050_83_report.md @@ -0,0 +1,117 @@ +# Task M050 #83 Final Report + +GitHub Issue: [#83](https://github.com/postmelee/hyper-waterfall/issues/83) +Milestone: M050 + +## Work Summary + +- Target issue: #83 +- Milestone: M050 +- Stage count: 3 primary stages plus two approved revision commits +- Purpose: clarify README onboarding for new-project adoption and make Language support easier to scan and copy without bloating the Quick Start area. + +## Changed Files and Impact + +| Path | Change Summary | Impact | +|---|---|---| +| `README.md` | Split Quick Start into existing-repository and new-project paths; added a copyable new-project prompt; compacted Language support with locale table, localized `npx` example, and Homebrew example. | English user onboarding. | +| `README.ko.md` | Applied the same Quick Start and compact Language support structure in Korean. | Korean user onboarding. | +| `README.zh-CN.md` | Applied the same Quick Start and compact Language support structure in Simplified Chinese. | Simplified Chinese user onboarding. | +| `mydocs/plans/task_m050_83.md` | Added English task plan. | Task traceability. | +| `mydocs/plans/task_m050_83_impl.md` | Added implementation plan and revised Stage 2 scope after requester feedback. | Stage execution contract. | +| `mydocs/working/task_m050_83_stage1.md` | Recorded Quick Start path split and Stage 1.1 new-project prompt revision. | Stage audit trail. | +| `mydocs/working/task_m050_83_stage2.md` | Recorded Language support restructure and Stage 2.1 compacting revision. | Stage audit trail. | +| `mydocs/working/task_m050_83_stage3.md` | Recorded cross-locale consistency validation. | Stage audit trail. | +| `mydocs/orders/20260528.md` | Tracked #83 from planning through final report approval. | Daily task board. | + +## Document Location Verification + +| File | Planned Location | Actual Location | Result | Evidence | +|---|---|---|---|---| +| `README.md` | Repository root | Repository root | OK | Task plan document location decision. | +| `README.ko.md` | Repository root | Repository root | OK | Existing localized README mirror. | +| `README.zh-CN.md` | Repository root | Repository root | OK | Existing localized README mirror. | +| `mydocs/plans/task_m050_83.md` | `mydocs/plans/` | `mydocs/plans/` | OK | Task-start artifact. | +| `mydocs/plans/task_m050_83_impl.md` | `mydocs/plans/` | `mydocs/plans/` | OK | Implementation plan artifact. | +| `mydocs/working/task_m050_83_stage{N}.md` | `mydocs/working/` | `mydocs/working/` | OK | Stage report artifacts. | +| `mydocs/report/task_m050_83_report.md` | `mydocs/report/` | `mydocs/report/` | OK | Final report artifact. | + +## Before/After Quantitative Comparison + +| Metric | Before | After | +|---|---:|---:| +| `README.md` line count | 676 | 705 | +| `README.ko.md` line count | 657 | 686 | +| `README.zh-CN.md` line count | 676 | 705 | +| Files changed from `main` | 0 | 9 | +| Net diff from `main` | 0 | 654 insertions, 24 deletions | +| Stage reports | 0 | 3 | +| Validation command groups recorded | 0 | 5 | + +## Acceptance Criteria Verification + +| Acceptance Criteria | Result | +|---|---| +| README Quick Start separates existing-repository adoption from new-project adoption. | OK — all three READMEs have localized existing/new project paths. | +| New-project guidance starts from an empty repository before product code and product documents. | OK — new-project prompt blocks in all three READMEs start from an empty repository. | +| Project briefs are reference-only material during adoption. | OK — prompt blocks explicitly say briefs/requirements are context/reference only. | +| Adoption is not presented as creating product plans, architecture documents, or source code. | OK — prompt blocks explicitly prohibit those artifacts during adoption. | +| The first product task is handled as a separate GitHub Issue after adoption. | OK — prompt blocks ask the AI to help register the first product task as a separate Issue after adoption. | +| Language support keeps a compact locale overview. | OK — long prompt table was reduced to a locale table and short guidance. | +| Language support provides practical CLI entry points without repeated AI prompt blocks. | OK — each README has one localized `npx` example and one Homebrew installed CLI example. | +| English, Korean, and Simplified Chinese READMEs remain structurally aligned. | OK — Stage 3 cross-locale validation passed. | + +## Validation Results + +### Stage Validation Results + +- Stage 1: [task_m050_83_stage1.md](../working/task_m050_83_stage1.md) + - Verified new existing-repository and new-project headings. + - Verified reference-only brief wording and product artifact boundaries. + - Verified copyable new-project prompts across all three locales. +- Stage 2: [task_m050_83_stage2.md](../working/task_m050_83_stage2.md) + - Verified compact Language support headings. + - Verified localized `npx` and Homebrew CLI examples. + - Verified repeated locale-specific natural-language prompt strings were removed from Language support. +- Stage 3: [task_m050_83_stage3.md](../working/task_m050_83_stage3.md) + - Verified cross-locale section order, entrypoint links, command consistency, and adoption/product-work boundary wording. + +### Integrated Validation + +Executed commands: + +```bash +rg -n "Existing repository|New project|Language support|언어 지원|语言支持|새 프로젝트|新项目|npx hyper-waterfall@0.3.0" README.md README.ko.md README.zh-CN.md +rg -n "docs/agent-entrypoint\\.en\\.md|docs/agent-entrypoint\\.md|docs/agent-entrypoint\\.zh-CN\\.md" README.md README.ko.md README.zh-CN.md +rg -n "product plans|architecture documents|source code|제품 계획서|아키텍처 문서|소스 코드|产品计划|架构文档|源代码" README.md README.ko.md README.zh-CN.md +rg -n "Language support|언어 지원|语言支持|npx hyper-waterfall@0.3.0 init --repo \\. --locale|brew install postmelee/tap/hyper-waterfall|hyper-waterfall init --repo \\. --locale" README.md README.ko.md README.zh-CN.md +bash -lc 'if rg -n "Use locale en|locale은 ko로 사용해줘|使用 zh-CN locale" README.md README.ko.md README.zh-CN.md; then exit 1; fi' +git diff --check +``` + +Results: + +- OK: Quick Start, Language support, and `npx` examples were found in the expected README files. +- OK: localized agent entrypoint links were found for English, Korean, and Simplified Chinese. +- OK: product plan, architecture document, and source code boundaries were found in the new-project prompts. +- OK: `npx` and Homebrew CLI examples were found in all three README files. +- OK: negative search confirmed repeated locale-specific natural-language prompt strings are absent. +- OK: `git diff --check` passed. + +## Residual Risks and Follow-Up Work + +### Residual Risks + +- None for the README guidance changed by this task. + +### Follow-Up Candidates + +- None required. A future UX pass can revisit the lower CLI/distribution details if README length becomes a separate concern. + +## Task Requester Approval Request + +- Approve this final report and acceptance criteria verification. +- After approval, proceed with PR publication: + - push `local/task83` to `publish/task83` + - create a ready PR against `main` + - include stage links, commit links, work document links, validation summary, and residual risk summary in the PR body.