* docs(en): update FEATURES/USER-GUIDE/COMMANDS for v1.40.0 surface - FEATURES.md: append v1.40.0 section (#122 skill consolidation, #123 namespace meta-skills, #124 context-window guard, #125 phase-lifecycle status-line read-side); add to TOC. - USER-GUIDE.md: add slash-command form (hyphen vs colon) primer and namespace routing primer; replace deleted slash forms in walkthroughs (`/gsd-add-backlog`, `/gsd-plant-seed`, `/gsd-add-phase`, `/gsd-set-profile`, `/gsd-list-workspaces`, etc.) with consolidated forms (`/gsd-capture --backlog`, `/gsd-phase --insert`, `/gsd-config --profile`, `/gsd-workspace --list`, etc.); fix `/gsd-spike-wrap-up` and `/gsd-sketch-wrap-up` to flag form. - COMMANDS.md: clarify Command Syntax (Gemini = colon form, others = hyphen form); add Namespace Meta-Skills section with all six routers; add `--context` to /gsd-health flag table. Refs #3047 * docs(en): refresh INVENTORY/CLI-TOOLS/STATE-MD-LIFECYCLE for v1.40.0 - INVENTORY.md: workflow-row "Invoked by" column updated to point at consolidated commands (`/gsd-phase` family, `/gsd-workspace --list`, `/gsd-config --advanced/--integrations/--profile`, `/gsd-sketch --wrap-up`, `/gsd-spike --wrap-up`); CLI-modules row for `secrets.cjs` updated to `/gsd-config --integrations`. Command count and namespace meta-skills section already reflect 65 shipped (= 59 consolidated sub-skills + 6 ns-* routers). - CLI-TOOLS.md: add `validate context` row under Validation Commands with the 60 %/70 % threshold envelope used by `/gsd-health --context`. - STATE-MD-LIFECYCLE.md: flip status header from "proposed" to "shipped in v1.40.0" since `parseStateMd()` and `formatGsdState()` now read and render `active_phase`, `next_action`, `next_phases`, and `progress`. `docs/AGENTS.md` audited and verified clean — `gsd-code-fixer` row already lists the correct `/gsd-code-review --fix` spawner; no deleted-skill references found. `docs/INVENTORY-MANIFEST.json` audited and verified clean — already enumerates the 65 commands (including six ns-* routers) and contains no deleted slash forms. Refs #3047 * docs(en): cleanup ARCHITECTURE/CONFIGURATION for v1.40.0 - ARCHITECTURE.md: split Commands install-target list to call out the Gemini colon form (`/gsd:command-name`) vs hyphen form for every other runtime. Add a new subsection covering two-stage hierarchical routing via the six namespace meta-skills (#2792) and a paired note on the MCP token-budget interaction so readers see the two big per-turn cost levers in one place. - CONFIGURATION.md: rewrite three references to the deleted `/gsd-settings-advanced` and `/gsd-settings-integrations` slash forms to use the consolidated `/gsd-config --advanced` / `/gsd-config --integrations` invocations. Add a new "STATE.md Frontmatter (Phase Lifecycle)" section documenting the four optional fields (`active_phase`, `next_action`, `next_phases`, `progress`) read by the v1.40 status-line, with a pointer to STATE-MD-LIFECYCLE.md for the full reference. `docs/manual-update.md` audited and verified clean — already documents `/gsd-update --reapply` (the consolidated form), no reference to the deleted `/gsd-reapply-patches`. Refs #3047 * docs(i18n): mirror v1.40.0 slash-command rename into ja-JP/ko-KR/zh-CN/pt-BR Mechanical token-level renames only — every reference to a deleted micro-skill slash form is rewritten to the consolidated form on the matching parent skill. No prose was machine-translated; new prose sections (slash-form primer, namespace routing primer, v1.40 feature entries, STATE.md frontmatter) were left for human translator follow-up. Renames applied uniformly across all four trees: /gsd-add-todo, /gsd-add-note, /gsd-add-backlog, /gsd-plant-seed, /gsd-check-todos → /gsd-capture[ --note| --backlog|--seed|--list] /gsd-add-phase, /gsd-insert-phase, /gsd-remove-phase, /gsd-edit-phase → /gsd-phase[ --insert| --remove|--edit] /gsd-new-workspace, /gsd-list-workspaces, /gsd-remove-workspace → /gsd-workspace[ --new| --list|--remove] /gsd-settings-advanced, /gsd-settings-integrations, /gsd-set-profile → /gsd-config[ --advanced| --integrations|--profile] /gsd-sketch-wrap-up → /gsd-sketch --wrap-up /gsd-spike-wrap-up → /gsd-spike --wrap-up /gsd-reapply-patches → /gsd-update --reapply /gsd-code-review-fix → /gsd-code-review --fix /gsd-plan-milestone-gaps → /gsd-audit-milestone Refs #3047 * docs(changelog): regroup [Unreleased] under Feature/Enhancement/Fix Replace the existing Keep-a-Changelog \`Added\` / \`Changed\` / \`Performance\` / \`Removed\` / \`Fixed\` sub-headers in the [Unreleased] block with the issue/PR template taxonomy: Added → Feature Changed / Performance → Enhancement Removed → Enhancement Fixed → Fix Order within the release: Feature → Enhancement → Fix. Every bullet preserved verbatim — only headers and grouping changed; the awkward inline-versioned headers (\`### Added — 1.40.0-rc.1\`, \`### Changed — 1.40.0-rc.1\`, \`### Fixed — 1.40.0-rc.1\`) folded into the same buckets with the \`— 1.40.0-rc.1\` suffix dropped, since the [Unreleased] block IS 1.40.0-rc.1. The [1.39.2] hotfix block called out in #3047's spec does not yet exist in CHANGELOG.md (the previously released hotfix is [1.39.1]), so this commit only regroups [Unreleased]. Older release blocks ([1.39.1] and earlier) are frozen and untouched. Refs #3047 * docs(changeset): add fragment for v1.40.0 doc audit Refs #3047 * docs(en): strip leading / from deleted slash-command tokens in FEATURES REQ-CONSOLIDATE-03 and REQ-CONSOLIDATE-04 listed deleted commands by their `/gsd-foo` form for the historical record. The docs-parity tests in bug-3010, bug-3029-3034, and bug-3042-3044 use the regex `/\/gsd-[a-z0-9][a-z0-9-]*/g` to scan user-facing surfaces for any remaining mention of removed slash forms — they cannot tell prose about a deleted command from a live recommendation. Strip the leading slash from the bare-name references (preserve the historical text otherwise). Tests now require a `/` prefix to match, so `gsd-add-todo` reads identically to a human but no longer trips the parser. Verified locally: 65/65 tests pass across the three docs-parity suites that were red on CI run 25270072600. Refs #3047 * docs(en): fix CR feedback + drop literal /gsd:plan-phase from USER-GUIDE CI: tests/bug-2543-gsd-slash-namespace.test.cjs flagged docs/USER-GUIDE.md:35 for embedding the literal `/gsd:plan-phase` token in the parenthetical Gemini-form example. The test scans every .md under docs/ for `/gsd:<live-cmd>` because non-Gemini surfaces must not advertise the colon form. Replaced the literal example with a prose substitution rule. CR: docs/ARCHITECTURE.md:125 — the namespace meta-skills were listed by file-prefix (`gsd-ns-workflow`) but the invocable frontmatter `name:` is the bare form (`gsd-workflow`). Verified against the six `commands/gsd/ns-*.md` files. Replaced with the canonical names and noted the file/name disagreement in-line. CR: docs/COMMANDS.md:723 — `v1.40` aligned to canonical `v1.40.0`. CR: docs/FEATURES.md:2679 — REQ-CTX-GUARD-02 advertised the wrong invocation (`gsd-tools validate context`). The shipped handler is exposed via `gsd-sdk query validate.context` and requires explicit `--tokens-used <int>` + `--context-window <int>` flags (verified against sdk/src/query/validate.ts:849-882 and get-shit-done/bin/lib/validate-command-router.cjs:19-36). CR: docs/zh-CN/README.md:533 — added `inherit` to the profile-options parenthetical to match the canonical set (verified against model-profiles.cjs:29 `VALID_PROFILES = […MODEL_PROFILES['gsd-planner'], 'inherit']`). Verified locally: 74/74 tests pass across the four docs-parity suites that were red on CI runs 25270072600 and 25270182903. Refs #3047
335 lines
7.8 KiB
Markdown
335 lines
7.8 KiB
Markdown
# Guia do Usuário do GSD
|
|
|
|
Referência detalhada de workflows, troubleshooting e configuração. Para setup rápido, veja o [README](../../README.pt-BR.md).
|
|
|
|
---
|
|
|
|
## Sumário
|
|
|
|
- [Fluxo de trabalho](#fluxo-de-trabalho)
|
|
- [Contrato de UI](#contrato-de-ui)
|
|
- [Backlog e Threads](#backlog-e-threads)
|
|
- [Workstreams](#workstreams)
|
|
- [Segurança](#segurança)
|
|
- [Referência de comandos](#referência-de-comandos)
|
|
- [Configuração](#configuração)
|
|
- [Exemplos de uso](#exemplos-de-uso)
|
|
- [Troubleshooting](#troubleshooting)
|
|
- [Recuperação rápida](#recuperação-rápida)
|
|
|
|
---
|
|
|
|
## Fluxo de trabalho
|
|
|
|
Fluxo recomendado por fase:
|
|
|
|
1. `/gsd-discuss-phase [N]` — trava preferências de implementação
|
|
2. `/gsd-ui-phase [N]` — contrato visual para fases frontend
|
|
3. `/gsd-plan-phase [N]` — pesquisa + plano + validação
|
|
4. `/gsd-execute-phase [N]` — execução em ondas paralelas
|
|
5. `/gsd-verify-work [N]` — UAT manual com diagnóstico
|
|
6. `/gsd-ship [N]` — cria PR (opcional)
|
|
|
|
Para iniciar projeto novo:
|
|
|
|
```bash
|
|
/gsd-new-project
|
|
```
|
|
|
|
Para seguir automaticamente o próximo passo:
|
|
|
|
```bash
|
|
/gsd-next
|
|
```
|
|
|
|
### Nyquist Validation
|
|
|
|
Durante `plan-phase`, o GSD pode mapear requisitos para comandos de teste automáticos antes da implementação. Isso gera `{phase}-VALIDATION.md` e aumenta a confiabilidade de verificação pós-execução.
|
|
|
|
Desativar:
|
|
|
|
```json
|
|
{
|
|
"workflow": {
|
|
"nyquist_validation": false
|
|
}
|
|
}
|
|
```
|
|
|
|
### Modo de discussão por suposições
|
|
|
|
Com `workflow.discuss_mode: "assumptions"`, o GSD analisa o código antes de perguntar, apresenta suposições estruturadas e pede apenas correções.
|
|
|
|
---
|
|
|
|
## Contrato de UI
|
|
|
|
### Comandos
|
|
|
|
| Comando | Descrição |
|
|
|---------|-----------|
|
|
| `/gsd-ui-phase [N]` | Gera contrato de design `UI-SPEC.md` para a fase |
|
|
| `/gsd-ui-review [N]` | Auditoria visual retroativa em 6 pilares |
|
|
|
|
### Quando usar
|
|
|
|
- Rode `/gsd-ui-phase` depois de `/gsd-discuss-phase` e antes de `/gsd-plan-phase`.
|
|
- Rode `/gsd-ui-review` após execução/validação para avaliar qualidade visual e consistência.
|
|
|
|
### Configurações relacionadas
|
|
|
|
| Setting | Padrão | O que controla |
|
|
|---------|--------|----------------|
|
|
| `workflow.ui_phase` | `true` | Gera contratos de UI para fases frontend |
|
|
| `workflow.ui_safety_gate` | `true` | Ativa gate de segurança para componentes de registry |
|
|
|
|
---
|
|
|
|
## Backlog e Threads
|
|
|
|
### Backlog (999.x)
|
|
|
|
Ideias fora da sequência ativa vão para backlog:
|
|
|
|
```bash
|
|
/gsd-capture --backlog "Camada GraphQL"
|
|
/gsd-capture --backlog "Responsividade mobile"
|
|
```
|
|
|
|
Promover/revisar:
|
|
|
|
```bash
|
|
/gsd-review-backlog
|
|
```
|
|
|
|
### Seeds
|
|
|
|
Seeds guardam ideias futuras com condição de gatilho:
|
|
|
|
```bash
|
|
/gsd-capture --seed "Adicionar colaboração real-time quando infra de WebSocket estiver pronta"
|
|
```
|
|
|
|
### Threads persistentes
|
|
|
|
Threads são contexto leve entre sessões:
|
|
|
|
```bash
|
|
/gsd-thread
|
|
/gsd-thread fix-deploy-key-auth
|
|
/gsd-thread "Investigar timeout TCP"
|
|
```
|
|
|
|
---
|
|
|
|
## Workstreams
|
|
|
|
Workstreams permitem trabalho paralelo sem colisão de estado de planejamento.
|
|
|
|
| Comando | Função |
|
|
|---------|--------|
|
|
| `/gsd-workstreams create <name>` | Cria workstream isolado |
|
|
| `/gsd-workstreams switch <name>` | Troca workstream ativo |
|
|
| `/gsd-workstreams list` | Lista workstreams |
|
|
| `/gsd-workstreams complete <name>` | Finaliza e arquiva workstream |
|
|
|
|
`workstreams` compartilham o mesmo código/git, mas isolam artefatos de `.planning/`.
|
|
|
|
---
|
|
|
|
## Segurança
|
|
|
|
O GSD aplica defesa em profundidade:
|
|
|
|
- prevenção de path traversal em entradas de arquivo
|
|
- detecção de prompt injection em texto do usuário
|
|
- hooks de proteção para escrita em `.planning/`
|
|
- scanner CI para padrões de injeção em agentes/workflows/comandos
|
|
|
|
Para arquivos sensíveis, use deny list no Claude Code.
|
|
|
|
---
|
|
|
|
## Referência de comandos
|
|
|
|
### Fluxo principal
|
|
|
|
| Comando | Quando usar |
|
|
|---------|-------------|
|
|
| `/gsd-new-project` | Início de projeto |
|
|
| `/gsd-discuss-phase [N]` | Definir preferências antes do plano |
|
|
| `/gsd-plan-phase [N]` | Criar e validar planos |
|
|
| `/gsd-execute-phase [N]` | Executar planos em ondas |
|
|
| `/gsd-verify-work [N]` | UAT manual |
|
|
| `/gsd-ship [N]` | Gerar PR da fase |
|
|
| `/gsd-next` | Próximo passo automático |
|
|
|
|
### Gestão e utilidades
|
|
|
|
| Comando | Quando usar |
|
|
|---------|-------------|
|
|
| `/gsd-progress` | Ver status atual |
|
|
| `/gsd-resume-work` | Retomar sessão |
|
|
| `/gsd-pause-work` | Pausar com handoff |
|
|
| `/gsd-session-report` | Resumo da sessão |
|
|
| `/gsd-quick` | Tarefa ad-hoc com garantias GSD |
|
|
| `/gsd-debug [desc]` | Debug sistemático |
|
|
| `/gsd-forensics` | Diagnóstico de workflow quebrado |
|
|
| `/gsd-settings` | Ajustar workflow/modelos |
|
|
| `/gsd-config --profile <profile>` | Troca rápida de perfil |
|
|
|
|
Para lista completa e flags avançadas, consulte [Command Reference](../COMMANDS.md).
|
|
|
|
---
|
|
|
|
## Configuração
|
|
|
|
Arquivo de configuração: `.planning/config.json`
|
|
|
|
### Núcleo
|
|
|
|
| Setting | Opções | Padrão |
|
|
|---------|--------|--------|
|
|
| `mode` | `interactive`, `yolo` | `interactive` |
|
|
| `granularity` | `coarse`, `standard`, `fine` | `standard` |
|
|
| `model_profile` | `quality`, `balanced`, `budget`, `inherit` | `balanced` |
|
|
|
|
### Workflow
|
|
|
|
| Setting | Padrão |
|
|
|---------|--------|
|
|
| `workflow.research` | `true` |
|
|
| `workflow.plan_check` | `true` |
|
|
| `workflow.verifier` | `true` |
|
|
| `workflow.nyquist_validation` | `true` |
|
|
| `workflow.ui_phase` | `true` |
|
|
| `workflow.ui_safety_gate` | `true` |
|
|
|
|
### Perfis de modelo
|
|
|
|
| Perfil | Uso recomendado |
|
|
|--------|------------------|
|
|
| `quality` | trabalho crítico, maior qualidade |
|
|
| `balanced` | padrão recomendado |
|
|
| `budget` | reduzir custo de tokens |
|
|
| `inherit` | seguir modelo da sessão/runtime |
|
|
|
|
Detalhes completos: [Configuration Reference](../CONFIGURATION.md).
|
|
|
|
---
|
|
|
|
## Exemplos de uso
|
|
|
|
### Projeto novo
|
|
|
|
```bash
|
|
claude --dangerously-skip-permissions
|
|
/gsd-new-project
|
|
/gsd-discuss-phase 1
|
|
/gsd-ui-phase 1
|
|
/gsd-plan-phase 1
|
|
/gsd-execute-phase 1
|
|
/gsd-verify-work 1
|
|
/gsd-ship 1
|
|
```
|
|
|
|
### Código já existente
|
|
|
|
```bash
|
|
/gsd-map-codebase
|
|
/gsd-new-project
|
|
```
|
|
|
|
### Correção rápida
|
|
|
|
```bash
|
|
/gsd-quick
|
|
> "Corrigir botão de login no mobile Safari"
|
|
```
|
|
|
|
### Preparação para release
|
|
|
|
```bash
|
|
/gsd-audit-milestone
|
|
/gsd-complete-milestone
|
|
```
|
|
|
|
---
|
|
|
|
## Troubleshooting
|
|
|
|
### "Project already initialized"
|
|
|
|
`.planning/PROJECT.md` já existe. Apague `.planning/` se quiser reiniciar do zero.
|
|
|
|
### Sessão longa degradando contexto
|
|
|
|
Use `/clear` entre etapas grandes e retome com `/gsd-resume-work` ou `/gsd-progress`.
|
|
|
|
### Plano desalinhado
|
|
|
|
Rode `/gsd-discuss-phase [N]` antes do plano e valide suposições com `/gsd-list-phase-assumptions [N]`.
|
|
|
|
### Execução falhou ou saiu com stubs
|
|
|
|
Replaneje com escopo menor (tarefas menores por plano).
|
|
|
|
### Custo alto
|
|
|
|
Use perfil budget:
|
|
|
|
```bash
|
|
/gsd-config --profile budget
|
|
```
|
|
|
|
### Runtime não-Claude (Codex/OpenCode/Gemini/Kilo)
|
|
|
|
Use `resolve_model_ids: "omit"` para deixar o runtime resolver modelos padrão.
|
|
|
|
---
|
|
|
|
## Recuperação rápida
|
|
|
|
| Problema | Solução |
|
|
|---------|---------|
|
|
| Perdeu contexto | `/gsd-resume-work` ou `/gsd-progress` |
|
|
| Fase deu errado | `git revert` + replanejar |
|
|
| Precisa alterar escopo | `/gsd-phase`, `/gsd-phase --insert`, `/gsd-phase --remove` |
|
|
| Bug em workflow | `/gsd-forensics` |
|
|
| Correção pontual | `/gsd-quick` |
|
|
| Custo alto | `/gsd-config --profile budget` |
|
|
| Não sabe próximo passo | `/gsd-next` |
|
|
|
|
---
|
|
|
|
## Estrutura de arquivos do projeto
|
|
|
|
```text
|
|
.planning/
|
|
PROJECT.md
|
|
REQUIREMENTS.md
|
|
ROADMAP.md
|
|
STATE.md
|
|
config.json
|
|
MILESTONES.md
|
|
HANDOFF.json
|
|
research/
|
|
reports/
|
|
todos/
|
|
debug/
|
|
codebase/
|
|
phases/
|
|
XX-phase-name/
|
|
XX-YY-PLAN.md
|
|
XX-YY-SUMMARY.md
|
|
CONTEXT.md
|
|
RESEARCH.md
|
|
VERIFICATION.md
|
|
XX-UI-SPEC.md
|
|
XX-UI-REVIEW.md
|
|
ui-reviews/
|
|
```
|
|
|
|
> [!NOTE]
|
|
> Esta é a versão pt-BR do guia para uso diário. Para detalhes técnicos exatos e cobertura completa de parâmetros avançados, consulte também o [guia original em inglês](../USER-GUIDE.md).
|