no-mistakes(document): Sync onboard documentation
This commit is contained in:
Jeremy McSpadden
committed by
Codesmith
Codesmith
parent
b006b1a23e
commit
a3cca0704d
@@ -51,6 +51,25 @@ v1.40 中，六个命名空间路由器作为第一阶段入口点随附发布
|
||||
|
||||
---
|
||||
|
||||
### `/gsd-onboard`
|
||||
|
||||
引导现有代码库完成首次 GSD 接入。该命令检查仓库状态，安全地转到代码库映射、可选文档摄取、项目初始化，并在规划文件齐备后创建 onboarding summary。
|
||||
|
||||
| 标志 | 描述 |
|
||||
|------|-------------|
|
||||
| `--fast` | 优先使用轻量 `/gsd-map-codebase --fast` 映射交接 |
|
||||
| `--text` | 使用编号纯文本关卡，而不是 TUI 菜单 |
|
||||
|
||||
**前提条件：** 现有仓库或规划文档。空的绿地项目请使用 `/gsd-new-project`。
|
||||
**产出：** 由 map-codebase 生成的 `.planning/codebase/`，由 new-project 或 ingest-docs 生成的 `.planning/`，以及项目设置后的 `.planning/onboarding/SUMMARY.md`。
|
||||
|
||||
```bash
|
||||
/gsd-onboard # 引导式 brownfield 接入
|
||||
/gsd-onboard --fast # 先使用轻量代码库映射
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### `/gsd-workspace`
|
||||
|
||||
管理 GSD 工作区 — 创建、列出或移除隔离的工作区环境，包含仓库副本和独立的 `.planning/` 目录。
|
||||
|
||||
@@ -38,6 +38,7 @@
|
||||
- [模型配置](#26-model-profiles)
|
||||
- [棕地功能](#brownfield-features)
|
||||
- [代码库映射](#27-codebase-mapping)
|
||||
- [现有代码库接入](#27b-现有代码库接入)
|
||||
- [实用功能](#utility-features)
|
||||
- [调试系统](#28-debug-system)
|
||||
- [待办事项管理](#29-todo-management)
|
||||
@@ -783,7 +784,7 @@
|
||||
|
||||
**命令：** `/gsd-map-codebase [area]`
|
||||
|
||||
**目的：** 在启动新项目之前分析现有代码库，使 GSD 了解已有内容。
|
||||
**目的：** 在启动新项目之前，或作为 `/gsd-onboard` 的映射交接，分析现有代码库，使 GSD 了解已有内容。
|
||||
|
||||
**需求：**
|
||||
- REQ-MAP-01：系统必须为每个分析领域派生并行映射智能体
|
||||
@@ -805,6 +806,19 @@
|
||||
|
||||
**增量重映射 — `--paths` (#2003)：** 映射器接受可选的 `--paths <p1,p2,...>` 范围提示。提供时，它将探索限制在列出的仓库相对前缀，而非扫描整个代码树。这是执行后代码库漂移门控用于仅刷新阶段实际修改的子树的路径。每个生成的文档在其 YAML 前置元数据中携带 `last_mapped_commit`，以便相对于映射点（而非 HEAD）来测量漂移。
|
||||
|
||||
### 27b. 现有代码库接入
|
||||
|
||||
**命令：** `/gsd-onboard [--fast] [--text]`
|
||||
|
||||
**目的：** 引导现有仓库完成首次设置，检查 brownfield 状态，并安全交接到代码库映射、docs 摄取和项目初始化。
|
||||
|
||||
**需求：**
|
||||
- REQ-ONBOARD-01：系统必须检测现有代码、package manifest、规划文档、部分 `.planning/` 状态以及缺失的代码库映射文件。
|
||||
- REQ-ONBOARD-02：当 brownfield 缺少完整 `.planning/codebase/` 时，系统必须交接到 `/gsd-map-codebase` 或 `/gsd-map-codebase --fast`。
|
||||
- REQ-ONBOARD-03：当存在 ADR/PRD/SPEC/RFC 候选且 project 不存在时，系统必须在 `/gsd-new-project` 前提供 `/gsd-ingest-docs`。
|
||||
- REQ-ONBOARD-04：在 `PROJECT.md`、`REQUIREMENTS.md`、`ROADMAP.md`、`STATE.md` 全部存在前，系统不得报告 onboarding 完成。
|
||||
- REQ-ONBOARD-05：系统必须仅在 project setup 后创建或确认 `.planning/onboarding/SUMMARY.md`。
|
||||
|
||||
### 27a. 执行后代码库漂移检测
|
||||
|
||||
**引入版本：** #2003
|
||||
|
||||
@@ -78,6 +78,7 @@
|
||||
| 命令 | 角色 | 源文件 |
|
||||
|------|------|--------|
|
||||
| `/gsd-new-project` | 通过深度上下文收集和 PROJECT.md 初始化新项目。 | [commands/gsd/new-project.md](../../commands/gsd/new-project.md) |
|
||||
| `/gsd-onboard` | 引导现有代码库完成映射、文档摄取、项目设置和 onboarding summary。 | [commands/gsd/onboard.md](../../commands/gsd/onboard.md) |
|
||||
| `/gsd-workspace` | 管理 GSD 工作区 — 创建（`--new`）、列出（`--list`）或移除（`--remove`）隔离的工作区环境。 | [commands/gsd/workspace.md](../../commands/gsd/workspace.md) |
|
||||
| `/gsd-discuss-phase` | 在规划前通过自适应提问收集阶段上下文。 | [commands/gsd/discuss-phase.md](../../commands/gsd/discuss-phase.md) |
|
||||
| `/gsd-mvp-phase` | 将阶段规划为垂直 MVP 切片 — 用户故事、SPIDR 拆分，然后进行阶段规划。 | [commands/gsd/mvp-phase.md](../../commands/gsd/mvp-phase.md) |
|
||||
@@ -218,6 +219,7 @@
|
||||
| `milestone-summary.md` | 里程碑摘要综合 — 从里程碑产物生成的入职和审查产物。 | `/gsd-milestone-summary` |
|
||||
| `new-milestone.md` | 启动新里程碑周期 — 加载项目上下文、收集目标、更新 PROJECT.md/STATE.md。 | `/gsd-new-milestone` |
|
||||
| `new-project.md` | 统一的新项目流程 — 提问、研究（可选）、需求、路线图。 | `/gsd-new-project` |
|
||||
| `onboard.md` | Brownfield 接入编排 — 映射代码库、摄取文档、初始化规划并总结下一步。 | `/gsd-onboard` |
|
||||
| `new-workspace.md` | 创建带有仓库 worktree/克隆和独立 `.planning/` 的隔离工作区。 | `/gsd-workspace --new` |
|
||||
| `next.md` | 检测当前项目状态并自动推进到下一个逻辑步骤。 | `/gsd-progress --next` |
|
||||
| `node-repair.md` | 用于失败任务验证的自主修复算子；由 `execute-plan` 调用。 | `execute-plan.md`（恢复） |
|
||||
|
||||
@@ -473,8 +473,8 @@ claude --dangerously-skip-permissions
|
||||
### 现有代码库
|
||||
|
||||
```bash
|
||||
/gsd-map-codebase # Analyse what exists (parallel agents)
|
||||
/gsd-new-project # Questions focus on what you're ADDING
|
||||
/gsd-onboard # Safely map, ingest docs, and initialize planning
|
||||
# Follow printed handoff commands, then rerun /gsd-onboard
|
||||
# (normal phase workflow from here)
|
||||
```
|
||||
|
||||
@@ -863,7 +863,8 @@ All subagent/executor commits MUST use `--no-verify`.
|
||||
themes/
|
||||
default.css # Shared CSS variables for all sketches
|
||||
MANIFEST.md # Index of all sketches with winners
|
||||
codebase/ # Brownfield codebase mapping (from /gsd-map-codebase)
|
||||
codebase/ # Brownfield codebase mapping (from /gsd-map-codebase or /gsd-onboard)
|
||||
onboarding/ # Brownfield onboarding summary (from /gsd-onboard)
|
||||
phases/
|
||||
XX-phase-name/
|
||||
XX-YY-PLAN.md # Atomic execution plans
|
||||
|
||||
@@ -44,15 +44,15 @@ claude --dangerously-skip-permissions
|
||||
|
||||
---
|
||||
|
||||
## 第 3 步 — 映射代码库
|
||||
## 第 3 步 — 开始 brownfield onboarding
|
||||
|
||||
在创建项目之前，先让 GSD Core 了解已有的内容。这是使棕地规划准确的关键步骤。
|
||||
|
||||
```text
|
||||
/gsd-map-codebase
|
||||
/gsd-onboard
|
||||
```
|
||||
|
||||
GSD Core 会派生四个并行映射子代理（您将看到"Spawning 4 parallel codebase mapper agents…"——这需要 1–5 分钟；请勿中断）。每个代理专注于不同的关注点：
|
||||
如果 onboarding 报告缺少代码库映射，请选择推荐选项并运行打印出的 `/gsd-map-codebase` 交接命令，然后重新运行 `/gsd-onboard`。`/gsd-map-codebase` 会派生四个并行映射子代理（您将看到"Spawning 4 parallel codebase mapper agents…"——这需要 1–5 分钟；请勿中断）。每个代理专注于不同的关注点：
|
||||
|
||||
| 代理 | 关注点 |
|
||||
|-------|-------|
|
||||
@@ -133,6 +133,7 @@ Proposed Roadmap
|
||||
ROADMAP.md ← Phase 1, status: pending
|
||||
STATE.md ← session memory
|
||||
config.json ← workflow settings
|
||||
onboarding/SUMMARY.md ← onboarding status and next command
|
||||
codebase/ ← the seven map files from Step 3
|
||||
```
|
||||
|
||||
|
||||
Reference in New Issue
Block a user