pan-wizard 3.35.0 → 3.37.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +3645 -0
- package/README.md +46 -52
- package/agents/pan-conductor.md +2 -3
- package/agents/pan-counterfactual.md +1 -2
- package/agents/pan-debugger.md +14 -3
- package/agents/pan-design-checker.md +1 -2
- package/agents/pan-designer.md +2 -3
- package/agents/pan-document_code.md +1 -2
- package/agents/pan-executor.md +25 -0
- package/agents/pan-hardener.md +4 -3
- package/agents/pan-integration-checker.md +1 -2
- package/agents/pan-knowledge.md +1 -2
- package/agents/pan-meta-reviewer.md +3 -3
- package/agents/pan-optimizer.md +4 -4
- package/agents/pan-phase-researcher.md +80 -475
- package/agents/pan-plan-checker.md +40 -3
- package/agents/pan-planner.md +21 -7
- package/agents/pan-previewer.md +3 -2
- package/agents/pan-project-researcher.md +72 -493
- package/agents/pan-release.md +1 -1
- package/agents/pan-reviewer.md +14 -3
- package/agents/pan-roadmapper.md +12 -7
- package/agents/pan-verifier.md +9 -4
- package/bin/install-lib.cjs +134 -14
- package/bin/install.js +59 -12
- package/commands/pan/army.md +1 -1
- package/commands/pan/autodev.md +76 -0
- package/commands/pan/cost.md +21 -1
- package/commands/pan/exec-phase.md +3 -4
- package/commands/pan/focus-auto.md +14 -7
- package/commands/pan/focus-design.md +4 -5
- package/commands/pan/focus-docs.md +24 -0
- package/commands/pan/learn.md +13 -6
- package/commands/pan/milestone-audit.md +8 -1
- package/commands/pan/milestone-done.md +10 -5
- package/commands/pan/milestone-new.md +2 -2
- package/commands/pan/new-project.md +15 -12
- package/commands/pan/plan-phase.md +15 -9
- package/commands/pan/preview.md +1 -1
- package/commands/pan/quick.md +1 -1
- package/commands/pan/review-deep.md +11 -5
- package/commands/pan/settings.md +6 -0
- package/commands/pan/verify-phase.md +6 -2
- package/docs/AGENTS.md +917 -0
- package/docs/ARCHITECTURE.md +1054 -0
- package/docs/CLI-REFERENCE.md +4582 -0
- package/docs/COMPARISON.md +116 -0
- package/docs/DEVELOPMENT.md +490 -0
- package/docs/ECOSYSTEM-REVIEW-2026-06.md +107 -0
- package/docs/ECOSYSTEM-REVIEW-2026-08.md +349 -0
- package/docs/EXAMPLES.md +584 -0
- package/docs/FAQ.md +254 -0
- package/docs/FIELD-HARVEST-2026-07.md +88 -0
- package/docs/FIELD-REPORT-army-2026-06.md +121 -0
- package/docs/HOOKS.md +638 -0
- package/docs/IMPROVEMENT-TODO.md +246 -0
- package/docs/INTERNALS.md +485 -0
- package/docs/MIGRATION-v2-to-v3.md +258 -0
- package/docs/SECURITY-HARDENING.md +230 -0
- package/docs/SKILLS-ENHANCEMENT-PLAN-V2.md +122 -0
- package/docs/SKILLS-FULL-TEXT.md +9685 -0
- package/docs/SKILLS-REFERENCE.md +1037 -0
- package/docs/TROUBLESHOOTING.md +1084 -0
- package/docs/USER-GUIDE.md +1437 -0
- package/docs/archive/SKILLS-ENHANCEMENT-PLAN.md +230 -0
- package/docs/audits/AUDIT-2026-08-e2e-ROADMAP.md +117 -0
- package/docs/audits/AUDIT-2026-08-e2e-VERIFICATION.md +693 -0
- package/docs/audits/AUDIT-2026-08-e2e.md +1546 -0
- package/docs/audits/OUTSTANDING-2026-08.md +275 -0
- package/docs/audits/STABILITY-TEST-2026-08.md +640 -0
- package/docs/branding/README-brand-draft.md +119 -0
- package/docs/branding/handoff/IMPLEMENTATION.md +205 -0
- package/docs/branding/handoff/README-brand-draft.md +119 -0
- package/docs/branding/handoff/image-prompts.md +46 -0
- package/docs/branding/image-prompts.md +46 -0
- package/docs/branding/nano-banana-prompts.txt +60 -0
- package/docs/context-monitor.md +13 -0
- package/docs/decisions/ADR-0001-strategic-feature-prioritization.md +83 -0
- package/docs/decisions/ADR-0002-copilot-cli-runtime.md +71 -0
- package/docs/decisions/ADR-0003-smart-execution.md +84 -0
- package/docs/decisions/ADR-0004-copilot-cli-interaction.md +89 -0
- package/docs/decisions/ADR-0005-command-naming.md +80 -0
- package/docs/decisions/ADR-0006-focus-commands.md +101 -0
- package/docs/decisions/ADR-0007-ship-v1.md +73 -0
- package/docs/decisions/ADR-0008-map-codebase-mermaid-togaf.md +80 -0
- package/docs/decisions/ADR-0009-production-deployment-checklist.md +68 -0
- package/docs/decisions/ADR-0010-standards-integration.md +79 -0
- package/docs/decisions/ADR-0011-help-commands-rewrite.md +64 -0
- package/docs/decisions/ADR-0012-contributors-attribution-index.md +42 -0
- package/docs/decisions/ADR-0013-strategic-feature-additions.md +53 -0
- package/docs/decisions/ADR-0014-internal-cleanup-code-quality.md +53 -0
- package/docs/decisions/ADR-0015-focus-auto-runner.md +296 -0
- package/docs/decisions/ADR-0016-enhanced-doc-sync.md +54 -0
- package/docs/decisions/ADR-0017-enhanced-focus-design.md +69 -0
- package/docs/decisions/ADR-0018-user-reality-testing.md +84 -0
- package/docs/decisions/ADR-0019-end-to-end-user-acceptance-testing.md +113 -0
- package/docs/decisions/ADR-0020-ai-drift-prevention.md +55 -0
- package/docs/decisions/ADR-0021-codebase-mapper-v2.md +76 -0
- package/docs/decisions/ADR-0022-lifecycle-completeness.md +63 -0
- package/docs/decisions/ADR-0023-opus-4-7-adoption.md +89 -0
- package/docs/decisions/ADR-0024-spec-b-v2-completion.md +137 -0
- package/docs/decisions/ADR-0025-behavioral-guardrails-layer.md +129 -0
- package/docs/decisions/ADR-0026-self-improvement-loop.md +171 -0
- package/docs/decisions/ADR-0027-doc-code-link-graph.md +164 -0
- package/docs/decisions/ADR-0028-unified-agents-skills-target.md +46 -0
- package/docs/decisions/ADR-0029-experiment-evaluator.md +76 -0
- package/docs/decisions/ADR-0030-planning-concurrency.md +37 -0
- package/docs/decisions/ADR-0031-focus-auto-backlog-source.md +47 -0
- package/docs/decisions/ADR-0032-squad-model.md +64 -0
- package/docs/decisions/ADR-0033-army-campaign.md +40 -0
- package/docs/decisions/ADR-0034-scheduled-campaigns.md +57 -0
- package/docs/decisions/ADR-0035-army-hud-dashboard.md +40 -0
- package/docs/decisions/ADR-0036-agentic-memory-architecture.md +106 -0
- package/docs/decisions/ADR-0037-pin-security-agents-to-opus.md +51 -0
- package/docs/decisions/ADR-0038-skill-aligned-decomposition.md +41 -0
- package/docs/decisions/ADR-0039-worktree-as-project-variant.md +37 -0
- package/docs/decisions/ADR-0040-memory-injection-defense.md +55 -0
- package/docs/decisions/ADR-0041-mcp-dual-era-bridge.md +47 -0
- package/docs/decisions/ADR-0042-design-parity-both-flows.md +45 -0
- package/docs/decisions/ADR-0043-addressable-planning-roots.md +56 -0
- package/docs/decisions/ADR-0044-bound-the-cached-context.md +104 -0
- package/docs/decisions/ADR-0045-agent-plugins-bundle.md +76 -0
- package/docs/decisions/ADR-0046-subagent-frontmatter-decisions.md +39 -0
- package/docs/decisions/ADR-0047-pan-harness.md +76 -0
- package/docs/decisions/ADR-0048-one-core-per-project.md +43 -0
- package/docs/decisions/ADR-0049-machine-verdicts-and-findings-ledger.md +116 -0
- package/docs/specs/ai_drift_prevention_featureai.md +286 -0
- package/docs/specs/codebase_mapper_v2_featureai.md +930 -0
- package/docs/specs/command_naming_optimization_featureai.md +930 -0
- package/docs/specs/comp_analysis_markdown_v1.md +149 -0
- package/docs/specs/continuous_autonomous_execution_featureai.md +304 -0
- package/docs/specs/contributors_attribution_index_featureai.md +476 -0
- package/docs/specs/copilot_cli_interaction_featureai.md +868 -0
- package/docs/specs/copilot_cli_runtime_featureai.md +647 -0
- package/docs/specs/custom-skills-assessment.md +461 -0
- package/docs/specs/deployment_audit_findings_featureai.md +243 -0
- package/docs/specs/doc_code_link_graph_featureai.md +253 -0
- package/docs/specs/documentation_alignment_cleanup_featureai.md +69 -0
- package/docs/specs/e2e_visual_testing_featureai.md +615 -0
- package/docs/specs/end_to_end_user_acceptance_testing_featureai.md +810 -0
- package/docs/specs/evidence-loop-plan.md +76 -0
- package/docs/specs/evidence_loop_featureai.md +497 -0
- package/docs/specs/focus-auto-optimize-category.md +449 -0
- package/docs/specs/focus-auto-optimize-superplan.md +188 -0
- package/docs/specs/focus_auto_runner_featureai.md +1102 -0
- package/docs/specs/focus_design_v2_featureai.md +197 -0
- package/docs/specs/focus_sync_v2_featureai.md +202 -0
- package/docs/specs/git_integration_overhaul_featureai.md +326 -0
- package/docs/specs/glm_zai_provider_featureai.md +200 -0
- package/docs/specs/googlecli_adoption_featureai.md +661 -0
- package/docs/specs/help_commands_rewrite_featureai.md +860 -0
- package/docs/specs/industry_analysis_strategic_additions_featureai.md +231 -0
- package/docs/specs/industry_comparison_and_feature_gaps_featureai.md +674 -0
- package/docs/specs/internal_cleanup_code_quality_featureai.md +486 -0
- package/docs/specs/investigations/README.md +31 -0
- package/docs/specs/investigations/digests/2026-09-28.md +47 -0
- package/docs/specs/investigations/digests/2026-10-08.md +62 -0
- package/docs/specs/investigations/digests/2026-10-10.md +61 -0
- package/docs/specs/investigations/features/debugger-red-loop-first.md +55 -0
- package/docs/specs/investigations/features/harness-cross-host-behaviour.md +93 -0
- package/docs/specs/investigations/features/optimize-apply-regression-gate.md +66 -0
- package/docs/specs/investigations/features/reviewer-smell-baseline.md +57 -0
- package/docs/specs/investigations/features/trace-failure-capture.md +69 -0
- package/docs/specs/lifecycle_completeness_featureai.md +754 -0
- package/docs/specs/local-first-ci.md +42 -0
- package/docs/specs/map_codebase_mermaid_togaf_featureai.md +805 -0
- package/docs/specs/market-delta-2026-09-superplan.md +310 -0
- package/docs/specs/market-ideas-2026-09.md +131 -0
- package/docs/specs/market-ideas-2026-10.md +428 -0
- package/docs/specs/market-ideas-ledger.md +177 -0
- package/docs/specs/memory-optimization-2026-10.md +285 -0
- package/docs/specs/multi-track-planning-roots.md +143 -0
- package/docs/specs/multi_model_routing_featureai.md +687 -0
- package/docs/specs/multi_model_routing_superplan.md +197 -0
- package/docs/specs/opus_47_existing_enhancements_featureai.md +247 -0
- package/docs/specs/opus_47_extended_features_featureai.md +363 -0
- package/docs/specs/opus_47_extended_features_v2_featureai.md +397 -0
- package/docs/specs/pan_focus_commands_featureai.md +2336 -0
- package/docs/specs/pan_zcode_mcp_bridge_featureai.md +120 -0
- package/docs/specs/product-excellence-superplan.md +315 -0
- package/docs/specs/product_excellence_program_2026_q4_featureai.md +365 -0
- package/docs/specs/production_deployment_readiness_featureai.md +433 -0
- package/docs/specs/production_readiness_ship_v1_featureai.md +698 -0
- package/docs/specs/real_test_enforcement_featureai.md +213 -0
- package/docs/specs/reality-check-2026-09-superplan.md +362 -0
- package/docs/specs/right-sized-ceremony.md +74 -0
- package/docs/specs/roadmap_and_competition_2026_q4_featureai.md +390 -0
- package/docs/specs/self_improvement_loop_featureai.md +875 -0
- package/docs/specs/skill-aligned-decomposition.md +155 -0
- package/docs/specs/standards_integration_featureai.md +833 -0
- package/docs/specs/testing-system-redesign-2026-09.md +267 -0
- package/docs/specs/user_reality_testing_system_featureai.md +788 -0
- package/docs/specs/watch-triggers.json +22 -0
- package/docs/specs/workflow-integration-redesign.md +742 -0
- package/docs/specs/workflow_state_consistency_featureai.md +183 -0
- package/hooks/dist/pan-context-monitor.js +9 -2
- package/hooks/dist/pan-cost-logger.js +5 -0
- package/hooks/dist/pan-guard.js +28 -5
- package/hooks/dist/pan-stop-guard.js +9 -9
- package/hooks/dist/pan-trace-logger.js +5 -0
- package/package.json +10 -2
- package/pan-wizard-core/bin/lib/agents-md.cjs +57 -8
- package/pan-wizard-core/bin/lib/autodev-report.cjs +180 -0
- package/pan-wizard-core/bin/lib/autodev.cjs +642 -0
- package/pan-wizard-core/bin/lib/ci.cjs +143 -0
- package/pan-wizard-core/bin/lib/commands.cjs +1 -1
- package/pan-wizard-core/bin/lib/config.cjs +41 -5
- package/pan-wizard-core/bin/lib/constants.cjs +27 -1
- package/pan-wizard-core/bin/lib/core.cjs +31 -14
- package/pan-wizard-core/bin/lib/cost.cjs +160 -4
- package/pan-wizard-core/bin/lib/cross-family.cjs +164 -0
- package/pan-wizard-core/bin/lib/debug-cases.cjs +104 -0
- package/pan-wizard-core/bin/lib/doc-lint.cjs +5 -3
- package/pan-wizard-core/bin/lib/failure-class.cjs +81 -0
- package/pan-wizard-core/bin/lib/findings.cjs +148 -9
- package/pan-wizard-core/bin/lib/focus.cjs +1 -1
- package/pan-wizard-core/bin/lib/git.cjs +1 -1
- package/pan-wizard-core/bin/lib/hosts.cjs +88 -0
- package/pan-wizard-core/bin/lib/init.cjs +7 -2
- package/pan-wizard-core/bin/lib/knowledge.cjs +2 -0
- package/pan-wizard-core/bin/lib/merge.cjs +50 -0
- package/pan-wizard-core/bin/lib/mutate.cjs +268 -0
- package/pan-wizard-core/bin/lib/next-action.cjs +112 -0
- package/pan-wizard-core/bin/lib/optimize.cjs +2 -2
- package/pan-wizard-core/bin/lib/phase-gate.cjs +15 -9
- package/pan-wizard-core/bin/lib/phase-remove.cjs +91 -11
- package/pan-wizard-core/bin/lib/phase.cjs +85 -13
- package/pan-wizard-core/bin/lib/plan-lint.cjs +310 -0
- package/pan-wizard-core/bin/lib/preview.cjs +26 -4
- package/pan-wizard-core/bin/lib/requirements-lint.cjs +130 -0
- package/pan-wizard-core/bin/lib/research-lint.cjs +268 -0
- package/pan-wizard-core/bin/lib/review-deep.cjs +14 -22
- package/pan-wizard-core/bin/lib/review-vote.cjs +105 -0
- package/pan-wizard-core/bin/lib/roadmap.cjs +1 -0
- package/pan-wizard-core/bin/lib/runner.cjs +2 -16
- package/pan-wizard-core/bin/lib/sizing.cjs +356 -0
- package/pan-wizard-core/bin/lib/squads.cjs +1 -1
- package/pan-wizard-core/bin/lib/state-write.cjs +247 -0
- package/pan-wizard-core/bin/lib/test-gate.cjs +433 -0
- package/pan-wizard-core/bin/lib/uat.cjs +149 -0
- package/pan-wizard-core/bin/lib/usage.cjs +104 -0
- package/pan-wizard-core/bin/lib/verdict.cjs +26 -3
- package/pan-wizard-core/bin/lib/verify-plan-set.cjs +30 -1
- package/pan-wizard-core/bin/lib/verify-preflight.cjs +2 -2
- package/pan-wizard-core/bin/lib/verify-red.cjs +174 -0
- package/pan-wizard-core/bin/lib/verify-retro.cjs +3 -2
- package/pan-wizard-core/bin/lib/verify-scope.cjs +143 -2
- package/pan-wizard-core/bin/lib/verify.cjs +86 -31
- package/pan-wizard-core/bin/lib/worktree.cjs +70 -0
- package/pan-wizard-core/bin/pan-tools.cjs +257 -28
- package/pan-wizard-core/learnings/universal/autonomous-loop.md +2 -2
- package/pan-wizard-core/mcp/orchestrator.cjs +4 -1
- package/pan-wizard-core/references/continuation-format.md +3 -3
- package/pan-wizard-core/references/design-methodology.md +1 -1
- package/pan-wizard-core/references/guardrails.md +1 -1
- package/pan-wizard-core/references/handoff-decisions.md +1 -1
- package/pan-wizard-core/references/model-profiles.md +2 -3
- package/pan-wizard-core/references/questioning.md +24 -0
- package/pan-wizard-core/references/ui-brand.md +4 -6
- package/pan-wizard-core/references/verdict-contract.md +2 -1
- package/pan-wizard-core/templates/config.json +10 -2
- package/pan-wizard-core/templates/debug.md +1 -0
- package/pan-wizard-core/templates/design.md +5 -4
- package/pan-wizard-core/templates/discovery.md +2 -2
- package/pan-wizard-core/templates/phase-prompt.md +7 -0
- package/pan-wizard-core/templates/requirements.md +9 -0
- package/pan-wizard-core/templates/research.md +10 -0
- package/pan-wizard-core/templates/summary-complex.md +5 -1
- package/pan-wizard-core/templates/summary-minimal.md +4 -0
- package/pan-wizard-core/templates/summary-standard.md +5 -1
- package/pan-wizard-core/templates/summary.md +8 -1
- package/pan-wizard-core/workflows/add-phase.md +4 -6
- package/pan-wizard-core/workflows/assumptions.md +19 -1
- package/pan-wizard-core/workflows/diagnose-issues.md +2 -0
- package/pan-wizard-core/workflows/discuss-phase.md +4 -2
- package/pan-wizard-core/workflows/exec-lean.md +69 -0
- package/pan-wizard-core/workflows/exec-phase.md +79 -15
- package/pan-wizard-core/workflows/execute-plan.md +3 -1
- package/{commands/pan → pan-wizard-core/workflows}/focus-doc-audit.md +13 -29
- package/{commands/pan → pan-wizard-core/workflows}/focus-drift-walking.md +3 -18
- package/{commands/pan → pan-wizard-core/workflows}/focus-exec.md +8 -23
- package/{commands/pan → pan-wizard-core/workflows}/focus-plan.md +6 -20
- package/{commands/pan → pan-wizard-core/workflows}/focus-scan.md +3 -16
- package/{commands/pan → pan-wizard-core/workflows}/focus-sync.md +7 -21
- package/pan-wizard-core/workflows/health.md +6 -0
- package/pan-wizard-core/workflows/help.md +114 -77
- package/pan-wizard-core/workflows/insert-phase.md +4 -6
- package/pan-wizard-core/workflows/learn.md +3 -3
- package/pan-wizard-core/workflows/milestone-audit.md +2 -2
- package/pan-wizard-core/workflows/milestone-new.md +38 -95
- package/pan-wizard-core/workflows/new-project.md +96 -258
- package/pan-wizard-core/workflows/optimize.md +107 -5
- package/pan-wizard-core/workflows/phase-tests.md +10 -0
- package/pan-wizard-core/workflows/plan-phase.md +106 -45
- package/pan-wizard-core/workflows/profile.md +50 -0
- package/pan-wizard-core/workflows/progress.md +10 -0
- package/pan-wizard-core/workflows/quick.md +34 -43
- package/pan-wizard-core/workflows/remove-phase.md +11 -1
- package/pan-wizard-core/workflows/research-phase.md +118 -40
- package/pan-wizard-core/workflows/resume-project.md +18 -2
- package/pan-wizard-core/workflows/settings.md +33 -19
- package/pan-wizard-core/workflows/todo-check.md +6 -2
- package/pan-wizard-core/workflows/transition.md +22 -4
- package/pan-wizard-core/workflows/uat-walkthrough.md +90 -0
- package/pan-wizard-core/workflows/update.md +1 -1
- package/pan-wizard-core/workflows/verify-phase.md +39 -46
- package/scripts/build-agent-plugin.js +35 -15
- package/scripts/build-help.cjs +106 -0
- package/scripts/build-plugin.js +10 -1
- package/scripts/deprecate-old-versions.js +70 -3
- package/scripts/generate-skills-docs.py +1 -1
- package/scripts/git-hooks/pre-push +27 -0
- package/scripts/install-git-hooks.js +7 -5
- package/scripts/install-pre-push.cjs +38 -0
- package/scripts/land.cjs +151 -0
- package/scripts/local-ci.cjs +501 -0
- package/scripts/local-schedule.cjs +277 -0
- package/scripts/mutation-probe.cjs +7 -80
- package/scripts/prompt-lint.cjs +32 -0
- package/scripts/prompt-rules.cjs +156 -0
- package/scripts/run-tests.cjs +7 -1
- package/scripts/test-quality-lint.cjs +3 -3
- package/scripts/test-surface.cjs +175 -6
- package/agents/pan-research-synthesizer.md +0 -246
- package/commands/pan/audit-deployment.md +0 -386
- package/commands/pan/dashboard.md +0 -22
- package/commands/pan/discord.md +0 -19
- package/commands/pan/mcp-bridge.md +0 -143
- package/commands/pan/milestone-cleanup.md +0 -19
- package/commands/pan/milestone-gaps.md +0 -35
- package/commands/pan/optimize.md +0 -115
- package/commands/pan/profile.md +0 -76
- package/commands/pan/research-phase.md +0 -189
- package/pan-wizard-core/bin/lib/bridge.cjs +0 -269
- package/pan-wizard-core/templates/research-project/architecture.md +0 -204
- package/pan-wizard-core/templates/research-project/features.md +0 -147
- package/pan-wizard-core/templates/research-project/pitfalls.md +0 -200
- package/pan-wizard-core/templates/research-project/stack.md +0 -120
- package/pan-wizard-core/templates/research-project/summary.md +0 -170
|
@@ -0,0 +1,860 @@
|
|
|
1
|
+
# Feature Specification: Help Document & Commands End-to-End Rewrite
|
|
2
|
+
|
|
3
|
+
**Feature ID:** help-rewrite-v1
|
|
4
|
+
**Date:** 2026-03-02
|
|
5
|
+
**Mode:** `--full` (all 10 phases)
|
|
6
|
+
**Author:** Claude (focus-design pipeline)
|
|
7
|
+
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
## Phase 0: Problem Framing & Demand Validation
|
|
11
|
+
|
|
12
|
+
### 0.1 Problem Statement
|
|
13
|
+
|
|
14
|
+
PAN Wizard's help document (`/pan:help`) and command descriptions are not client-friendly. The current help output is a 380-line static markdown dump that reads like internal developer documentation rather than user-facing reference material. New users face a wall of 37 commands across 8 groups with descriptions written in implementation language ("wave-based parallelization", "UAT", "context handoff") rather than outcome-oriented plain English. The command naming is inconsistent (5 Focus commands lack the `pan:` prefix, `patches.md` is missing frontmatter fields entirely), and the help document mixes quick-reference tables with detailed prose explanations in a single undifferentiated stream, making it impossible to quickly find what you need.
|
|
15
|
+
|
|
16
|
+
This matters NOW because PAN Wizard just shipped v2.2.0 with 87 internal subcommands and 37 user-facing slash commands across 5 runtimes. The gap between the tool's power and its accessibility is the primary adoption barrier. The cost of NOT doing this is that every new user's first experience with PAN is information overload followed by confusion.
|
|
17
|
+
|
|
18
|
+
### 0.2 Demand Evidence
|
|
19
|
+
|
|
20
|
+
| Evidence Type | Source | Finding |
|
|
21
|
+
|--------------|--------|---------|
|
|
22
|
+
| User-stated pain | This conversation | User says: "the help document and commands are not good and not client friendly" — direct request for end-to-end rewrite |
|
|
23
|
+
| Competitive parity | GitHub Copilot CLI (GA Feb 2026) | Ships with 4 functional groups, dropdown-on-slash discovery, `/changelog` for version discovery — PAN's flat dump falls behind |
|
|
24
|
+
| Community pattern | Claude Code ecosystem (DEV.to article) | Claude Code's own `/help` criticized for hidden commands, flat listing, no grouping — community created unofficial organized guides. PAN inherits the same problem |
|
|
25
|
+
| Industry best practice | clig.dev CLI Guidelines | Explicitly recommends: categorical grouping, progressive disclosure, outcome-oriented descriptions, argument hints — PAN violates all four |
|
|
26
|
+
|
|
27
|
+
### 0.3 Scope Definition
|
|
28
|
+
|
|
29
|
+
| In Scope | Out of Scope (and why) |
|
|
30
|
+
|----------|------------------------|
|
|
31
|
+
| Rewrite help.md workflow content | Adding new commands (separate feature work) |
|
|
32
|
+
| Rewrite all 37 command frontmatter descriptions | Changing command behavior or implementation |
|
|
33
|
+
| Fix naming inconsistencies (pan: prefix, patches.md) | Renaming commands (already done in v0.9.0, session 16) |
|
|
34
|
+
| Standardize argument-hint format | Changing argument parsing logic |
|
|
35
|
+
| Add progressive disclosure (quick ref vs detail) | Adding interactive help (would require new module) |
|
|
36
|
+
| Redesign group structure and names | Adding new groups or removing existing ones |
|
|
37
|
+
| Update CLI-REFERENCE.md, USER-GUIDE.md in sync | Rewriting ARCHITECTURE.md or DEVELOPMENT.md |
|
|
38
|
+
| Propagate to all 5 runtime directories | Changing installer behavior |
|
|
39
|
+
|
|
40
|
+
### 0.4 Success Criteria (Measurable)
|
|
41
|
+
|
|
42
|
+
```
|
|
43
|
+
SC-1: A new user can find the right command for their task within 10 seconds of reading /pan:help
|
|
44
|
+
SC-2: Every command description answers "what does this DO for me?" in plain English (no jargon)
|
|
45
|
+
SC-3: All 37 commands have consistent frontmatter (name with pan: prefix, group, description, argument-hint where applicable)
|
|
46
|
+
SC-4: Help document has clear layered structure: one-liner overview → grouped quick-ref → detailed sections (progressive disclosure)
|
|
47
|
+
SC-5: No regression in existing tests (1139/1139 pass)
|
|
48
|
+
SC-6: All 5 runtime directories receive identical updates
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
### 0.5 User Stories
|
|
52
|
+
|
|
53
|
+
```
|
|
54
|
+
US-1: As a developer who just installed PAN Wizard, I want to run /pan:help and immediately
|
|
55
|
+
understand what PAN does and which command to run first, so that I can start my first
|
|
56
|
+
project without reading external docs, instead of being overwhelmed by a wall of 37 commands.
|
|
57
|
+
|
|
58
|
+
US-2: As a developer mid-project who forgot the exact command name, I want to scan the help
|
|
59
|
+
output by group and find my command in 5 seconds, so that I don't lose my train of thought,
|
|
60
|
+
instead of scrolling through 380 lines of mixed tables and prose.
|
|
61
|
+
|
|
62
|
+
US-3: As a developer evaluating PAN vs competitors, I want the help output to clearly
|
|
63
|
+
communicate PAN's value proposition and workflow model, so that I understand why PAN
|
|
64
|
+
is worth learning, instead of seeing dense technical jargon that reads like internal docs.
|
|
65
|
+
|
|
66
|
+
US-4: As a developer using Focus commands on a brownfield project, I want the help output to
|
|
67
|
+
clearly separate the Focus workflow from the Phase Lifecycle workflow, so that I understand
|
|
68
|
+
which commands apply to my situation, instead of trying to figure out which of 37 commands
|
|
69
|
+
I actually need.
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
### 0.6 Cannibalization Check
|
|
73
|
+
|
|
74
|
+
| Existing Command/Agent | Overlap? | Impact |
|
|
75
|
+
|-----------------------|----------|--------|
|
|
76
|
+
| `/pan:help` | Full (this IS the target) | Rewrite in place |
|
|
77
|
+
| `/pan:progress` | None | Shows project state, not command reference |
|
|
78
|
+
| `/pan:settings` | None | Shows config, not help |
|
|
79
|
+
| USER-GUIDE.md | Partial | Both document commands; help = quick ref, guide = tutorial |
|
|
80
|
+
| CLI-REFERENCE.md | Partial | CLI-REF covers internal 87 subcommands; help covers 37 user slash commands |
|
|
81
|
+
|
|
82
|
+
**Full overlap:** `/pan:help` is the target — this is an enhancement, not a new command.
|
|
83
|
+
|
|
84
|
+
### 0.7 Cognitive Load Assessment
|
|
85
|
+
|
|
86
|
+
| Metric | Before | After | Delta |
|
|
87
|
+
|--------|--------|-------|-------|
|
|
88
|
+
| Commands a new user must learn | 37 (all presented equally) | 6 (highlighted starter set) | -31 initial |
|
|
89
|
+
| New concepts introduced | 0 | 0 | 0 |
|
|
90
|
+
| Score | — | — | simplifies (-1) |
|
|
91
|
+
|
|
92
|
+
---
|
|
93
|
+
|
|
94
|
+
## Phase 1: Internal Reconnaissance
|
|
95
|
+
|
|
96
|
+
### 1.1 Architecture Scan — Existing Capabilities Inventory
|
|
97
|
+
|
|
98
|
+
| Capability | Status | Location | Relevance |
|
|
99
|
+
|------------|--------|----------|-----------|
|
|
100
|
+
| Help workflow | Exists | `pan-wizard-core/workflows/help.md` | Target for rewrite |
|
|
101
|
+
| Help command | Exists | `commands/pan/help.md` | Orchestrator — loads workflow |
|
|
102
|
+
| Command frontmatter | Exists | 37 files in `commands/pan/*.md` | Descriptions need rewrite |
|
|
103
|
+
| Group system | Exists | Frontmatter `group:` field | 8 groups defined |
|
|
104
|
+
| Argument hints | Partial | Frontmatter `argument-hint:` field | 5 Focus commands missing hints |
|
|
105
|
+
| CLI-REFERENCE | Exists | `docs/CLI-REFERENCE.md` | Must stay in sync |
|
|
106
|
+
| USER-GUIDE | Exists | `docs/USER-GUIDE.md` | Must stay in sync |
|
|
107
|
+
| Runtime propagation | Exists | Installer handles 5 runtimes | All changes must propagate |
|
|
108
|
+
|
|
109
|
+
### 1.2 Current Help Document Analysis
|
|
110
|
+
|
|
111
|
+
**Structure (380 lines):**
|
|
112
|
+
1. Title + tagline (2 lines)
|
|
113
|
+
2. Two Workflows overview (46 lines) — good concept, too much detail
|
|
114
|
+
3. Focus Commands In Detail (98 lines) — full flags/modes documentation mid-help
|
|
115
|
+
4. All Commands table (70 lines) — 8 groups, terse descriptions
|
|
116
|
+
5. Common Patterns (40 lines) — useful but buried
|
|
117
|
+
6. Phase Lifecycle Detail (20 lines) — per-command prose
|
|
118
|
+
7. Milestone Management Detail (12 lines)
|
|
119
|
+
8. Session & Debugging Detail (12 lines)
|
|
120
|
+
9. Configuration (10 lines)
|
|
121
|
+
10. Files & Structure (25 lines)
|
|
122
|
+
11. Staying Updated + Getting Help (10 lines)
|
|
123
|
+
|
|
124
|
+
**Problems identified:**
|
|
125
|
+
1. **No progressive disclosure** — everything dumped at once (380 lines)
|
|
126
|
+
2. **Focus Commands get 98 lines of detail before the command table** — buries the overview
|
|
127
|
+
3. **Descriptions use jargon** — "wave-based parallelization", "UAT", "context handoff", "Reality Score filtering"
|
|
128
|
+
4. **No "start here" guidance** — new users see 37 commands with no clear entry point
|
|
129
|
+
5. **Common Patterns buried at line 230** — most useful section least discoverable
|
|
130
|
+
6. **Mixing quick-ref and deep-dive** — tables and prose interleaved without visual hierarchy
|
|
131
|
+
|
|
132
|
+
### 1.3 Command Frontmatter Issues Found
|
|
133
|
+
|
|
134
|
+
| Issue | Files Affected | Fix |
|
|
135
|
+
|-------|---------------|-----|
|
|
136
|
+
| Missing `pan:` prefix on `name` | focus-design, focus-exec, focus-plan, focus-scan, focus-sync (5) | Add `pan:` prefix |
|
|
137
|
+
| Missing `name` field entirely | patches.md (1) | Add `name: pan:patches` |
|
|
138
|
+
| Missing `group` field | patches.md (1) | Add `group: System` |
|
|
139
|
+
| Verbose `argument-hint` | map-codebase, milestone-new, todo-add, verify-phase (4) | Shorten to token format |
|
|
140
|
+
| Stray `</output>` tag | help.md (1) | Remove tag |
|
|
141
|
+
| Extra unique fields | milestone-done (`type:`), plan-phase (`agent:`), phase-tests (`argument-instructions:`) (3) | Leave as-is (harmless) |
|
|
142
|
+
|
|
143
|
+
### 1.4 Convention Enforcement Checklist
|
|
144
|
+
|
|
145
|
+
- [x] Function naming convention followed — N/A (content-only change)
|
|
146
|
+
- [x] File reads use safe read pattern — N/A
|
|
147
|
+
- [x] File writes wrapped in try-catch — N/A
|
|
148
|
+
- [x] JSON output via standard output function — N/A
|
|
149
|
+
- [x] Errors via standard error function — N/A
|
|
150
|
+
- [x] Paths in output pass through normalization — N/A
|
|
151
|
+
- [x] Module exports at bottom — N/A
|
|
152
|
+
- [x] Subcommands dispatched via standard routing — N/A
|
|
153
|
+
- [x] Module format CommonJS — N/A
|
|
154
|
+
- [x] Zero runtime dependencies — N/A (content-only)
|
|
155
|
+
|
|
156
|
+
### 1.5 Dependency & Integration Map
|
|
157
|
+
|
|
158
|
+
```
|
|
159
|
+
[Help Rewrite]
|
|
160
|
+
├── modifies: pan-wizard-core/workflows/help.md
|
|
161
|
+
├── modifies: 37 x commands/pan/*.md (frontmatter only)
|
|
162
|
+
├── modifies: docs/CLI-REFERENCE.md (description sync)
|
|
163
|
+
├── modifies: docs/USER-GUIDE.md (description sync)
|
|
164
|
+
├── propagates to: .claude/, .github/, .opencode/, .gemini/, .codex/
|
|
165
|
+
├── depends on: nothing (content-only)
|
|
166
|
+
├── conflicts with: nothing
|
|
167
|
+
└── enables: better onboarding, reduced support questions
|
|
168
|
+
```
|
|
169
|
+
|
|
170
|
+
---
|
|
171
|
+
|
|
172
|
+
## Phase 2: Competitive Intelligence
|
|
173
|
+
|
|
174
|
+
### 2.1 Deep-Dive Research (6 Tools)
|
|
175
|
+
|
|
176
|
+
| Tool | Help Structure | Command Naming | Discoverability | Strengths | Weaknesses |
|
|
177
|
+
|------|---------------|----------------|-----------------|-----------|------------|
|
|
178
|
+
| **Aider** | Flat alphabetical table of 46 commands | Lowercase, hyphenated, short | `/help <question>` AI-powered | AI help answers questions naturally | 46-command flat list is dense |
|
|
179
|
+
| **Cursor** | VS Code Command Palette | Filename-based custom commands | Palette search | Seamless IDE integration | No built-in `/help` in chat |
|
|
180
|
+
| **Continue.dev** | Dropdown-on-`/` with descriptions | Ultra-short verbs (`/edit`, `/share`) | Live searchable dropdown | Dropdown surfaces all commands on demand | Only 6 built-in — limited |
|
|
181
|
+
| **Cline** | Sidebar GUI, minimal CLI | Short single words (`/settings`) | GUI-based exploration | Visual discovery | No command reference |
|
|
182
|
+
| **Claude Code** | Flat merged list in `/help` | Lowercase, hyphenated | `/help` lists all commands | Merges custom + built-in | Hidden undocumented commands, no grouping |
|
|
183
|
+
| **GitHub Copilot CLI** | 4 functional groups in docs + dropdown | Consistent verb-noun hyphenated | Dropdown-on-`/` + grouped docs | Clearest categorical organization | New, less community feedback |
|
|
184
|
+
|
|
185
|
+
### 2.2 Best-in-Class Help Patterns Identified
|
|
186
|
+
|
|
187
|
+
1. **Progressive disclosure** (Copilot CLI): Quick overview → grouped tables → detail sections
|
|
188
|
+
2. **Outcome-oriented descriptions** (Continue.dev): "Edit code" not "Execute code modification with conflict resolution"
|
|
189
|
+
3. **Starter command highlighting** (all tools): Clear "start here" guidance
|
|
190
|
+
4. **Categorical grouping** (Copilot CLI): 4 functional categories vs flat list
|
|
191
|
+
5. **Common patterns section early** (Aider): Recipe-style workflows as primary discovery
|
|
192
|
+
6. **AI-powered help** (Aider): `/help <question>` for natural language queries
|
|
193
|
+
|
|
194
|
+
### 2.3 Competitive Matrix
|
|
195
|
+
|
|
196
|
+
| Aspect | PAN (Current) | PAN (Target) | Aider | Continue | Copilot CLI | Claude Code |
|
|
197
|
+
|--------|--------------|-------------|-------|----------|-------------|-------------|
|
|
198
|
+
| Grouping | 8 groups, presented flat | 4-5 groups, progressive | None | None (tiny count) | 4 groups | None |
|
|
199
|
+
| Descriptions | Jargon-heavy | Plain English, outcome-focused | Terse but clear | Short verbs | Clear, concise | Mixed quality |
|
|
200
|
+
| Progressive disclosure | None (380-line dump) | 3-tier (overview→table→detail) | Single table | N/A (6 commands) | Grouped cheat sheet | Single list |
|
|
201
|
+
| Start-here guidance | None | Clear onboarding path | `/help <q>` | Tiny surface area | Getting started section | `/init` |
|
|
202
|
+
| Common patterns | Buried line 230 | Top section | Not in help | N/A | Cheat sheet format | Not in help |
|
|
203
|
+
|
|
204
|
+
---
|
|
205
|
+
|
|
206
|
+
## Phase 3: Strategic Analysis
|
|
207
|
+
|
|
208
|
+
### 3.1 Blue Ocean Four Actions Framework
|
|
209
|
+
|
|
210
|
+
| Action | Question | Decisions |
|
|
211
|
+
|--------|----------|-----------|
|
|
212
|
+
| **ELIMINATE** | What should we drop? | Drop 98 lines of Focus detail from the quick reference section. Drop interleaved prose between tables. Drop the "Files & Structure" section (move to USER-GUIDE). Drop verbose argument hints. |
|
|
213
|
+
| **REDUCE** | What should be reduced? | Reduce help output from 380 lines to ~150 lines. Reduce descriptions from sentences to one-liners. Reduce groups from 8 to 5 (merge Getting Started into Phase Lifecycle, merge Community into System). |
|
|
214
|
+
| **RAISE** | What should be raised? | Raise discoverability via "Start Here" section. Raise workflow clarity via decision tree. Raise description quality to outcome-oriented plain English. |
|
|
215
|
+
| **CREATE** | What should we create? | Create 3-tier progressive disclosure (overview → grouped quick-ref → detail on demand). Create "Which workflow fits you?" decision tree. Create consistent argument-hint format across all 37 commands. |
|
|
216
|
+
|
|
217
|
+
### 3.2 Wardley Evolution Assessment
|
|
218
|
+
|
|
219
|
+
```
|
|
220
|
+
Genesis ──── Custom-Built ──── Product ──── Commodity
|
|
221
|
+
^
|
|
222
|
+
CLI Help Systems
|
|
223
|
+
```
|
|
224
|
+
|
|
225
|
+
Help systems are in the **Product** stage — well-understood patterns exist (clig.dev guidelines, man pages, `--help` conventions). PAN should not innovate here; it should adopt best practices flawlessly. The unique angle is the 2-workflow structure (Phase Lifecycle vs Focus) which requires clear workflow routing — something no competitor has because they don't have two distinct operating modes.
|
|
226
|
+
|
|
227
|
+
### 3.3 Strategic Moat Analysis
|
|
228
|
+
|
|
229
|
+
| Moat Type | Contribution | Score (0-5) |
|
|
230
|
+
|-----------|-------------|-------------|
|
|
231
|
+
| **Context Engineering** | Better help = better AI context when user asks for guidance | 3 |
|
|
232
|
+
| **Cross-Platform** | Consistent help across 5 runtimes | 4 |
|
|
233
|
+
| **Developer Experience** | First impression of PAN — critical for adoption | 5 |
|
|
234
|
+
| **Zero Dependencies** | N/A (content-only change) | 0 |
|
|
235
|
+
| **State Persistence** | N/A | 0 |
|
|
236
|
+
| **Verification Quality** | N/A | 0 |
|
|
237
|
+
|
|
238
|
+
### 3.4 Strategic Recommendation
|
|
239
|
+
|
|
240
|
+
**Build this — high priority.** The help document is the single most-viewed artifact in PAN Wizard. Every user interaction starts with `/pan:help` or browsing command descriptions. The current help fails at its primary job: helping users find the right command quickly. The rewrite requires zero code changes — it's pure content work with high impact and minimal risk. The unique angle is PAN's dual-workflow model (Phase Lifecycle vs Focus), which is genuinely novel among AI coding tools but currently poorly communicated. The timing is ideal: PAN v2.2.0 just shipped with full standards integration, making this the right moment to polish the user-facing layer before broader adoption push.
|
|
241
|
+
|
|
242
|
+
---
|
|
243
|
+
|
|
244
|
+
## Phase 3.5: Architecture & Implementation Pattern Assessment
|
|
245
|
+
|
|
246
|
+
### 3.5.1 Feature Type Classification
|
|
247
|
+
|
|
248
|
+
**Type: Content Enhancement** — modify existing workflow file + command frontmatter. No new modules, commands, agents, or hooks.
|
|
249
|
+
|
|
250
|
+
### 3.5.2 Layer Violation Check
|
|
251
|
+
|
|
252
|
+
- [x] No layer violations possible — content-only changes to .md files
|
|
253
|
+
- [x] No code imports or dependencies added
|
|
254
|
+
- [x] No dispatcher changes
|
|
255
|
+
|
|
256
|
+
### 3.5.3 Output Contract Design
|
|
257
|
+
|
|
258
|
+
N/A — help output is human-readable markdown, not JSON. The help command's output contract is "display the workflow file content as-is."
|
|
259
|
+
|
|
260
|
+
### 3.5.4 State Transition Modeling
|
|
261
|
+
|
|
262
|
+
N/A — no state mutations.
|
|
263
|
+
|
|
264
|
+
### 3.5.5 Breaking Change Assessment
|
|
265
|
+
|
|
266
|
+
| Question | Answer |
|
|
267
|
+
|----------|--------|
|
|
268
|
+
| Changes any existing command's output schema? | No |
|
|
269
|
+
| Changes file formats? | No (still markdown) |
|
|
270
|
+
| Changes directory structure? | No |
|
|
271
|
+
| Changes installer output? | No |
|
|
272
|
+
|
|
273
|
+
### 3.5.6 Composability Analysis
|
|
274
|
+
|
|
275
|
+
N/A — help is a read-only display command.
|
|
276
|
+
|
|
277
|
+
### 3.5.7 Performance Budget
|
|
278
|
+
|
|
279
|
+
| Operation | Cost | Notes |
|
|
280
|
+
|-----------|------|-------|
|
|
281
|
+
| File read (help.md) | ~5ms | Single workflow file |
|
|
282
|
+
| Display output | ~1ms | Pass-through |
|
|
283
|
+
| **Total** | **< 10ms** | No computation |
|
|
284
|
+
|
|
285
|
+
### 3.5.8 Cross-Platform Considerations
|
|
286
|
+
|
|
287
|
+
| Platform | Consideration |
|
|
288
|
+
|----------|---------------|
|
|
289
|
+
| All | Markdown rendering in terminal — keep lines under 100 chars for wrapping |
|
|
290
|
+
| All | Table alignment — use consistent column widths |
|
|
291
|
+
| All 5 runtimes | Same content, different file locations (installer handles propagation) |
|
|
292
|
+
| Gemini CLI | TOML format for commands — frontmatter changes need TOML conversion |
|
|
293
|
+
|
|
294
|
+
---
|
|
295
|
+
|
|
296
|
+
## Phase 4: Design Synthesis
|
|
297
|
+
|
|
298
|
+
### 4.1 Guide-Level Explanation (User-Facing)
|
|
299
|
+
|
|
300
|
+
When you type `/pan:help`, you'll see a concise, layered reference designed to get you to the right command fast:
|
|
301
|
+
|
|
302
|
+
**Layer 1 — The 10-Second Overview** (what PAN is + which workflow to pick):
|
|
303
|
+
```
|
|
304
|
+
PAN — Project Automation Navigator
|
|
305
|
+
|
|
306
|
+
New project? → /pan:new-project
|
|
307
|
+
Existing project? → /pan:focus-scan
|
|
308
|
+
```
|
|
309
|
+
|
|
310
|
+
**Layer 2 — Grouped Quick Reference** (~37 commands in 5 groups, each with a plain-English one-liner):
|
|
311
|
+
```
|
|
312
|
+
Phase Lifecycle: new-project, plan-phase, exec-phase, verify-phase, progress
|
|
313
|
+
Focus Pipeline: focus-scan, focus-plan, focus-exec, focus-sync, focus-design
|
|
314
|
+
Phase Tools: add-phase, insert-phase, remove-phase, assumptions, phase-tests, phase-budget
|
|
315
|
+
Milestones: milestone-new, milestone-done, milestone-audit, milestone-gaps, milestone-cleanup
|
|
316
|
+
Session & System: quick, pause, resume, profile, help, health, settings, update, debug, todo-add, todo-check, discord, patches
|
|
317
|
+
```
|
|
318
|
+
|
|
319
|
+
**Layer 3 — Common Recipes** (the 7 most common workflows as copy-paste patterns):
|
|
320
|
+
```
|
|
321
|
+
New project: /pan:new-project → /pan:plan-phase 1 → /pan:exec-phase 1
|
|
322
|
+
Iterative work: /pan:focus-scan → /pan:focus-plan → /pan:focus-exec
|
|
323
|
+
Design a feature: /pan:focus-design "description"
|
|
324
|
+
```
|
|
325
|
+
|
|
326
|
+
**Layer 4 — Detailed Reference** (per-group command details — only for users who need it).
|
|
327
|
+
|
|
328
|
+
### 4.2 Reference-Level Explanation (Technical)
|
|
329
|
+
|
|
330
|
+
#### 4.2.1 Help Document Structure (New)
|
|
331
|
+
|
|
332
|
+
```
|
|
333
|
+
Section 1: Title + One-Line Tagline (3 lines)
|
|
334
|
+
Section 2: Quick Start Decision Tree (10 lines)
|
|
335
|
+
Section 3: Two Workflows Overview (15 lines — summary only, not full flag docs)
|
|
336
|
+
Section 4: Common Recipes (25 lines — most useful section, placed early)
|
|
337
|
+
Section 5: All Commands Quick Reference (50 lines — 5 grouped tables, outcome-oriented one-liners)
|
|
338
|
+
Section 6: Focus Pipeline Detail (30 lines — flags/modes, condensed from 98 lines)
|
|
339
|
+
Section 7: Phase Lifecycle Detail (20 lines)
|
|
340
|
+
Section 8: Configuration + Files (15 lines — condensed)
|
|
341
|
+
Section 9: Getting Help + Updates (5 lines)
|
|
342
|
+
```
|
|
343
|
+
|
|
344
|
+
**Total: ~175 lines** (down from 380 — 54% reduction)
|
|
345
|
+
|
|
346
|
+
#### 4.2.2 Description Style Guide
|
|
347
|
+
|
|
348
|
+
**Before (jargon-heavy):**
|
|
349
|
+
- "Execute all plans in a phase with wave-based parallelization"
|
|
350
|
+
- "Validate built features through conversational UAT"
|
|
351
|
+
- "Create context handoff when pausing work mid-phase"
|
|
352
|
+
- "Deep-dive strategic work scan with prioritized items and Reality Score filtering"
|
|
353
|
+
|
|
354
|
+
**After (outcome-oriented):**
|
|
355
|
+
- "Build your phase — runs all plans, commits each task"
|
|
356
|
+
- "Test what was built against what was planned"
|
|
357
|
+
- "Save your place so you can pick up later"
|
|
358
|
+
- "Find everything that needs work, ranked by impact"
|
|
359
|
+
|
|
360
|
+
**Rules:**
|
|
361
|
+
1. Start with a verb that describes the USER outcome, not the internal mechanism
|
|
362
|
+
2. Max 10 words for the quick-reference description
|
|
363
|
+
3. No acronyms (UAT, RS, ADR) in descriptions — spell out or avoid
|
|
364
|
+
4. No implementation details (wave-based, parallel agents, MICRO tier)
|
|
365
|
+
5. Use "you" language where natural ("Save your place", "Check your progress")
|
|
366
|
+
|
|
367
|
+
#### 4.2.3 Group Restructure
|
|
368
|
+
|
|
369
|
+
**Current (8 groups):**
|
|
370
|
+
Getting Started (2), Phase Lifecycle (5), Phase Management (6), Session & Progress (5), Milestone (5), Focus (5), System (7), Community (2)
|
|
371
|
+
|
|
372
|
+
**Proposed (5 groups):**
|
|
373
|
+
|
|
374
|
+
| Group | Commands | Count | Rationale |
|
|
375
|
+
|-------|----------|-------|-----------|
|
|
376
|
+
| **Start & Plan** | new-project, map-codebase, discuss-phase, plan-phase, research-phase, assumptions | 6 | Everything before building |
|
|
377
|
+
| **Build & Verify** | exec-phase, verify-phase, quick, phase-tests, phase-budget | 5 | Everything about doing the work |
|
|
378
|
+
| **Focus Pipeline** | focus-scan, focus-plan, focus-exec, focus-sync, focus-design | 5 | Brownfield workflow (kept distinct) |
|
|
379
|
+
| **Milestones & Phases** | milestone-new, milestone-done, milestone-audit, milestone-gaps, milestone-cleanup, add-phase, insert-phase, remove-phase, progress | 9 | Project structure management |
|
|
380
|
+
| **Session & System** | pause, resume, profile, help, health, settings, update, debug, todo-add, todo-check, discord, patches | 12 | Tools and settings |
|
|
381
|
+
|
|
382
|
+
**Why 5 not 8:** Fewer groups = faster scanning. "Getting Started" (2 commands) and "Community" (2 commands) are too small to justify their own groups. Phase Management commands naturally group with Milestones since both manage project structure.
|
|
383
|
+
|
|
384
|
+
### 4.3 Command Description Rewrites (All 37)
|
|
385
|
+
|
|
386
|
+
| Command | Current Description | Proposed Description |
|
|
387
|
+
|---------|--------------------|--------------------|
|
|
388
|
+
| `/pan:new-project` | Initialize a new project with deep context gathering and project.md | Start a new project — vision, requirements, roadmap |
|
|
389
|
+
| `/pan:map-codebase` | Analyze codebase with parallel mapper agents to produce .planning/codebase/ documents | Map an existing codebase before starting |
|
|
390
|
+
| `/pan:discuss-phase` | Gather phase context through adaptive questioning before planning | Talk through a phase before planning it |
|
|
391
|
+
| `/pan:plan-phase` | Create detailed phase plan (plan.md) with verification loop | Create a detailed plan for a phase |
|
|
392
|
+
| `/pan:research-phase` | Research how to implement a phase (standalone - usually use /pan:plan-phase instead) | Deep research for specialized domains |
|
|
393
|
+
| `/pan:assumptions` | Surface Claude's assumptions about a phase approach before planning | See the planned approach before committing |
|
|
394
|
+
| `/pan:exec-phase` | Execute all plans in a phase with wave-based parallelization | Build your phase — runs all plans, commits each task |
|
|
395
|
+
| `/pan:verify-phase` | Validate built features through conversational UAT | Test what was built against what was planned |
|
|
396
|
+
| `/pan:quick` | Execute a quick task with PAN guarantees (atomic commits, state tracking) but skip optional agents | Do a small task with automatic commits |
|
|
397
|
+
| `/pan:phase-tests` | Generate tests for a completed phase based on UAT criteria and implementation | Generate tests for a completed phase |
|
|
398
|
+
| `/pan:phase-budget` | Estimate context utilization and quality for the current phase | Check how much context this phase needs |
|
|
399
|
+
| `/pan:progress` | Check project progress, show context, and route to next action (execute or plan) | Check your progress and see what's next |
|
|
400
|
+
| `/pan:add-phase` | Add phase to end of current milestone in roadmap | Add a new phase to your roadmap |
|
|
401
|
+
| `/pan:insert-phase` | Insert urgent work as decimal phase (e.g., 72.1) between existing phases | Insert urgent work between phases |
|
|
402
|
+
| `/pan:remove-phase` | Remove a future phase from roadmap and renumber subsequent phases | Remove a phase and renumber the rest |
|
|
403
|
+
| `/pan:milestone-new` | Start a new milestone cycle — update project.md and route to requirements | Start a new milestone cycle |
|
|
404
|
+
| `/pan:milestone-done` | Archive completed milestone and prepare for next version | Archive a completed milestone |
|
|
405
|
+
| `/pan:milestone-audit` | Audit milestone completion against original intent before archiving | Check if a milestone is really done |
|
|
406
|
+
| `/pan:milestone-gaps` | Create phases to close all gaps identified by milestone audit | Create phases to close audit gaps |
|
|
407
|
+
| `/pan:milestone-cleanup` | Archive accumulated phase directories from completed milestones | Clean up old phase directories |
|
|
408
|
+
| `/pan:focus-scan` | Deep-dive strategic work scan with prioritized items and Reality Score filtering | Find everything that needs work, ranked by impact |
|
|
409
|
+
| `/pan:focus-plan` | Create capacity-budgeted work batch with 4 execution modes | Pick a right-sized batch of work to do next |
|
|
410
|
+
| `/pan:focus-exec` | Automated batch execution pipeline with 6 stages, 9 behavioral rules, 3 execution tiers | Implement the batch — build, test, verify, commit |
|
|
411
|
+
| `/pan:focus-sync` | Synchronize documentation after changes — check staleness and update counts | Update docs to match your changes |
|
|
412
|
+
| `/pan:focus-design` | Strategic 10-phase feature investigation, design, and specification pipeline | Design a new feature from research to spec |
|
|
413
|
+
| `/pan:pause` | Create context handoff when pausing work mid-phase | Save your place so you can pick up later |
|
|
414
|
+
| `/pan:resume` | Resume work from previous session with full context restoration | Pick up where you left off |
|
|
415
|
+
| `/pan:profile` | Switch model profile for PAN agents (quality/balanced/budget) | Switch AI model profile (quality/balanced/budget) |
|
|
416
|
+
| `/pan:help` | Show available PAN commands and usage guide | Show this command reference |
|
|
417
|
+
| `/pan:health` | Diagnose planning directory health and optionally repair issues | Check and repair planning files |
|
|
418
|
+
| `/pan:settings` | Configure PAN workflow toggles and model profile | Configure PAN settings |
|
|
419
|
+
| `/pan:update` | Update PAN to latest version with changelog display | Update PAN to the latest version |
|
|
420
|
+
| `/pan:debug` | Systematic debugging with persistent state across context resets | Debug an issue (survives /clear) |
|
|
421
|
+
| `/pan:todo-add` | Capture idea or task as todo from current conversation context | Save an idea or task for later |
|
|
422
|
+
| `/pan:todo-check` | List pending todos and select one to work on | See your pending todos |
|
|
423
|
+
| `/pan:discord` | Join the PAN Discord community | Join the PAN community |
|
|
424
|
+
| `/pan:patches` | Reapply local modifications after a PAN update | Reapply your customizations after updating |
|
|
425
|
+
|
|
426
|
+
### 4.4 Argument-Hint Standardization
|
|
427
|
+
|
|
428
|
+
| Command | Current | Proposed |
|
|
429
|
+
|---------|---------|---------|
|
|
430
|
+
| `map-codebase` | `[optional: specific area to map, e.g., 'api' or 'auth']` | `[area]` |
|
|
431
|
+
| `milestone-new` | `[milestone name, e.g., 'v1.1 Notifications']` | `[name]` |
|
|
432
|
+
| `todo-add` | `[optional description]` | `[description]` |
|
|
433
|
+
| `verify-phase` | `[phase number, e.g., '4']` | `[phase]` |
|
|
434
|
+
| `focus-scan` | _(missing)_ | `[--quick] [--lean] [--focus <area>]` |
|
|
435
|
+
| `focus-plan` | _(missing)_ | `[--mode <mode>] [--budget N]` |
|
|
436
|
+
| `focus-exec` | _(missing)_ | `[--continue] [--no-commit]` |
|
|
437
|
+
| `focus-sync` | _(missing)_ | `[--all] [--readme]` |
|
|
438
|
+
| `focus-design` | _(missing)_ | `<description> [--internal] [--spike]` |
|
|
439
|
+
|
|
440
|
+
### 4.5 Design Decisions
|
|
441
|
+
|
|
442
|
+
| Decision | Adopted From | Rationale | What We Did NOT Copy (and Why) |
|
|
443
|
+
|----------|-------------|-----------|-------------------------------|
|
|
444
|
+
| 5 groups (from 8) | Copilot CLI (4 groups) | Fewer groups = faster scanning; 5 covers PAN's 2-workflow model | Copilot's exact 4 groups don't map to PAN's domain |
|
|
445
|
+
| Outcome-oriented descriptions | clig.dev, Continue.dev | Users care about what happens, not how | Aider's ultra-terse style (too cryptic for 37 commands) |
|
|
446
|
+
| Common Recipes section early | Aider's recipe patterns | Most useful content should be most visible | Did NOT copy AI-powered help (requires new module, too heavy) |
|
|
447
|
+
| 3-tier progressive disclosure | Copilot CLI cheat sheet | Respects different reading depths | Did NOT copy dropdown-on-slash (requires IDE integration) |
|
|
448
|
+
| Decision tree for workflow routing | Novel (PAN-specific) | PAN's 2-workflow model is unique — needs explicit routing | No competitor has this problem |
|
|
449
|
+
|
|
450
|
+
### 4.6 Drawbacks & Alternatives
|
|
451
|
+
|
|
452
|
+
| Decision Point | Chosen | Alternative | Why Not | Drawback of Chosen |
|
|
453
|
+
|----------------|--------|------------|---------|-------------------|
|
|
454
|
+
| 5 groups | Merge to 5 | Keep 8 groups | 8 groups = 8 visual breaks for only 37 commands; "Getting Started" (2 cmds) and "Community" (2 cmds) are too small | Power users used to current groups need to relearn |
|
|
455
|
+
| Shorter descriptions | 10-word max | Keep technical descriptions | Technical descriptions fail new users | Experienced users may miss precision |
|
|
456
|
+
| Focus detail condensed | 30 lines (from 98) | Keep 98 lines in help | 98 lines of flags/modes in a quick reference is hostile | Users must go to USER-GUIDE for full flag docs |
|
|
457
|
+
| Decision tree at top | New addition | No routing guidance | PAN's 2-workflow model is the #1 confusion point | Adds 10 lines to the top |
|
|
458
|
+
|
|
459
|
+
### 4.7 Feature Ladder (Incremental Delivery)
|
|
460
|
+
|
|
461
|
+
| Version | Scope | Value Delivered | Effort |
|
|
462
|
+
|---------|-------|----------------|--------|
|
|
463
|
+
| **v0 (MVP)** | Rewrite help.md workflow + fix 6 frontmatter issues | Dramatically better help experience | M (4 pts) |
|
|
464
|
+
| **v1 (Complete)** | Rewrite all 37 command descriptions + standardize argument-hints + sync docs | Full consistency across all touchpoints | L (10 pts) |
|
|
465
|
+
| **v2 (Enhanced)** | Propagate to all 5 runtimes + update CLI-REFERENCE + USER-GUIDE sync | Complete cross-runtime consistency | M (4 pts) |
|
|
466
|
+
|
|
467
|
+
### 4.8 Adoption Analysis
|
|
468
|
+
|
|
469
|
+
| Question | Answer |
|
|
470
|
+
|----------|--------|
|
|
471
|
+
| How does the user discover this feature? | `/pan:help` — the same command they already use |
|
|
472
|
+
| What's the learning curve? | Zero — it's the same command, better content |
|
|
473
|
+
| Does it require changing existing workflows? | No |
|
|
474
|
+
| What's the "aha moment"? | Running `/pan:help` and finding the right command in 5 seconds instead of scrolling for 30 |
|
|
475
|
+
|
|
476
|
+
---
|
|
477
|
+
|
|
478
|
+
## Phase 5: Architecture Decision Record
|
|
479
|
+
|
|
480
|
+
See `docs/decisions/ADR-0011-help-commands-rewrite.md` (saved separately).
|
|
481
|
+
|
|
482
|
+
---
|
|
483
|
+
|
|
484
|
+
## Phase 6: Error Handling & Diagnostics Design
|
|
485
|
+
|
|
486
|
+
### 6.1 Failure Mode Analysis
|
|
487
|
+
|
|
488
|
+
| Failure Mode | Category | Detection Pattern | Recovery | User Sees |
|
|
489
|
+
|-------------|----------|-------------------|----------|-----------|
|
|
490
|
+
| help.md workflow file missing | Environment | File read returns empty | Error message | "Help file not found — run /pan:update" |
|
|
491
|
+
| Command .md missing frontmatter | Data corruption | No `name:` field | Skip in listing | Command omitted from help |
|
|
492
|
+
|
|
493
|
+
### 6.2 Diagnostic Support
|
|
494
|
+
|
|
495
|
+
N/A — help is a static content display. No flags, no computation, no state.
|
|
496
|
+
|
|
497
|
+
---
|
|
498
|
+
|
|
499
|
+
## Phase 7: Security & Threat Model
|
|
500
|
+
|
|
501
|
+
### 7.0 Standards Auto-Reference
|
|
502
|
+
|
|
503
|
+
No project standards selected (`overall_status: none`). Suggested: `node ./pan-wizard-core/bin/pan-tools.cjs standards recommend` — but N/A for this content-only feature.
|
|
504
|
+
|
|
505
|
+
### 7.1 Asset & Attack Surface
|
|
506
|
+
|
|
507
|
+
| Asset | Accessed How | Trust Level |
|
|
508
|
+
|-------|-------------|-------------|
|
|
509
|
+
| help.md workflow | Read | System-generated (installed by PAN) |
|
|
510
|
+
| Command .md files | Read (frontmatter only) | System-generated |
|
|
511
|
+
|
|
512
|
+
No user input, no file writes, no shell execution, no path traversal possible. This feature has **zero attack surface**.
|
|
513
|
+
|
|
514
|
+
---
|
|
515
|
+
|
|
516
|
+
## Phase 8: Implementation Roadmap
|
|
517
|
+
|
|
518
|
+
### 8.1 New Help Document (DRAFT)
|
|
519
|
+
|
|
520
|
+
```markdown
|
|
521
|
+
# PAN Command Reference
|
|
522
|
+
|
|
523
|
+
**PAN** — workflow automation for building software with AI coding assistants.
|
|
524
|
+
Works with Claude Code, GitHub Copilot CLI, Gemini CLI, Codex, and OpenCode.
|
|
525
|
+
|
|
526
|
+
---
|
|
527
|
+
|
|
528
|
+
## Quick Start
|
|
529
|
+
|
|
530
|
+
Starting a new project?
|
|
531
|
+
/pan:new-project
|
|
532
|
+
|
|
533
|
+
Working on an existing codebase?
|
|
534
|
+
/pan:focus-scan
|
|
535
|
+
|
|
536
|
+
Already have a PAN project?
|
|
537
|
+
/pan:progress
|
|
538
|
+
|
|
539
|
+
---
|
|
540
|
+
|
|
541
|
+
## Two Workflows
|
|
542
|
+
|
|
543
|
+
**Phase Lifecycle** — for new projects and milestone-driven development:
|
|
544
|
+
new-project → plan-phase → exec-phase → verify-phase → milestone-done
|
|
545
|
+
|
|
546
|
+
**Focus Pipeline** — for existing projects and iterative improvement:
|
|
547
|
+
focus-scan → focus-plan → focus-exec → focus-sync
|
|
548
|
+
|
|
549
|
+
Pick one. Both produce working code with automatic commits and verification.
|
|
550
|
+
|
|
551
|
+
---
|
|
552
|
+
|
|
553
|
+
## Common Recipes
|
|
554
|
+
|
|
555
|
+
New project from scratch:
|
|
556
|
+
/pan:new-project → /clear → /pan:plan-phase 1 → /clear → /pan:exec-phase 1
|
|
557
|
+
|
|
558
|
+
Existing project, iterative work:
|
|
559
|
+
/pan:focus-scan → /clear → /pan:focus-plan → /clear → /pan:focus-exec
|
|
560
|
+
|
|
561
|
+
Design a feature before building:
|
|
562
|
+
/pan:focus-design "feature name" → /clear → /pan:focus-scan
|
|
563
|
+
|
|
564
|
+
Resume after a break:
|
|
565
|
+
/pan:progress
|
|
566
|
+
|
|
567
|
+
Quick one-off task:
|
|
568
|
+
/pan:quick "fix the login button"
|
|
569
|
+
|
|
570
|
+
Insert urgent work mid-milestone:
|
|
571
|
+
/pan:insert-phase 5 "Security fix" → /pan:plan-phase 5.1 → /pan:exec-phase 5.1
|
|
572
|
+
|
|
573
|
+
Complete a milestone:
|
|
574
|
+
/pan:milestone-audit → /pan:milestone-gaps → /pan:milestone-done 1.0.0
|
|
575
|
+
|
|
576
|
+
Debug an issue (survives /clear):
|
|
577
|
+
/pan:debug "form submission fails"
|
|
578
|
+
|
|
579
|
+
---
|
|
580
|
+
|
|
581
|
+
## All Commands (37)
|
|
582
|
+
|
|
583
|
+
### Start & Plan
|
|
584
|
+
| Command | What It Does |
|
|
585
|
+
|---------|-------------|
|
|
586
|
+
| `/pan:new-project` | Start a new project — vision, requirements, roadmap |
|
|
587
|
+
| `/pan:map-codebase [area]` | Map an existing codebase before starting |
|
|
588
|
+
| `/pan:discuss-phase <N>` | Talk through a phase before planning it |
|
|
589
|
+
| `/pan:plan-phase <N>` | Create a detailed plan for a phase |
|
|
590
|
+
| `/pan:research-phase <N>` | Deep research for specialized domains |
|
|
591
|
+
| `/pan:assumptions <N>` | See the planned approach before committing |
|
|
592
|
+
|
|
593
|
+
### Build & Verify
|
|
594
|
+
| Command | What It Does |
|
|
595
|
+
|---------|-------------|
|
|
596
|
+
| `/pan:exec-phase <N>` | Build your phase — runs all plans, commits each task |
|
|
597
|
+
| `/pan:verify-phase <N>` | Test what was built against what was planned |
|
|
598
|
+
| `/pan:quick <task>` | Do a small task with automatic commits |
|
|
599
|
+
| `/pan:phase-tests <N>` | Generate tests for a completed phase |
|
|
600
|
+
| `/pan:phase-budget` | Check how much context this phase needs |
|
|
601
|
+
|
|
602
|
+
### Focus Pipeline
|
|
603
|
+
| Command | What It Does |
|
|
604
|
+
|---------|-------------|
|
|
605
|
+
| `/pan:focus-scan` | Find everything that needs work, ranked by impact |
|
|
606
|
+
| `/pan:focus-plan` | Pick a right-sized batch of work to do next |
|
|
607
|
+
| `/pan:focus-exec` | Implement the batch — build, test, verify, commit |
|
|
608
|
+
| `/pan:focus-sync` | Update docs to match your changes |
|
|
609
|
+
| `/pan:focus-design <desc>` | Design a new feature from research to spec |
|
|
610
|
+
|
|
611
|
+
### Milestones & Phases
|
|
612
|
+
| Command | What It Does |
|
|
613
|
+
|---------|-------------|
|
|
614
|
+
| `/pan:progress` | Check your progress and see what's next |
|
|
615
|
+
| `/pan:add-phase <desc>` | Add a new phase to your roadmap |
|
|
616
|
+
| `/pan:insert-phase <N> <desc>` | Insert urgent work between phases |
|
|
617
|
+
| `/pan:remove-phase <N>` | Remove a phase and renumber the rest |
|
|
618
|
+
| `/pan:milestone-new [name]` | Start a new milestone cycle |
|
|
619
|
+
| `/pan:milestone-done <ver>` | Archive a completed milestone |
|
|
620
|
+
| `/pan:milestone-audit` | Check if a milestone is really done |
|
|
621
|
+
| `/pan:milestone-gaps` | Create phases to close audit gaps |
|
|
622
|
+
| `/pan:milestone-cleanup` | Clean up old phase directories |
|
|
623
|
+
|
|
624
|
+
### Session & System
|
|
625
|
+
| Command | What It Does |
|
|
626
|
+
|---------|-------------|
|
|
627
|
+
| `/pan:pause` | Save your place so you can pick up later |
|
|
628
|
+
| `/pan:resume` | Pick up where you left off |
|
|
629
|
+
| `/pan:profile <name>` | Switch AI model profile (quality/balanced/budget) |
|
|
630
|
+
| `/pan:help` | Show this reference |
|
|
631
|
+
| `/pan:health [--repair]` | Check and repair planning files |
|
|
632
|
+
| `/pan:settings` | Configure PAN settings |
|
|
633
|
+
| `/pan:update` | Update PAN to the latest version |
|
|
634
|
+
| `/pan:debug [issue]` | Debug an issue (survives /clear) |
|
|
635
|
+
| `/pan:todo-add [desc]` | Save an idea or task for later |
|
|
636
|
+
| `/pan:todo-check [area]` | See your pending todos |
|
|
637
|
+
| `/pan:discord` | Join the PAN community |
|
|
638
|
+
| `/pan:patches` | Reapply your customizations after updating |
|
|
639
|
+
|
|
640
|
+
---
|
|
641
|
+
|
|
642
|
+
## Focus Pipeline — Flags & Modes
|
|
643
|
+
|
|
644
|
+
### focus-scan
|
|
645
|
+
--quick Skip strategic analysis
|
|
646
|
+
--lean Aggressive priority filtering
|
|
647
|
+
--focus <area> Weight items toward an area
|
|
648
|
+
|
|
649
|
+
### focus-plan
|
|
650
|
+
--mode <mode> bugfix / balanced (default) / features / full
|
|
651
|
+
--budget N Override point budget (5-100)
|
|
652
|
+
--dry-run Preview without writing
|
|
653
|
+
|
|
654
|
+
### focus-exec
|
|
655
|
+
--continue Resume a previous run
|
|
656
|
+
--no-commit Skip the commit step
|
|
657
|
+
--dry-run Preview stages 1-2 only
|
|
658
|
+
|
|
659
|
+
### focus-sync
|
|
660
|
+
--all Full sync with auto-fix
|
|
661
|
+
--readme Check README only
|
|
662
|
+
--commands Verify command files
|
|
663
|
+
--agents Verify agent files
|
|
664
|
+
|
|
665
|
+
### focus-design
|
|
666
|
+
--full All 10 phases (default)
|
|
667
|
+
--internal Skip competitive research
|
|
668
|
+
--outward Skip hardening, focus on strategy
|
|
669
|
+
--spike Fast 4-phase proof-of-concept
|
|
670
|
+
--gate Pause after strategy for review
|
|
671
|
+
--audit Verify existing implementation
|
|
672
|
+
--mvp Stop after MVP task list
|
|
673
|
+
|
|
674
|
+
---
|
|
675
|
+
|
|
676
|
+
## Configuration
|
|
677
|
+
|
|
678
|
+
Settings: /pan:settings
|
|
679
|
+
Profiles: /pan:profile quality|balanced|budget
|
|
680
|
+
Config file: .planning/config.json
|
|
681
|
+
|
|
682
|
+
---
|
|
683
|
+
|
|
684
|
+
## Files
|
|
685
|
+
|
|
686
|
+
.planning/
|
|
687
|
+
├── project.md — your project vision
|
|
688
|
+
├── roadmap.md — current phase breakdown
|
|
689
|
+
├── state.md — project memory and progress
|
|
690
|
+
├── requirements.md — scoped requirements
|
|
691
|
+
├── config.json — workflow settings
|
|
692
|
+
├── focus/ — focus batch files
|
|
693
|
+
├── phases/ — phase plans and summaries
|
|
694
|
+
├── todos/ — captured ideas
|
|
695
|
+
└── debug/ — debug sessions
|
|
696
|
+
|
|
697
|
+
---
|
|
698
|
+
|
|
699
|
+
## Updates & Help
|
|
700
|
+
|
|
701
|
+
Update PAN: npx pan-wizard@latest or /pan:update
|
|
702
|
+
Check progress: /pan:progress
|
|
703
|
+
Community: /pan:discord
|
|
704
|
+
```
|
|
705
|
+
|
|
706
|
+
### 8.2 Implementation Tasks (Ordered)
|
|
707
|
+
|
|
708
|
+
```
|
|
709
|
+
### Task 1: Rewrite help workflow content
|
|
710
|
+
Files: pan-wizard-core/workflows/help.md
|
|
711
|
+
Test: Visual review — output is human-readable markdown
|
|
712
|
+
Estimate: M (4 pts)
|
|
713
|
+
Priority: P2
|
|
714
|
+
|
|
715
|
+
### Task 2: Fix 6 frontmatter issues in command files
|
|
716
|
+
Files: commands/pan/focus-*.md (5), commands/pan/patches.md (1)
|
|
717
|
+
Test: Grep for name: in all 37 files, verify all have pan: prefix
|
|
718
|
+
Estimate: S (2 pts)
|
|
719
|
+
Priority: P2
|
|
720
|
+
|
|
721
|
+
### Task 3: Rewrite all 37 command descriptions in frontmatter
|
|
722
|
+
Files: commands/pan/*.md (37 files)
|
|
723
|
+
Test: Grep for description: in all files, verify max 10 words
|
|
724
|
+
Estimate: M (4 pts)
|
|
725
|
+
Priority: P2
|
|
726
|
+
|
|
727
|
+
### Task 4: Standardize argument-hint in 9 command files
|
|
728
|
+
Files: commands/pan/{map-codebase,milestone-new,todo-add,verify-phase,focus-*}.md (9)
|
|
729
|
+
Test: Grep for argument-hint: in all files, verify short token format
|
|
730
|
+
Estimate: S (2 pts)
|
|
731
|
+
Priority: P3
|
|
732
|
+
|
|
733
|
+
### Task 5: Remove stray </output> tag from help.md command
|
|
734
|
+
Files: commands/pan/help.md
|
|
735
|
+
Test: Read file, verify no stray XML tags
|
|
736
|
+
Estimate: XS (1 pt)
|
|
737
|
+
Priority: P3
|
|
738
|
+
|
|
739
|
+
### Task 6: Sync CLI-REFERENCE.md command descriptions
|
|
740
|
+
Files: docs/CLI-REFERENCE.md
|
|
741
|
+
Test: Verify descriptions match frontmatter
|
|
742
|
+
Estimate: S (2 pts)
|
|
743
|
+
Priority: P3
|
|
744
|
+
|
|
745
|
+
### Task 7: Sync USER-GUIDE.md command descriptions
|
|
746
|
+
Files: docs/USER-GUIDE.md
|
|
747
|
+
Test: Verify descriptions match frontmatter
|
|
748
|
+
Estimate: S (2 pts)
|
|
749
|
+
Priority: P3
|
|
750
|
+
|
|
751
|
+
### Task 8: Propagate to all 5 runtime directories
|
|
752
|
+
Files: .claude/, .github/, .opencode/, .gemini/, .codex/
|
|
753
|
+
Test: Diff canonical vs copies
|
|
754
|
+
Estimate: M (4 pts)
|
|
755
|
+
Priority: P3
|
|
756
|
+
|
|
757
|
+
### Task 9: Update CHANGELOG.md
|
|
758
|
+
Files: CHANGELOG.md
|
|
759
|
+
Test: Version entry present
|
|
760
|
+
Estimate: XS (1 pt)
|
|
761
|
+
Priority: P4
|
|
762
|
+
```
|
|
763
|
+
|
|
764
|
+
### 8.3 Dependency Graph
|
|
765
|
+
|
|
766
|
+
```
|
|
767
|
+
Task 1 (help workflow) ─┐
|
|
768
|
+
Task 2 (fix frontmatter) ─┤
|
|
769
|
+
Task 3 (rewrite descriptions) ─┤──→ Task 6 (CLI-REF sync)
|
|
770
|
+
Task 4 (argument-hints) ─┤──→ Task 7 (USER-GUIDE sync)
|
|
771
|
+
Task 5 (stray tag) ─────┘──→ Task 8 (runtime propagation) ──→ Task 9 (CHANGELOG)
|
|
772
|
+
```
|
|
773
|
+
|
|
774
|
+
### 8.4 Risk Register
|
|
775
|
+
|
|
776
|
+
| Risk | Probability | Impact | Mitigation |
|
|
777
|
+
|------|------------|--------|------------|
|
|
778
|
+
| Descriptions too terse — lose precision | Medium | Low | Review against current behavior, ensure accuracy |
|
|
779
|
+
| Group restructure confuses existing users | Low | Low | Old group names still work as search terms |
|
|
780
|
+
| Runtime propagation misses a file | Medium | Medium | Diff check after propagation |
|
|
781
|
+
| Gemini TOML conversion errors | Medium | Medium | Use tested Python script approach from session 21 |
|
|
782
|
+
|
|
783
|
+
### 8.5 Cognitive Complexity Budget
|
|
784
|
+
|
|
785
|
+
N/A — no code, only content.
|
|
786
|
+
|
|
787
|
+
---
|
|
788
|
+
|
|
789
|
+
## Phase 9: Test Plan
|
|
790
|
+
|
|
791
|
+
### 9.1 Test Pyramid
|
|
792
|
+
|
|
793
|
+
| Level | Pattern | Count | What It Catches |
|
|
794
|
+
|-------|---------|-------|-----------------|
|
|
795
|
+
| **Unit** | Frontmatter field validation (grep-based) | 5+ | Missing fields, wrong format |
|
|
796
|
+
| **Integration** | Help workflow renders correctly | 5+ | Broken markdown, missing sections |
|
|
797
|
+
| **E2E** | Full /pan:help invocation on fresh project | 2+ | End-to-end display |
|
|
798
|
+
|
|
799
|
+
### 9.2 Specific Test Cases
|
|
800
|
+
|
|
801
|
+
1. All 37 command files have `name:` field with `pan:` prefix
|
|
802
|
+
2. All 37 command files have `group:` field
|
|
803
|
+
3. All commands with arguments have `argument-hint:` field
|
|
804
|
+
4. Help workflow contains all 5 group headers
|
|
805
|
+
5. Help workflow contains all 37 command names
|
|
806
|
+
6. Help workflow contains "Quick Start" section
|
|
807
|
+
7. Help workflow contains "Common Recipes" section
|
|
808
|
+
8. Help workflow line count < 200 (verify conciseness)
|
|
809
|
+
9. No jargon terms in descriptions (UAT, wave-based, parallelization, etc.)
|
|
810
|
+
10. All 5 runtime directories have matching help.md content
|
|
811
|
+
11. CLI-REFERENCE command descriptions match frontmatter
|
|
812
|
+
12. No stray XML tags in any command file
|
|
813
|
+
|
|
814
|
+
### 9.3 Regression Verification
|
|
815
|
+
|
|
816
|
+
- [x] Full suite passes unchanged (1139/1139)
|
|
817
|
+
- [x] No test expectations changed
|
|
818
|
+
- [x] Build hooks unaffected
|
|
819
|
+
|
|
820
|
+
---
|
|
821
|
+
|
|
822
|
+
## Phase 10: Output Artifacts
|
|
823
|
+
|
|
824
|
+
### 10.1 Specification Document
|
|
825
|
+
Saved to: `docs/specs/help_commands_rewrite_featureai.md` (this file)
|
|
826
|
+
|
|
827
|
+
### 10.2 ADR
|
|
828
|
+
Saved to: `docs/decisions/ADR-0011-help-commands-rewrite.md`
|
|
829
|
+
|
|
830
|
+
### 10.3 Report Summary
|
|
831
|
+
|
|
832
|
+
**Problem:** PAN Wizard's help output is 380 lines of jargon-heavy, flat-structured developer documentation that fails to help new users find the right command quickly.
|
|
833
|
+
|
|
834
|
+
**Evidence:** User-stated pain, competitive parity gap (Copilot CLI ships grouped categorical help), industry best practices violated (clig.dev guidelines).
|
|
835
|
+
|
|
836
|
+
**Strategic Assessment:**
|
|
837
|
+
- Blue Ocean: ELIMINATE verbose detail from quick-ref, REDUCE groups from 8→5, RAISE discoverability with decision tree, CREATE progressive disclosure
|
|
838
|
+
- Wardley: Product-stage — adopt best practices, differentiate with 2-workflow routing
|
|
839
|
+
- Moat Score: Developer Experience = 5/5, Cross-Platform = 4/5
|
|
840
|
+
- Cognitive Load: simplifies (-1) — new users face 6 highlighted commands, not 37
|
|
841
|
+
- Recommendation: BUILD — high priority, zero risk, high impact
|
|
842
|
+
|
|
843
|
+
**Design:**
|
|
844
|
+
- 3-tier progressive disclosure (10-second overview → grouped tables → detail)
|
|
845
|
+
- 5 command groups (from 8): Start & Plan, Build & Verify, Focus Pipeline, Milestones & Phases, Session & System
|
|
846
|
+
- All 37 descriptions rewritten: outcome-oriented, max 10 words, no jargon
|
|
847
|
+
- "Quick Start" decision tree at top, "Common Recipes" section before command tables
|
|
848
|
+
- 175 lines (from 380 — 54% reduction)
|
|
849
|
+
|
|
850
|
+
**Implementation:** 9 tasks, 22 points total, no code changes — all content work
|
|
851
|
+
- v0 (MVP): Help workflow rewrite + frontmatter fixes (6 pts)
|
|
852
|
+
- v1 (Complete): All 37 descriptions + argument-hints + doc sync (10 pts)
|
|
853
|
+
- v2 (Enhanced): 5-runtime propagation + CHANGELOG (5 pts)
|
|
854
|
+
|
|
855
|
+
**Security:** Zero attack surface (content display only)
|
|
856
|
+
|
|
857
|
+
**Next Steps:**
|
|
858
|
+
1. Run `/pan:focus-plan` to schedule the implementation batch
|
|
859
|
+
2. Run `/pan:focus-exec` to implement all tasks
|
|
860
|
+
3. Run `/pan:focus-sync` to verify documentation consistency
|