specweave 0.1.9 → 0.3.1
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/CLAUDE.md +600 -0
- package/README.md +263 -81
- package/bin/install-all.sh +1 -1
- package/bin/install-commands.sh +3 -3
- package/bin/specweave.js +39 -9
- package/dist/adapters/adapter-base.d.ts +1 -1
- package/dist/adapters/adapter-base.d.ts.map +1 -1
- package/dist/adapters/adapter-base.js +6 -41
- package/dist/adapters/adapter-base.js.map +1 -1
- package/dist/adapters/adapter-interface.js +1 -2
- package/dist/adapters/adapter-interface.js.map +1 -1
- package/dist/adapters/adapter-loader.d.ts +86 -0
- package/dist/adapters/adapter-loader.d.ts.map +1 -0
- package/dist/adapters/adapter-loader.js +216 -0
- package/dist/adapters/adapter-loader.js.map +1 -0
- package/dist/adapters/agents-md-generator.d.ts +48 -0
- package/dist/adapters/agents-md-generator.d.ts.map +1 -0
- package/dist/adapters/agents-md-generator.js +132 -0
- package/dist/adapters/agents-md-generator.js.map +1 -0
- package/dist/adapters/claude/adapter.d.ts +2 -2
- package/dist/adapters/claude/adapter.d.ts.map +1 -1
- package/dist/adapters/claude/adapter.js +5 -42
- package/dist/adapters/claude/adapter.js.map +1 -1
- package/dist/adapters/claude-md-generator.d.ts +78 -0
- package/dist/adapters/claude-md-generator.d.ts.map +1 -0
- package/dist/adapters/claude-md-generator.js +246 -0
- package/dist/adapters/claude-md-generator.js.map +1 -0
- package/dist/adapters/codex/adapter.d.ts +50 -0
- package/dist/adapters/codex/adapter.d.ts.map +1 -0
- package/dist/adapters/codex/adapter.js +316 -0
- package/dist/adapters/codex/adapter.js.map +1 -0
- package/dist/adapters/copilot/adapter.d.ts +10 -9
- package/dist/adapters/copilot/adapter.d.ts.map +1 -1
- package/dist/adapters/copilot/adapter.js +35 -100
- package/dist/adapters/copilot/adapter.js.map +1 -1
- package/dist/adapters/cursor/adapter.d.ts +8 -6
- package/dist/adapters/cursor/adapter.d.ts.map +1 -1
- package/dist/adapters/cursor/adapter.js +47 -130
- package/dist/adapters/cursor/adapter.js.map +1 -1
- package/dist/adapters/doc-generator.d.ts +69 -0
- package/dist/adapters/doc-generator.d.ts.map +1 -0
- package/dist/adapters/doc-generator.js +247 -0
- package/dist/adapters/doc-generator.js.map +1 -0
- package/dist/adapters/gemini/adapter.d.ts +50 -0
- package/dist/adapters/gemini/adapter.d.ts.map +1 -0
- package/dist/adapters/gemini/adapter.js +281 -0
- package/dist/adapters/gemini/adapter.js.map +1 -0
- package/dist/adapters/generic/adapter.d.ts +7 -4
- package/dist/adapters/generic/adapter.d.ts.map +1 -1
- package/dist/adapters/generic/adapter.js +60 -59
- package/dist/adapters/generic/adapter.js.map +1 -1
- package/dist/cli/commands/init.d.ts +3 -1
- package/dist/cli/commands/init.d.ts.map +1 -1
- package/dist/cli/commands/init.js +327 -177
- package/dist/cli/commands/init.js.map +1 -1
- package/dist/cli/commands/install.d.ts.map +1 -1
- package/dist/cli/commands/install.js +22 -58
- package/dist/cli/commands/install.js.map +1 -1
- package/dist/cli/commands/list.d.ts.map +1 -1
- package/dist/cli/commands/list.js +27 -64
- package/dist/cli/commands/list.js.map +1 -1
- package/dist/core/credentials-manager.d.ts +90 -0
- package/dist/core/credentials-manager.d.ts.map +1 -0
- package/dist/core/credentials-manager.js +271 -0
- package/dist/core/credentials-manager.js.map +1 -0
- package/dist/core/project-structure-detector.d.ts +92 -0
- package/dist/core/project-structure-detector.d.ts.map +1 -0
- package/dist/core/project-structure-detector.js +289 -0
- package/dist/core/project-structure-detector.js.map +1 -0
- package/dist/core/rfc-generator-v2.d.ts +149 -0
- package/dist/core/rfc-generator-v2.d.ts.map +1 -0
- package/dist/core/rfc-generator-v2.js +399 -0
- package/dist/core/rfc-generator-v2.js.map +1 -0
- package/dist/core/rfc-generator.d.ts +147 -0
- package/dist/core/rfc-generator.d.ts.map +1 -0
- package/dist/core/rfc-generator.js +434 -0
- package/dist/core/rfc-generator.js.map +1 -0
- package/dist/integrations/ado/ado-client.d.ts +123 -0
- package/dist/integrations/ado/ado-client.d.ts.map +1 -0
- package/dist/integrations/ado/ado-client.js +398 -0
- package/dist/integrations/ado/ado-client.js.map +1 -0
- package/dist/integrations/jira/jira-client.d.ts +139 -0
- package/dist/integrations/jira/jira-client.d.ts.map +1 -0
- package/dist/integrations/jira/jira-client.js +386 -0
- package/dist/integrations/jira/jira-client.js.map +1 -0
- package/dist/integrations/jira/jira-incremental-mapper.d.ts +75 -0
- package/dist/integrations/jira/jira-incremental-mapper.d.ts.map +1 -0
- package/dist/integrations/jira/jira-incremental-mapper.js +474 -0
- package/dist/integrations/jira/jira-incremental-mapper.js.map +1 -0
- package/dist/integrations/jira/jira-mapper.d.ts +105 -0
- package/dist/integrations/jira/jira-mapper.d.ts.map +1 -0
- package/dist/integrations/jira/jira-mapper.js +494 -0
- package/dist/integrations/jira/jira-mapper.js.map +1 -0
- package/dist/testing/test-generator.d.ts +117 -0
- package/dist/testing/test-generator.d.ts.map +1 -0
- package/dist/testing/test-generator.js +370 -0
- package/dist/testing/test-generator.js.map +1 -0
- package/dist/utils/auto-install.d.ts +3 -0
- package/dist/utils/auto-install.d.ts.map +1 -1
- package/dist/utils/auto-install.js +16 -82
- package/dist/utils/auto-install.js.map +1 -1
- package/dist/utils/esm-helpers.d.ts +50 -0
- package/dist/utils/esm-helpers.d.ts.map +1 -0
- package/dist/utils/esm-helpers.js +57 -0
- package/dist/utils/esm-helpers.js.map +1 -0
- package/package.json +16 -7
- package/src/adapters/README.md +1 -2
- package/src/adapters/adapter-base.ts +6 -3
- package/src/adapters/adapter-loader.ts +261 -0
- package/src/adapters/agents-md-generator.ts +162 -0
- package/src/adapters/claude/README.md +6 -14
- package/src/adapters/claude/adapter.ts +4 -4
- package/src/adapters/claude-md-generator.ts +311 -0
- package/src/adapters/codex/README.md +105 -0
- package/src/adapters/codex/adapter.ts +333 -0
- package/src/adapters/copilot/adapter.ts +36 -65
- package/src/adapters/cursor/README.md +0 -2
- package/src/adapters/cursor/adapter.ts +46 -92
- package/src/adapters/doc-generator.ts +331 -0
- package/src/adapters/gemini/README.md +97 -0
- package/src/adapters/gemini/adapter.ts +298 -0
- package/src/adapters/generic/adapter.ts +61 -57
- package/src/adapters/registry.yaml +86 -25
- package/src/agents/devops/AGENT.md +16 -18
- package/src/agents/docs-writer/AGENT.md +2 -2
- package/src/agents/pm/AGENT.md +1 -50
- package/src/commands/README.md +134 -111
- package/src/commands/{build.md → specweave.do.md} +141 -69
- package/src/commands/{done.md → specweave.done.md} +3 -3
- package/src/commands/{inc.md → specweave.inc.md} +4 -4
- package/src/commands/{increment.md → specweave.increment.md} +143 -76
- package/src/commands/specweave.md +430 -0
- package/src/commands/specweave.next.md +495 -0
- package/src/commands/{progress.md → specweave.progress.md} +12 -12
- package/src/commands/specweave.sync-docs.md +665 -0
- package/src/commands/specweave.sync-github.md +269 -0
- package/src/commands/specweave.sync-jira.md +197 -0
- package/src/commands/{validate.md → specweave.validate.md} +4 -4
- package/src/hooks/README.md +19 -29
- package/src/hooks/post-task-completion.sh +25 -30
- package/src/skills/ado-sync/README.md +1 -36
- package/src/skills/bmad-method-expert/SKILL.md +1 -3
- package/src/skills/brownfield-analyzer/SKILL.md +429 -23
- package/src/skills/brownfield-onboarder/SKILL.md +221 -8
- package/src/skills/context-loader/SKILL.md +239 -617
- package/src/skills/context-optimizer/SKILL.md +0 -30
- package/src/skills/github-sync/SKILL.md +1 -19
- package/src/skills/increment-planner/SKILL.md +64 -18
- package/src/skills/increment-quality-judge/SKILL.md +1 -36
- package/src/skills/jira-sync/README.md +1 -38
- package/src/skills/role-orchestrator/README.md +1 -22
- package/src/skills/role-orchestrator/SKILL.md +1 -59
- package/src/skills/skill-router/SKILL.md +0 -18
- package/src/skills/spec-kit-expert/SKILL.md +1 -3
- package/src/skills/specweave-detector/SKILL.md +225 -275
- package/src/skills/task-builder/README.md +1 -7
- package/src/templates/AGENTS.md.template +334 -0
- package/src/templates/CLAUDE.md.template +131 -298
- package/src/templates/README.md.template +115 -23
- package/src/templates/environments/minimal/README.md +0 -1
- package/INSTALL.md +0 -848
- package/SPECWEAVE.md +0 -743
- package/src/adapters/copilot/.github/copilot/instructions.md +0 -376
- package/src/adapters/cursor/.cursorrules +0 -325
- package/src/adapters/generic/SPECWEAVE-MANUAL.md +0 -676
- package/src/commands/create-project.md +0 -528
- package/src/commands/generate-docs.md +0 -623
- package/src/commands/review-docs.md +0 -331
- package/src/commands/sync-github.md +0 -115
- package/src/skills/ado-sync/test-cases/test-1.yaml +0 -9
- package/src/skills/ado-sync/test-cases/test-2.yaml +0 -8
- package/src/skills/ado-sync/test-cases/test-3.yaml +0 -9
- package/src/skills/bmad-method-expert/test-cases/test-1-placeholder.yaml +0 -12
- package/src/skills/bmad-method-expert/test-cases/test-2-placeholder.yaml +0 -12
- package/src/skills/bmad-method-expert/test-cases/test-3-placeholder.yaml +0 -12
- package/src/skills/brownfield-analyzer/test-cases/test-1-basic-analysis.yaml +0 -48
- package/src/skills/brownfield-analyzer/test-cases/test-2-placeholder.yaml +0 -12
- package/src/skills/brownfield-analyzer/test-cases/test-3-placeholder.yaml +0 -12
- package/src/skills/brownfield-onboarder/test-cases/test-1-placeholder.yaml +0 -12
- package/src/skills/brownfield-onboarder/test-cases/test-2-placeholder.yaml +0 -12
- package/src/skills/brownfield-onboarder/test-cases/test-3-placeholder.yaml +0 -12
- package/src/skills/calendar-system/test-cases/test-1-placeholder.yaml +0 -12
- package/src/skills/calendar-system/test-cases/test-2-placeholder.yaml +0 -12
- package/src/skills/calendar-system/test-cases/test-3-placeholder.yaml +0 -12
- package/src/skills/context-loader/test-cases/test-1-basic-loading.yaml +0 -39
- package/src/skills/context-loader/test-cases/test-2-token-budget-exceeded.yaml +0 -44
- package/src/skills/context-loader/test-cases/test-3-section-anchors.yaml +0 -45
- package/src/skills/context-optimizer/test-cases/test-1-bug-fix-narrow.yaml +0 -97
- package/src/skills/context-optimizer/test-cases/test-2-feature-focused.yaml +0 -109
- package/src/skills/context-optimizer/test-cases/test-3-architecture-broad.yaml +0 -98
- package/src/skills/cost-optimizer/test-cases/test-1-basic-comparison.yaml +0 -75
- package/src/skills/cost-optimizer/test-cases/test-2-budget-constraint.yaml +0 -52
- package/src/skills/cost-optimizer/test-cases/test-3-scale-requirement.yaml +0 -63
- package/src/skills/cost-optimizer/test-results/README.md +0 -46
- package/src/skills/design-system-architect/test-cases/test-1-token-structure.yaml +0 -23
- package/src/skills/design-system-architect/test-cases/test-2-component-hierarchy.yaml +0 -24
- package/src/skills/design-system-architect/test-cases/test-3-accessibility-checklist.yaml +0 -23
- package/src/skills/diagrams-architect/test-cases/test-1-c4-context.yaml +0 -13
- package/src/skills/diagrams-architect/test-cases/test-2-sequence-diagram.yaml +0 -13
- package/src/skills/diagrams-architect/test-cases/test-3-er-diagram.yaml +0 -13
- package/src/skills/diagrams-generator/test-cases/test-1.yaml +0 -9
- package/src/skills/diagrams-generator/test-cases/test-2.yaml +0 -9
- package/src/skills/diagrams-generator/test-cases/test-3.yaml +0 -8
- package/src/skills/docs-updater/test-cases/test-1-placeholder.yaml +0 -12
- package/src/skills/docs-updater/test-cases/test-2-placeholder.yaml +0 -12
- package/src/skills/docs-updater/test-cases/test-3-placeholder.yaml +0 -12
- package/src/skills/dotnet-backend/test-cases/test-1-rest-api.yaml +0 -14
- package/src/skills/dotnet-backend/test-cases/test-2-authentication.yaml +0 -13
- package/src/skills/dotnet-backend/test-cases/test-3-minimal-api.yaml +0 -13
- package/src/skills/e2e-playwright/test-cases/TC-001-basic-navigation.yaml +0 -54
- package/src/skills/e2e-playwright/test-cases/TC-002-form-interaction.yaml +0 -64
- package/src/skills/e2e-playwright/test-cases/TC-003-specweave-integration.yaml +0 -74
- package/src/skills/e2e-playwright/test-cases/TC-004-accessibility-check.yaml +0 -98
- package/src/skills/figma-designer/test-cases/test-1-design-system.yaml +0 -13
- package/src/skills/figma-designer/test-cases/test-2-component-library.yaml +0 -13
- package/src/skills/figma-designer/test-cases/test-3-responsive-layout.yaml +0 -13
- package/src/skills/figma-implementer/test-cases/test-1-design-to-react.yaml +0 -13
- package/src/skills/figma-implementer/test-cases/test-2-storybook.yaml +0 -13
- package/src/skills/figma-implementer/test-cases/test-3-design-tokens.yaml +0 -13
- package/src/skills/figma-mcp-connector/test-cases/test-1-read-file-desktop.yaml +0 -22
- package/src/skills/figma-mcp-connector/test-cases/test-2-read-file-framelink.yaml +0 -21
- package/src/skills/figma-mcp-connector/test-cases/test-3-error-handling.yaml +0 -18
- package/src/skills/figma-to-code/test-cases/test-1-token-generation.yaml +0 -29
- package/src/skills/figma-to-code/test-cases/test-2-component-generation.yaml +0 -27
- package/src/skills/figma-to-code/test-cases/test-3-typescript-generation.yaml +0 -28
- package/src/skills/frontend/test-cases/test-1-react-component.yaml +0 -13
- package/src/skills/frontend/test-cases/test-2-form-validation.yaml +0 -13
- package/src/skills/frontend/test-cases/test-3-state-management.yaml +0 -13
- package/src/skills/github-sync/test-cases/test-1-placeholder.yaml +0 -12
- package/src/skills/github-sync/test-cases/test-2-placeholder.yaml +0 -12
- package/src/skills/github-sync/test-cases/test-3-placeholder.yaml +0 -12
- package/src/skills/hetzner-provisioner/test-cases/test-1-basic-provision.yaml +0 -71
- package/src/skills/hetzner-provisioner/test-cases/test-2-postgres-provision.yaml +0 -85
- package/src/skills/hetzner-provisioner/test-cases/test-3-ssl-config.yaml +0 -126
- package/src/skills/hetzner-provisioner/test-results/README.md +0 -259
- package/src/skills/increment-planner/test-cases/test-1-basic-feature.yaml +0 -27
- package/src/skills/increment-planner/test-cases/test-2-complex-feature.yaml +0 -30
- package/src/skills/increment-planner/test-cases/test-3-auto-numbering.yaml +0 -24
- package/src/skills/increment-quality-judge/test-cases/test-1-good-spec.yaml +0 -95
- package/src/skills/increment-quality-judge/test-cases/test-2-poor-spec.yaml +0 -108
- package/src/skills/increment-quality-judge/test-cases/test-3-export-suggestions.yaml +0 -87
- package/src/skills/jira-sync/test-cases/test-1.yaml +0 -9
- package/src/skills/jira-sync/test-cases/test-2.yaml +0 -9
- package/src/skills/jira-sync/test-cases/test-3.yaml +0 -10
- package/src/skills/nextjs/test-cases/test-1-app-router.yaml +0 -13
- package/src/skills/nextjs/test-cases/test-2-server-actions.yaml +0 -13
- package/src/skills/nextjs/test-cases/test-3-api-routes.yaml +0 -13
- package/src/skills/nodejs-backend/test-cases/test-1-express-api.yaml +0 -13
- package/src/skills/nodejs-backend/test-cases/test-2-prisma-orm.yaml +0 -13
- package/src/skills/nodejs-backend/test-cases/test-3-authentication.yaml +0 -13
- package/src/skills/notification-system/test-cases/test-1-placeholder.yaml +0 -12
- package/src/skills/notification-system/test-cases/test-2-placeholder.yaml +0 -12
- package/src/skills/notification-system/test-cases/test-3-placeholder.yaml +0 -12
- package/src/skills/python-backend/test-cases/test-1-fastapi-crud.yaml +0 -13
- package/src/skills/python-backend/test-cases/test-2-sqlalchemy.yaml +0 -13
- package/src/skills/python-backend/test-cases/test-3-authentication.yaml +0 -13
- package/src/skills/role-orchestrator/test-cases/test-1-simple-product.yaml +0 -98
- package/src/skills/role-orchestrator/test-cases/test-2-quality-gate-failure.yaml +0 -73
- package/src/skills/role-orchestrator/test-cases/test-3-security-workflow.yaml +0 -121
- package/src/skills/role-orchestrator/test-cases/test-4-parallel-execution.yaml +0 -145
- package/src/skills/role-orchestrator/test-cases/test-5-feedback-loops.yaml +0 -149
- package/src/skills/skill-creator/test-cases/test-1-placeholder.yaml +0 -12
- package/src/skills/skill-creator/test-cases/test-2-placeholder.yaml +0 -12
- package/src/skills/skill-creator/test-cases/test-3-placeholder.yaml +0 -12
- package/src/skills/skill-router/test-cases/test-1-basic-routing.yaml +0 -33
- package/src/skills/skill-router/test-cases/test-2-ambiguous-request.yaml +0 -42
- package/src/skills/skill-router/test-cases/test-3-nested-orchestration.yaml +0 -50
- package/src/skills/spec-driven-brainstorming/test-cases/TC-001-simple-idea-to-design.yaml +0 -148
- package/src/skills/spec-driven-brainstorming/test-cases/TC-002-complex-ultrathink-design.yaml +0 -190
- package/src/skills/spec-driven-brainstorming/test-cases/TC-003-unclear-requirements-socratic.yaml +0 -233
- package/src/skills/spec-driven-debugging/test-cases/TC-001-simple-auth-bug.yaml +0 -212
- package/src/skills/spec-driven-debugging/test-cases/TC-002-race-condition-ultrathink.yaml +0 -461
- package/src/skills/spec-driven-debugging/test-cases/TC-003-brownfield-missing-spec.yaml +0 -366
- package/src/skills/spec-kit-expert/test-cases/test-1-placeholder.yaml +0 -12
- package/src/skills/spec-kit-expert/test-cases/test-2-placeholder.yaml +0 -12
- package/src/skills/spec-kit-expert/test-cases/test-3-placeholder.yaml +0 -12
- package/src/skills/specweave-ado-mapper/test-cases/test-1-export-to-ado.yaml +0 -13
- package/src/skills/specweave-ado-mapper/test-cases/test-2-import-from-ado.yaml +0 -13
- package/src/skills/specweave-ado-mapper/test-cases/test-3-bidirectional-sync.yaml +0 -13
- package/src/skills/specweave-detector/test-cases/test-1-basic-detection.yaml +0 -37
- package/src/skills/specweave-detector/test-cases/test-2-missing-config.yaml +0 -37
- package/src/skills/specweave-detector/test-cases/test-3-non-specweave-project.yaml +0 -34
- package/src/skills/specweave-jira-mapper/test-cases/test-1-export-to-jira.yaml +0 -13
- package/src/skills/specweave-jira-mapper/test-cases/test-2-import-from-jira.yaml +0 -13
- package/src/skills/specweave-jira-mapper/test-cases/test-3-sync-status.yaml +0 -13
- package/src/skills/stripe-integrator/test-cases/test-1-placeholder.yaml +0 -12
- package/src/skills/stripe-integrator/test-cases/test-2-placeholder.yaml +0 -12
- package/src/skills/stripe-integrator/test-cases/test-3-placeholder.yaml +0 -12
- package/src/skills/task-builder/test-cases/test-1-placeholder.yaml +0 -12
- package/src/skills/task-builder/test-cases/test-2-placeholder.yaml +0 -12
- package/src/skills/task-builder/test-cases/test-3-placeholder.yaml +0 -12
- package/src/templates/config.yaml +0 -351
- /package/src/commands/{list-increments.md → specweave.list-increments.md} +0 -0
|
@@ -95,13 +95,7 @@ As a user, I want to subscribe to a monthly plan...
|
|
|
95
95
|
## Authentication
|
|
96
96
|
|
|
97
97
|
**Personal Access Token (PAT)**:
|
|
98
|
-
|
|
99
|
-
# .specweave/config.yaml
|
|
100
|
-
ado_sync:
|
|
101
|
-
url: "https://dev.azure.com/your-org"
|
|
102
|
-
project: "YourProject"
|
|
103
|
-
pat: "${ADO_PAT}" # From environment variable
|
|
104
|
-
```
|
|
98
|
+
|
|
105
99
|
|
|
106
100
|
**OAuth 2.0** (for apps):
|
|
107
101
|
```yaml
|
|
@@ -115,36 +109,7 @@ ado_sync:
|
|
|
115
109
|
|
|
116
110
|
## Configuration
|
|
117
111
|
|
|
118
|
-
```yaml
|
|
119
|
-
# .specweave/config.yaml
|
|
120
|
-
ado_sync:
|
|
121
|
-
enabled: false
|
|
122
|
-
|
|
123
|
-
# ADO instance
|
|
124
|
-
url: "https://dev.azure.com/your-org"
|
|
125
|
-
project: "YourProject"
|
|
126
|
-
|
|
127
|
-
# Authentication (use environment variables!)
|
|
128
|
-
pat: "${ADO_PAT}"
|
|
129
112
|
|
|
130
|
-
# Sync settings
|
|
131
|
-
sync_direction: "bidirectional" # export | import | bidirectional
|
|
132
|
-
sync_interval: 300 # seconds (5 minutes)
|
|
133
|
-
|
|
134
|
-
# What to sync
|
|
135
|
-
sync_status: true
|
|
136
|
-
sync_comments: true
|
|
137
|
-
sync_assignees: true
|
|
138
|
-
sync_attachments: false
|
|
139
|
-
|
|
140
|
-
# Work item mapping
|
|
141
|
-
area_path: "Platform" # Default area path
|
|
142
|
-
iteration_path: null # Auto-detect from current sprint
|
|
143
|
-
|
|
144
|
-
# Webhooks (for real-time sync)
|
|
145
|
-
webhook_enabled: true
|
|
146
|
-
webhook_secret: "${ADO_WEBHOOK_SECRET}"
|
|
147
|
-
```
|
|
148
113
|
|
|
149
114
|
## Workflow
|
|
150
115
|
|
|
@@ -219,7 +219,6 @@ When you request gap analysis, I will:
|
|
|
219
219
|
```bash
|
|
220
220
|
# Project structure
|
|
221
221
|
- CLAUDE.md (complete guide)
|
|
222
|
-
- .specweave/config.yaml (configuration)
|
|
223
222
|
- features/ (implemented features)
|
|
224
223
|
- src/skills/ (available skills)
|
|
225
224
|
- specifications/ (spec organization)
|
|
@@ -290,7 +289,7 @@ Based on analysis, provide:
|
|
|
290
289
|
- Check features/ for implemented capabilities
|
|
291
290
|
- Read src/skills/ for available skills
|
|
292
291
|
- Review CLAUDE.md for documented features
|
|
293
|
-
-
|
|
292
|
+
- Settings auto-detected
|
|
294
293
|
```
|
|
295
294
|
|
|
296
295
|
2. Compare to BMAD knowledge:
|
|
@@ -530,7 +529,6 @@ When performing gap analysis, I can read and analyze:
|
|
|
530
529
|
```bash
|
|
531
530
|
# Core configuration
|
|
532
531
|
✅ CLAUDE.md # Complete guide
|
|
533
|
-
✅ .specweave/config.yaml # Configuration
|
|
534
532
|
✅ README.md # Project overview
|
|
535
533
|
|
|
536
534
|
# Features
|
|
@@ -13,12 +13,61 @@ description: Analyzes existing brownfield projects to map documentation structur
|
|
|
13
13
|
|
|
14
14
|
## Capabilities
|
|
15
15
|
|
|
16
|
-
1. **
|
|
17
|
-
2. **
|
|
18
|
-
3. **
|
|
19
|
-
4. **
|
|
20
|
-
5. **
|
|
21
|
-
6. **
|
|
16
|
+
1. **Assess Project Complexity** - Estimate LOC, files, modules and recommend documentation path 🆕
|
|
17
|
+
2. **Scan Project Structure** - Recursively scan folders for documentation
|
|
18
|
+
3. **Classify Documents** - Identify PRD, HLD, ADR, RFC, Runbook candidates
|
|
19
|
+
4. **Detect External Tools** - Find Jira, ADO, GitHub project references
|
|
20
|
+
5. **Analyze Diagrams** - Identify architecture diagrams (PNG, SVG, drawio)
|
|
21
|
+
6. **Generate Migration Plan** - Create actionable migration plan with effort estimate
|
|
22
|
+
7. **Suggest Increment Mapping** - Map Jira Epics/ADO Features to SpecWeave Increments
|
|
23
|
+
8. **Support Two Paths** - Quick Start (incremental) OR Comprehensive (upfront) 🆕
|
|
24
|
+
|
|
25
|
+
---
|
|
26
|
+
|
|
27
|
+
## Two-Path Strategy 🆕
|
|
28
|
+
|
|
29
|
+
**SpecWeave supports two brownfield approaches**:
|
|
30
|
+
|
|
31
|
+
### Path 1: Quick Start (Incremental Documentation)
|
|
32
|
+
**Best for**: Large projects (50k+ LOC), fast iteration, small teams
|
|
33
|
+
|
|
34
|
+
**Process**:
|
|
35
|
+
1. Initial scan: Document core architecture only (1-3 hours)
|
|
36
|
+
2. Start working immediately
|
|
37
|
+
3. Per increment: Document → Modify → Update docs
|
|
38
|
+
4. Documentation grows with changes
|
|
39
|
+
|
|
40
|
+
**Benefits**:
|
|
41
|
+
- Start in days, not weeks
|
|
42
|
+
- Focus documentation where it matters
|
|
43
|
+
- No analysis paralysis
|
|
44
|
+
- Always safe (document before touching code)
|
|
45
|
+
|
|
46
|
+
### Path 2: Comprehensive Upfront
|
|
47
|
+
**Best for**: Small/medium projects (<50k LOC), teams, regulated industries
|
|
48
|
+
|
|
49
|
+
**Process**:
|
|
50
|
+
1. Full codebase analysis (1-4 weeks)
|
|
51
|
+
2. Document all modules, business rules
|
|
52
|
+
3. Create complete baseline tests
|
|
53
|
+
4. Then start increments with full context
|
|
54
|
+
|
|
55
|
+
**Benefits**:
|
|
56
|
+
- Complete context upfront
|
|
57
|
+
- Full regression coverage
|
|
58
|
+
- Easier team coordination
|
|
59
|
+
- Better for compliance
|
|
60
|
+
|
|
61
|
+
### Automatic Path Recommendation
|
|
62
|
+
|
|
63
|
+
The analyzer **automatically recommends** a path based on:
|
|
64
|
+
|
|
65
|
+
| Project Size | LOC Range | Upfront Effort | Recommended Path |
|
|
66
|
+
|--------------|-----------|----------------|------------------|
|
|
67
|
+
| **Small** | < 10k LOC | 4-8 hours | Comprehensive Upfront |
|
|
68
|
+
| **Medium** | 10k-50k LOC | 1-2 weeks | User Choice |
|
|
69
|
+
| **Large** | 50k-200k LOC | 2-4 weeks | Quick Start |
|
|
70
|
+
| **Very Large** | 200k+ LOC | 1-3 months | Quick Start (Mandatory) |
|
|
22
71
|
|
|
23
72
|
---
|
|
24
73
|
|
|
@@ -37,9 +86,128 @@ description: Analyzes existing brownfield projects to map documentation structur
|
|
|
37
86
|
|
|
38
87
|
## Analysis Process
|
|
39
88
|
|
|
89
|
+
### Step 0: Complexity Assessment 🆕
|
|
90
|
+
|
|
91
|
+
**FIRST, estimate project size to recommend path**:
|
|
92
|
+
|
|
93
|
+
**Metrics to collect**:
|
|
94
|
+
```typescript
|
|
95
|
+
interface ComplexityMetrics {
|
|
96
|
+
totalLOC: number; // Lines of code
|
|
97
|
+
totalFiles: number; // Number of files
|
|
98
|
+
languages: string[]; // Programming languages detected
|
|
99
|
+
modules: number; // Estimated number of modules
|
|
100
|
+
dependencies: number; // External dependencies
|
|
101
|
+
testCoverage: number; // Existing test coverage (%)
|
|
102
|
+
documentationFiles: number; // Existing docs
|
|
103
|
+
diagramsFound: number; // Existing diagrams
|
|
104
|
+
externalTools: string[]; // Jira, ADO, GitHub detected
|
|
105
|
+
}
|
|
106
|
+
```
|
|
107
|
+
|
|
108
|
+
**LOC Estimation Commands**:
|
|
109
|
+
```bash
|
|
110
|
+
# Count LOC by language (exclude vendor/node_modules/dist)
|
|
111
|
+
cloc . --exclude-dir=node_modules,vendor,dist,build,.git
|
|
112
|
+
|
|
113
|
+
# Or use tokei (faster)
|
|
114
|
+
tokei
|
|
115
|
+
|
|
116
|
+
# Or manual approach
|
|
117
|
+
find . -name "*.ts" -o -name "*.js" | xargs wc -l
|
|
118
|
+
```
|
|
119
|
+
|
|
120
|
+
**Complexity Scoring**:
|
|
121
|
+
```typescript
|
|
122
|
+
function assessComplexity(metrics: ComplexityMetrics): ComplexityAssessment {
|
|
123
|
+
const score = calculateScore(metrics);
|
|
124
|
+
|
|
125
|
+
if (metrics.totalLOC < 10_000) {
|
|
126
|
+
return {
|
|
127
|
+
size: "Small",
|
|
128
|
+
effort: "4-8 hours",
|
|
129
|
+
recommendedPath: "Comprehensive Upfront",
|
|
130
|
+
confidence: "High"
|
|
131
|
+
};
|
|
132
|
+
} else if (metrics.totalLOC < 50_000) {
|
|
133
|
+
return {
|
|
134
|
+
size: "Medium",
|
|
135
|
+
effort: "1-2 weeks",
|
|
136
|
+
recommendedPath: "User Choice (Ask preference)",
|
|
137
|
+
confidence: "Medium"
|
|
138
|
+
};
|
|
139
|
+
} else if (metrics.totalLOC < 200_000) {
|
|
140
|
+
return {
|
|
141
|
+
size: "Large",
|
|
142
|
+
effort: "2-4 weeks",
|
|
143
|
+
recommendedPath: "Quick Start",
|
|
144
|
+
confidence: "High"
|
|
145
|
+
};
|
|
146
|
+
} else {
|
|
147
|
+
return {
|
|
148
|
+
size: "Very Large",
|
|
149
|
+
effort: "1-3 months",
|
|
150
|
+
recommendedPath: "Quick Start (Mandatory)",
|
|
151
|
+
confidence: "Critical"
|
|
152
|
+
};
|
|
153
|
+
}
|
|
154
|
+
}
|
|
155
|
+
```
|
|
156
|
+
|
|
157
|
+
**Output to User**:
|
|
158
|
+
```
|
|
159
|
+
🔍 Analyzing project complexity...
|
|
160
|
+
|
|
161
|
+
Metrics:
|
|
162
|
+
• 85,420 LOC detected
|
|
163
|
+
• 342 files analyzed
|
|
164
|
+
• Languages: TypeScript (65%), JavaScript (30%), CSS (5%)
|
|
165
|
+
• Estimated modules: 12
|
|
166
|
+
• Test coverage: 45%
|
|
167
|
+
• Existing docs: 23 files
|
|
168
|
+
• External tools: Jira (PROJ-*)
|
|
169
|
+
|
|
170
|
+
Complexity Assessment: LARGE PROJECT
|
|
171
|
+
• Size: Large (85k LOC)
|
|
172
|
+
• Full analysis effort: 2-3 weeks
|
|
173
|
+
• Recommended path: Quick Start
|
|
174
|
+
|
|
175
|
+
Recommendation:
|
|
176
|
+
✓ Document core architecture only (2-3 hours)
|
|
177
|
+
✓ Start working immediately
|
|
178
|
+
✓ Document incrementally per feature
|
|
179
|
+
→ Avoid 2-3 week upfront analysis
|
|
180
|
+
|
|
181
|
+
Alternative:
|
|
182
|
+
⚠️ Comprehensive upfront (2-3 weeks)
|
|
183
|
+
→ Only if you need full context before starting
|
|
184
|
+
|
|
185
|
+
Proceed with Quick Start? (y/n)
|
|
186
|
+
```
|
|
187
|
+
|
|
188
|
+
---
|
|
189
|
+
|
|
40
190
|
### Step 1: Initial Scan
|
|
41
191
|
|
|
42
|
-
**Scan
|
|
192
|
+
**Scan depth depends on chosen path**:
|
|
193
|
+
|
|
194
|
+
#### Quick Start Path:
|
|
195
|
+
**Scan ONLY for**:
|
|
196
|
+
- Core architecture files (`architecture/**/*.md`)
|
|
197
|
+
- Main README files
|
|
198
|
+
- Tech stack indicators (`package.json`, `requirements.txt`, `.csproj`)
|
|
199
|
+
- High-level business domains (folder structure)
|
|
200
|
+
- Critical patterns (auth, payment, security)
|
|
201
|
+
|
|
202
|
+
**Skip detailed**:
|
|
203
|
+
- Individual module documentation
|
|
204
|
+
- Detailed business rules
|
|
205
|
+
- Code-level documentation
|
|
206
|
+
|
|
207
|
+
**Result**: High-level understanding (1-3 hours)
|
|
208
|
+
|
|
209
|
+
#### Comprehensive Path:
|
|
210
|
+
**Scan ALL patterns**:
|
|
43
211
|
```
|
|
44
212
|
docs/**/*.md
|
|
45
213
|
documentation/**/*.md
|
|
@@ -184,17 +352,140 @@ build/**
|
|
|
184
352
|
|
|
185
353
|
## Output: Analysis Report
|
|
186
354
|
|
|
187
|
-
**Generate markdown report
|
|
355
|
+
**Generate markdown report** (path-specific):
|
|
356
|
+
|
|
357
|
+
### Quick Start Report
|
|
188
358
|
|
|
189
359
|
```markdown
|
|
190
|
-
# Brownfield Analysis Report
|
|
360
|
+
# Brownfield Analysis Report - Quick Start Mode
|
|
191
361
|
|
|
192
362
|
**Project**: {project-name}
|
|
193
363
|
**Analyzed**: {date}
|
|
364
|
+
**Mode**: Quick Start (Incremental Documentation)
|
|
365
|
+
|
|
366
|
+
---
|
|
367
|
+
|
|
368
|
+
## Complexity Assessment 🆕
|
|
369
|
+
|
|
370
|
+
**Project Size**: {size} ({LOC} LOC)
|
|
371
|
+
**Files Analyzed**: {count}
|
|
372
|
+
**Languages**: {languages}
|
|
373
|
+
**Modules Detected**: {count}
|
|
374
|
+
**Test Coverage**: {percentage}%
|
|
375
|
+
|
|
376
|
+
**Upfront Effort Estimate**:
|
|
377
|
+
- Quick Start: **2-3 hours** (Core concepts only)
|
|
378
|
+
- Comprehensive: ~{weeks} weeks (Full documentation)
|
|
379
|
+
|
|
380
|
+
**Recommended Path**: Quick Start
|
|
381
|
+
|
|
382
|
+
**Why Quick Start?**
|
|
383
|
+
- Large codebase would take {weeks} to fully document
|
|
384
|
+
- Start delivering value in days, not weeks
|
|
385
|
+
- Document as you modify code (safer, focused)
|
|
386
|
+
|
|
387
|
+
---
|
|
388
|
+
|
|
389
|
+
## Core Architecture Extracted
|
|
390
|
+
|
|
391
|
+
**High-Level Components**:
|
|
392
|
+
- {Component 1}: {Brief description}
|
|
393
|
+
- {Component 2}: {Brief description}
|
|
394
|
+
- {Component 3}: {Brief description}
|
|
395
|
+
|
|
396
|
+
**Critical Patterns Identified**:
|
|
397
|
+
- Authentication: {pattern}
|
|
398
|
+
- Authorization: {pattern}
|
|
399
|
+
- Data Flow: {pattern}
|
|
400
|
+
- Error Handling: {pattern}
|
|
401
|
+
|
|
402
|
+
**Tech Stack**:
|
|
403
|
+
- Frontend: {frameworks}
|
|
404
|
+
- Backend: {frameworks}
|
|
405
|
+
- Database: {databases}
|
|
406
|
+
- Infrastructure: {platform}
|
|
407
|
+
|
|
408
|
+
**Business Domains** (detected from folder structure):
|
|
409
|
+
- `src/{domain1}/` - {estimated purpose}
|
|
410
|
+
- `src/{domain2}/` - {estimated purpose}
|
|
411
|
+
- `src/{domain3}/` - {estimated purpose}
|
|
412
|
+
|
|
413
|
+
---
|
|
414
|
+
|
|
415
|
+
## External Tools Detected
|
|
416
|
+
|
|
417
|
+
- **Jira**: {url} ({count} active epics)
|
|
418
|
+
- **GitHub**: {repo} ({count} open issues)
|
|
419
|
+
|
|
420
|
+
---
|
|
421
|
+
|
|
422
|
+
## Recommended Next Steps (Quick Start)
|
|
423
|
+
|
|
424
|
+
1. ✅ **Review this report** (5 minutes)
|
|
425
|
+
2. ✅ **Create `.specweave/` structure** (5 minutes)
|
|
426
|
+
3. ✅ **Document core architecture** (1-2 hours)
|
|
427
|
+
- Create `.specweave/docs/internal/architecture/core-architecture.md`
|
|
428
|
+
- Document high-level components from above
|
|
429
|
+
4. ✅ **Start first increment** (immediate)
|
|
430
|
+
- Choose feature to implement/modify
|
|
431
|
+
- Document affected code BEFORE modifying
|
|
432
|
+
- Implement with regression tests
|
|
433
|
+
- Update docs AFTER change
|
|
434
|
+
|
|
435
|
+
**Total Time to Start**: 2-3 hours
|
|
436
|
+
|
|
437
|
+
**Per-Increment Pattern**:
|
|
438
|
+
```
|
|
439
|
+
1. Document affected code (30 min)
|
|
440
|
+
2. Add regression tests (30 min)
|
|
441
|
+
3. Implement change (varies)
|
|
442
|
+
4. Update docs (20 min)
|
|
443
|
+
```
|
|
444
|
+
|
|
445
|
+
---
|
|
446
|
+
|
|
447
|
+
## Skipped in Quick Start Mode
|
|
448
|
+
|
|
449
|
+
The following will be documented **per increment** as needed:
|
|
450
|
+
- Detailed module documentation
|
|
451
|
+
- Complete business rules catalog
|
|
452
|
+
- Full API documentation
|
|
453
|
+
- Comprehensive test coverage
|
|
454
|
+
|
|
455
|
+
**This is intentional** - focuses effort where it matters.
|
|
456
|
+
|
|
457
|
+
---
|
|
458
|
+
|
|
459
|
+
## Alternative: Switch to Comprehensive
|
|
460
|
+
|
|
461
|
+
If you prefer full upfront documentation:
|
|
462
|
+
- Run: `brownfield-analyzer --comprehensive`
|
|
463
|
+
- Effort: ~{weeks} weeks
|
|
464
|
+
- Result: Complete specs before any code changes
|
|
465
|
+
|
|
466
|
+
---
|
|
467
|
+
```
|
|
468
|
+
|
|
469
|
+
### Comprehensive Report
|
|
470
|
+
|
|
471
|
+
```markdown
|
|
472
|
+
# Brownfield Analysis Report - Comprehensive Mode
|
|
473
|
+
|
|
474
|
+
**Project**: {project-name}
|
|
475
|
+
**Analyzed**: {date}
|
|
476
|
+
**Mode**: Comprehensive (Upfront Documentation)
|
|
194
477
|
**Total Files Scanned**: {count}
|
|
195
478
|
|
|
196
479
|
---
|
|
197
480
|
|
|
481
|
+
## Complexity Assessment 🆕
|
|
482
|
+
|
|
483
|
+
**Project Size**: {size} ({LOC} LOC)
|
|
484
|
+
**Recommended**: {path}
|
|
485
|
+
**Estimated Effort**: {weeks}
|
|
486
|
+
|
|
487
|
+
---
|
|
488
|
+
|
|
198
489
|
## Executive Summary
|
|
199
490
|
|
|
200
491
|
- **Documentation Files**: {count} markdown files found
|
|
@@ -302,9 +593,8 @@ build/**
|
|
|
302
593
|
3. Link increments to related docs (PRD, HLD, ADR, RFC)
|
|
303
594
|
|
|
304
595
|
### Phase 5: External Tool Sync ({X} hours)
|
|
305
|
-
1.
|
|
306
|
-
2.
|
|
307
|
-
3. Verify all Epics are mapped
|
|
596
|
+
1. Run sync command to link Epics → Increments (credentials auto-detected or prompted)
|
|
597
|
+
2. Verify all Epics are mapped
|
|
308
598
|
|
|
309
599
|
### Phase 6: Verification (30 minutes)
|
|
310
600
|
1. Run `specweave verify`
|
|
@@ -336,7 +626,7 @@ build/**
|
|
|
336
626
|
```bash
|
|
337
627
|
specweave migrate --plan analysis-report.md --execute
|
|
338
628
|
```
|
|
339
|
-
5. **Enable sync** -
|
|
629
|
+
5. **Enable sync** - Run sync commands for Jira/ADO integration
|
|
340
630
|
|
|
341
631
|
---
|
|
342
632
|
|
|
@@ -378,24 +668,138 @@ build/**
|
|
|
378
668
|
### Initial Request
|
|
379
669
|
**User**: "Analyze my existing project at /path/to/project"
|
|
380
670
|
|
|
381
|
-
### Your Response
|
|
671
|
+
### Your Response (Step 1: Complexity Assessment) 🆕
|
|
672
|
+
|
|
382
673
|
```
|
|
383
|
-
I'll analyze your existing project
|
|
674
|
+
I'll analyze your existing project to determine the best onboarding approach.
|
|
675
|
+
|
|
676
|
+
Step 1: Assessing project complexity...
|
|
677
|
+
|
|
678
|
+
Running: cloc . --exclude-dir=node_modules,vendor,dist
|
|
679
|
+
|
|
680
|
+
🔍 Complexity Analysis:
|
|
681
|
+
|
|
682
|
+
Metrics:
|
|
683
|
+
• 85,420 LOC detected
|
|
684
|
+
• 342 files analyzed
|
|
685
|
+
• Languages: TypeScript (55,273), JavaScript (25,147), CSS (5,000)
|
|
686
|
+
• Estimated modules: 12
|
|
687
|
+
• Test coverage: 45% (from coverage reports)
|
|
688
|
+
• Existing docs: 23 markdown files
|
|
689
|
+
• External tools: Jira (PROJ-*), GitHub
|
|
690
|
+
|
|
691
|
+
Complexity Assessment: LARGE PROJECT
|
|
692
|
+
• Size: Large (85k LOC)
|
|
693
|
+
• Full analysis effort: 2-3 weeks
|
|
694
|
+
• Recommended path: Quick Start
|
|
695
|
+
|
|
696
|
+
---
|
|
697
|
+
|
|
698
|
+
Recommendation: QUICK START PATH
|
|
699
|
+
|
|
700
|
+
Why?
|
|
701
|
+
✓ Large codebase (85k LOC)
|
|
702
|
+
✓ Full documentation would take 2-3 weeks
|
|
703
|
+
✓ Start delivering value in 2-3 hours instead
|
|
704
|
+
✓ Document incrementally as you modify code
|
|
705
|
+
|
|
706
|
+
Quick Start Process:
|
|
707
|
+
1. Document core architecture only (2-3 hours)
|
|
708
|
+
2. Start first increment immediately
|
|
709
|
+
3. Per increment: Document → Modify → Update
|
|
710
|
+
4. Documentation grows with changes
|
|
711
|
+
|
|
712
|
+
Alternative: Comprehensive Upfront
|
|
713
|
+
⚠️ Full documentation (2-3 weeks)
|
|
714
|
+
→ Only if you need complete context before starting
|
|
715
|
+
|
|
716
|
+
---
|
|
717
|
+
|
|
718
|
+
Which path do you prefer?
|
|
719
|
+
1. Quick Start (recommended) - Start in 2-3 hours
|
|
720
|
+
2. Comprehensive - Full analysis (2-3 weeks)
|
|
721
|
+
3. Let me decide based on your recommendation
|
|
722
|
+
|
|
723
|
+
```
|
|
724
|
+
|
|
725
|
+
### User Chooses Quick Start
|
|
726
|
+
|
|
727
|
+
```
|
|
728
|
+
Great! I'll perform a Quick Start analysis focusing on core concepts.
|
|
729
|
+
|
|
730
|
+
Step 2: Scanning for core architecture...
|
|
731
|
+
|
|
732
|
+
Found:
|
|
733
|
+
- 12 high-level modules
|
|
734
|
+
- 4 critical patterns (auth, payment, data flow, error handling)
|
|
735
|
+
- 23 existing markdown files
|
|
736
|
+
- 8 diagrams
|
|
737
|
+
- Jira project detected (PROJ) with 12 active epics
|
|
738
|
+
|
|
739
|
+
Extracting core architecture... ✅
|
|
740
|
+
|
|
741
|
+
I've generated a Quick Start analysis report. Here's the summary:
|
|
742
|
+
|
|
743
|
+
**Core Architecture Extracted**:
|
|
744
|
+
- API Gateway (routing, auth)
|
|
745
|
+
- User Service (user management, profiles)
|
|
746
|
+
- Payment Service (Stripe integration)
|
|
747
|
+
- Notification Service (email/SMS)
|
|
748
|
+
- Database Layer (PostgreSQL)
|
|
749
|
+
|
|
750
|
+
**Critical Patterns**:
|
|
751
|
+
- Auth: JWT tokens, refresh mechanism
|
|
752
|
+
- Payment: Stripe webhooks, idempotency
|
|
753
|
+
- Data Flow: Event-driven (Redis pub/sub)
|
|
754
|
+
- Errors: Centralized error handler
|
|
755
|
+
|
|
756
|
+
**Tech Stack**:
|
|
757
|
+
- Frontend: Next.js 14, React, Tailwind
|
|
758
|
+
- Backend: Node.js 20, Express, TypeScript
|
|
759
|
+
- Database: PostgreSQL 16, Prisma ORM
|
|
760
|
+
- Infrastructure: Docker, Hetzner Cloud
|
|
761
|
+
|
|
762
|
+
**External Tools**: Jira (12 active epics) → Can map to increments
|
|
763
|
+
|
|
764
|
+
**Estimated Time to Start**: 2-3 hours (document core architecture)
|
|
765
|
+
|
|
766
|
+
---
|
|
767
|
+
|
|
768
|
+
Next Steps:
|
|
769
|
+
1. ✅ Create `.specweave/` structure (5 min)
|
|
770
|
+
2. ✅ Document core architecture (2 hours) - I can help
|
|
771
|
+
3. ✅ Start first increment (immediate)
|
|
772
|
+
|
|
773
|
+
Should I:
|
|
774
|
+
1. Create the SpecWeave structure and document core architecture?
|
|
775
|
+
2. Show the full Quick Start report first?
|
|
776
|
+
3. Map Jira epics to increments?
|
|
777
|
+
```
|
|
778
|
+
|
|
779
|
+
### User Chooses Comprehensive
|
|
780
|
+
|
|
781
|
+
```
|
|
782
|
+
Understood! I'll perform a comprehensive analysis of the entire codebase.
|
|
783
|
+
|
|
784
|
+
⚠️ This will take some time for a project of this size.
|
|
785
|
+
|
|
786
|
+
Step 2: Comprehensive scan...
|
|
384
787
|
|
|
385
788
|
Scanning: /path/to/project
|
|
386
789
|
|
|
387
790
|
Found:
|
|
388
|
-
-
|
|
791
|
+
- 342 source files
|
|
792
|
+
- 23 markdown files
|
|
389
793
|
- 8 diagrams
|
|
390
794
|
- Jira project detected (PROJ)
|
|
391
795
|
|
|
392
|
-
Analyzing... (this may take a
|
|
796
|
+
Analyzing... (this may take a few minutes)
|
|
393
797
|
|
|
394
798
|
✅ Analysis complete!
|
|
395
799
|
|
|
396
800
|
I've generated a comprehensive analysis report. Here's the summary:
|
|
397
801
|
|
|
398
|
-
**Documentation**:
|
|
802
|
+
**Documentation**: 23 files classified
|
|
399
803
|
- PRD candidates: 3
|
|
400
804
|
- HLD candidates: 2
|
|
401
805
|
- ADR candidates: 8
|
|
@@ -405,15 +809,17 @@ I've generated a comprehensive analysis report. Here's the summary:
|
|
|
405
809
|
|
|
406
810
|
**Diagrams**: 8 diagrams (6 need Mermaid conversion)
|
|
407
811
|
|
|
812
|
+
**Modules Analyzed**: 12 major modules documented
|
|
813
|
+
|
|
408
814
|
**External Tools**: Jira project PROJ with 12 active epics
|
|
409
815
|
|
|
410
816
|
**Suggested**: Create 12 increments (one per Jira epic)
|
|
411
817
|
|
|
412
|
-
**Estimated Effort**: 3
|
|
818
|
+
**Estimated Migration Effort**: 2-3 weeks (full documentation)
|
|
413
819
|
|
|
414
820
|
Would you like me to:
|
|
415
|
-
1. Show the full
|
|
416
|
-
2.
|
|
821
|
+
1. Show the full comprehensive report?
|
|
822
|
+
2. Start migration (Phase 1: Structure creation)?
|
|
417
823
|
3. Adjust any classifications?
|
|
418
824
|
```
|
|
419
825
|
|
|
@@ -456,7 +862,7 @@ Your project is now using SpecWeave's PRD/HLD/RFC/Runbook pattern.
|
|
|
456
862
|
|
|
457
863
|
Next steps:
|
|
458
864
|
1. Review migrated documents
|
|
459
|
-
2. Run:
|
|
865
|
+
2. Run: npm run docs:dev (to view documentation)
|
|
460
866
|
3. Configure ongoing sync: specweave sync --daemon
|
|
461
867
|
```
|
|
462
868
|
|
|
@@ -485,7 +891,7 @@ for (file of files) {
|
|
|
485
891
|
|
|
486
892
|
## Configuration
|
|
487
893
|
|
|
488
|
-
**
|
|
894
|
+
**Default scan patterns** are built-in. Advanced users can customize by creating `.specweave/brownfield-config.yaml`:
|
|
489
895
|
|
|
490
896
|
```yaml
|
|
491
897
|
brownfield:
|