@atlashub/smartstack-cli 1.33.0 → 1.35.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/.documentation/installation.html +60 -38
- package/dist/index.js +1098 -582
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
- package/templates/agents/docs-context-reader.md +125 -0
- package/templates/agents/docs-sync-checker.md +122 -0
- package/templates/hooks/docs-drift-check.md +97 -0
- package/templates/skills/_resources/context-digest-template.md +53 -0
- package/templates/skills/_resources/doc-context-cache.md +62 -0
- package/templates/skills/_resources/docs-manifest-schema.md +157 -0
- package/templates/skills/_resources/mcp-validate-documentation-spec.md +183 -0
- package/templates/skills/_shared.md +8 -0
- package/templates/skills/apex/SKILL.md +6 -0
- package/templates/skills/apex/steps/step-00-init.md +9 -0
- package/templates/skills/apex/steps/step-01-analyze.md +36 -0
- package/templates/skills/apex/steps/step-02-plan.md +38 -0
- package/templates/skills/apex/steps/step-03-execute.md +39 -0
- package/templates/skills/apex/steps/step-04-validate.md +31 -1
- package/templates/skills/apex/steps/step-04b-doc-sync.md +162 -0
- package/templates/skills/apex/steps/step-05-examine.md +7 -0
- package/templates/skills/apex/templates/04b-doc-sync.md +31 -0
- package/templates/skills/apex/templates/context-digest.md +35 -0
- package/templates/skills/business-analyse/SKILL.md +18 -5
- package/templates/skills/business-analyse/_shared.md +306 -4
- package/templates/skills/business-analyse/questionnaire/01-context.md +21 -6
- package/templates/skills/business-analyse/questionnaire/02-stakeholders.md +34 -0
- package/templates/skills/business-analyse/questionnaire/03-scope.md +23 -0
- package/templates/skills/business-analyse/questionnaire/04-data.md +44 -0
- package/templates/skills/business-analyse/questionnaire/05-integrations.md +29 -7
- package/templates/skills/business-analyse/questionnaire/06-security.md +28 -0
- package/templates/skills/business-analyse/questionnaire/07-ui.md +32 -7
- package/templates/skills/business-analyse/questionnaire/08-performance.md +21 -0
- package/templates/skills/business-analyse/questionnaire/09-constraints.md +29 -6
- package/templates/skills/business-analyse/questionnaire/10-documentation.md +27 -6
- package/templates/skills/business-analyse/questionnaire/11-data-lifecycle.md +59 -0
- package/templates/skills/business-analyse/questionnaire/12-migration.md +58 -0
- package/templates/skills/business-analyse/questionnaire/13-cross-module.md +69 -0
- package/templates/skills/business-analyse/steps/step-00-init.md +110 -16
- package/templates/skills/business-analyse/steps/step-01-discover.md +530 -85
- package/templates/skills/business-analyse/steps/step-02-analyse.md +81 -25
- package/templates/skills/business-analyse/steps/step-03-specify.md +116 -24
- package/templates/skills/business-analyse/steps/step-04-validate.md +107 -33
- package/templates/skills/business-analyse/steps/step-05-handoff.md +256 -33
- package/templates/skills/business-analyse/steps/step-06-doc-html.md +84 -25
- package/templates/skills/business-analyse/templates/{frd-handoff.md → tpl-handoff.md} +18 -4
- package/templates/skills/business-analyse/templates-frd.md +19 -5
- package/templates/skills/business-analyse/tracking/change-template.md +30 -0
- package/templates/skills/documentation/SKILL.md +68 -31
- package/templates/skills/documentation/data-schema.md +198 -0
- package/templates/skills/documentation/templates.md +30 -1
- package/templates/skills/gitflow/steps/step-init.md +268 -20
- package/templates/skills/gitflow/templates/config.json +7 -0
- package/templates/skills/ralph-loop/SKILL.md +3 -0
- /package/templates/skills/business-analyse/templates/{frd-brd.md → tpl-brd.md} +0 -0
- /package/templates/skills/business-analyse/templates/{frd-discovery.md → tpl-discovery.md} +0 -0
- /package/templates/skills/business-analyse/templates/{frd-spec.md → tpl-frd.md} +0 -0
|
@@ -1,25 +1,21 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: step-05-handoff
|
|
3
3
|
description: Handoff phase - Generate autonomous development prompt
|
|
4
|
-
model: opus
|
|
5
|
-
prev_step: steps/step-04-validate.md
|
|
6
4
|
next_step: steps/step-06-doc-html.md
|
|
7
5
|
---
|
|
8
6
|
|
|
9
|
-
|
|
10
|
-
|
|
7
|
+
## YOUR TASK:
|
|
8
|
+
|
|
9
|
+
Generate a complete, autonomous development prompt with Ralph Loop task breakdown for iterative implementation.
|
|
11
10
|
The handoff must be zero-ambiguity: a developer (or Claude) can implement without questions.
|
|
12
|
-
</objective>
|
|
13
11
|
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
-
|
|
17
|
-
-
|
|
18
|
-
-
|
|
19
|
-
- No assumptions about "obvious" behavior
|
|
20
|
-
</ultrathink>
|
|
12
|
+
> **ULTRATHINK MODE:**
|
|
13
|
+
> - Every implementation detail must be explicit
|
|
14
|
+
> - File paths must be exact
|
|
15
|
+
> - Patterns must reference existing code
|
|
16
|
+
> - No assumptions about "obvious" behavior
|
|
21
17
|
|
|
22
|
-
## EXECUTION SEQUENCE
|
|
18
|
+
## EXECUTION SEQUENCE:
|
|
23
19
|
|
|
24
20
|
### 1. Read Current State
|
|
25
21
|
|
|
@@ -29,6 +25,10 @@ Read specs: `{output_dir}/3-functional-specification.md`
|
|
|
29
25
|
|
|
30
26
|
Update progress: `05-handoff` -> "In Progress"
|
|
31
27
|
|
|
28
|
+
**Read digest from previous step:**
|
|
29
|
+
Read `{output_dir}/digest-04.md` for compressed context from previous step.
|
|
30
|
+
**DO NOT read full output files** unless in resume mode (`-r`).
|
|
31
|
+
|
|
32
32
|
---
|
|
33
33
|
|
|
34
34
|
### 2. Verify Validation Passed
|
|
@@ -45,7 +45,7 @@ END IF
|
|
|
45
45
|
### 3. Load Handoff Template
|
|
46
46
|
|
|
47
47
|
```
|
|
48
|
-
Read: templates/
|
|
48
|
+
Read: templates/tpl-handoff.md # ~100 lines
|
|
49
49
|
```
|
|
50
50
|
|
|
51
51
|
---
|
|
@@ -217,14 +217,25 @@ For each file, provide explicit instructions:
|
|
|
217
217
|
> **Module:** business/{application_name}/{module_name}
|
|
218
218
|
> **Version:** 1.0
|
|
219
219
|
> **Validated Specs:** FRD v1.0 (validation.json: APPROVED)
|
|
220
|
-
> **Implementation:** `/
|
|
220
|
+
> **Implementation:** `/ralph-loop -r` (iterative) | `/feature-full business/{application_name}/{module_name}` (one-shot)
|
|
221
221
|
|
|
222
222
|
## DEVELOPER INSTRUCTIONS
|
|
223
223
|
|
|
224
|
-
|
|
224
|
+
Ce document est un prompt autonome pour Claude Code.
|
|
225
|
+
|
|
226
|
+
**Option 1 - Itératif (recommandé) :**
|
|
225
227
|
```
|
|
226
|
-
/
|
|
228
|
+
/ralph-loop -r
|
|
227
229
|
```
|
|
230
|
+
> Le fichier `.ralph/prd.json` a été pré-généré avec le découpage en tâches atomiques.
|
|
231
|
+
> Ralph Loop exécute chaque tâche avec validation MCP entre chaque itération.
|
|
232
|
+
|
|
233
|
+
**Option 2 - One-shot :**
|
|
234
|
+
```
|
|
235
|
+
/feature-full business/{application_name}/{module_name}
|
|
236
|
+
```
|
|
237
|
+
> Génère l'implémentation full-stack complète en une seule passe
|
|
238
|
+
> (Domain → Application → Infrastructure → API → Web + Notifications + Workflows + AI).
|
|
228
239
|
|
|
229
240
|
---
|
|
230
241
|
|
|
@@ -268,19 +279,63 @@ This document is a standalone prompt for Claude Code. Execute:
|
|
|
268
279
|
- [ ] Permissions in PermissionConfiguration.cs
|
|
269
280
|
- [ ] i18n complete (FR, EN, IT, DE)
|
|
270
281
|
- [ ] Documentation: `/business-analyse:6-doc-html {feature_id}`
|
|
282
|
+
- [ ] Documentation manifest updated: `docs-manifest.json`
|
|
271
283
|
|
|
272
284
|
---
|
|
273
285
|
|
|
274
286
|
## EXECUTION
|
|
275
287
|
|
|
288
|
+
**Itératif (recommandé) :**
|
|
289
|
+
```bash
|
|
290
|
+
/ralph-loop -r
|
|
291
|
+
```
|
|
292
|
+
|
|
293
|
+
**One-shot :**
|
|
276
294
|
```bash
|
|
277
|
-
/
|
|
295
|
+
/feature-full business/{application_name}/{module_name}
|
|
278
296
|
```
|
|
279
297
|
```
|
|
280
298
|
|
|
281
299
|
---
|
|
282
300
|
|
|
283
|
-
### 12.
|
|
301
|
+
### 12. Generate Context Digest
|
|
302
|
+
|
|
303
|
+
**Write digest to:** `{output_dir}/digest-05.md`
|
|
304
|
+
|
|
305
|
+
```markdown
|
|
306
|
+
# Digest: Step 05 - Handoff
|
|
307
|
+
|
|
308
|
+
## Changes
|
|
309
|
+
- {output_dir}/4-development-handoff.md: Handoff document created
|
|
310
|
+
- .ralph/prd.json: Ralph Loop task breakdown created
|
|
311
|
+
- .ralph/progress.txt: Progress file initialized
|
|
312
|
+
|
|
313
|
+
## Decisions
|
|
314
|
+
- Implementation mode: iterative (Ralph Loop) or one-shot (feature-full)
|
|
315
|
+
- Task count: {tasks_total} atomic tasks
|
|
316
|
+
- Complexity: {Simple/Medium/Complex}
|
|
317
|
+
|
|
318
|
+
## Findings
|
|
319
|
+
- Backend files to create: {count}
|
|
320
|
+
- Frontend files to create: {count}
|
|
321
|
+
- Test files to create: {count}
|
|
322
|
+
|
|
323
|
+
## State Updates
|
|
324
|
+
| Variable | New Value |
|
|
325
|
+
|----------|-----------|
|
|
326
|
+
| tasks_total | {count} |
|
|
327
|
+
| ralph_prd_created | true |
|
|
328
|
+
| handoff_ready | true |
|
|
329
|
+
|
|
330
|
+
## For Next Step
|
|
331
|
+
- Documentation generation ready (step-06)
|
|
332
|
+
- FRD data extraction needed for React components
|
|
333
|
+
- i18n: 4 languages to create
|
|
334
|
+
```
|
|
335
|
+
|
|
336
|
+
---
|
|
337
|
+
|
|
338
|
+
### 12a. Save Output
|
|
284
339
|
|
|
285
340
|
Write to: `{output_dir}/4-development-handoff.md`
|
|
286
341
|
|
|
@@ -289,19 +344,148 @@ Update `00-context.md`:
|
|
|
289
344
|
|
|
290
345
|
---
|
|
291
346
|
|
|
292
|
-
###
|
|
347
|
+
### 12b. Generate Ralph Loop Task Breakdown
|
|
293
348
|
|
|
294
|
-
**
|
|
349
|
+
**Purpose:** Generate `.ralph/prd.json` and `.ralph/progress.txt` so the implementation can be executed via `/ralph-loop -r`.
|
|
350
|
+
|
|
351
|
+
#### 12bis.1 Create .ralph/ directory structure
|
|
352
|
+
|
|
353
|
+
```bash
|
|
354
|
+
mkdir -p .ralph/logs
|
|
355
|
+
mkdir -p .ralph/reports
|
|
356
|
+
```
|
|
357
|
+
|
|
358
|
+
#### 12bis.2 Derive Task List from Handoff
|
|
359
|
+
|
|
360
|
+
**ULTRATHINK about task decomposition:**
|
|
361
|
+
- Each task must be atomic (implementable in one Ralph iteration)
|
|
362
|
+
- Tasks follow the SmartStack layer order: Domain → Application → Infrastructure → API → Frontend → Tests → Validation
|
|
363
|
+
- Conditionally include tasks based on feature scope (skip layers not present in the handoff document)
|
|
364
|
+
|
|
365
|
+
**Conditional Task Generation Rules:**
|
|
366
|
+
|
|
367
|
+
For each layer, generate tasks ONLY if the handoff document contains specifications for that layer.
|
|
368
|
+
|
|
369
|
+
```
|
|
370
|
+
LAYER 1 - DOMAIN (if entities defined in handoff section 3/4):
|
|
371
|
+
Task: "Create {Entity} entity in SmartStack.Domain/Entities/Business/ with properties: {property_list}"
|
|
372
|
+
Task: "Create {Entity}Status enum if status workflow defined"
|
|
373
|
+
(One task per entity)
|
|
374
|
+
|
|
375
|
+
LAYER 2 - APPLICATION (if CQRS handlers defined in handoff section 3/4):
|
|
376
|
+
Task: "Create CQRS Commands for {Entity}: {Create/Update/Delete}Command + Handler + Validator"
|
|
377
|
+
Task: "Create CQRS Queries for {Entity}: GetAll{Entity}Query, Get{Entity}ByIdQuery + Handlers"
|
|
378
|
+
Task: "Create DTOs for {Entity}: {Entity}Dto, Create{Entity}Request, Update{Entity}Request"
|
|
379
|
+
Task: "Register permissions in Permissions.cs and PermissionConfiguration.cs for business.{app}.{module}"
|
|
380
|
+
|
|
381
|
+
LAYER 3 - INFRASTRUCTURE (if EF Core config or services in handoff):
|
|
382
|
+
Task: "Create EF Core configuration for {Entity} with HasData seed and migration"
|
|
383
|
+
Task: "Register {Entity} DbSet in ApplicationDbContext"
|
|
384
|
+
Task: "Create {Entity}Service implementing I{Entity}Service with DI registration" (if services needed)
|
|
385
|
+
|
|
386
|
+
LAYER 4 - API (if endpoints defined in handoff section 8):
|
|
387
|
+
Task: "Create {Module}Controller with CRUD endpoints: GET, POST, GET/{id}, PUT/{id}, DELETE/{id}"
|
|
388
|
+
|
|
389
|
+
LAYER 5 - FRONTEND (if frontend files in handoff section 5):
|
|
390
|
+
Task: "Create {module}Api.ts API service with Axios calls"
|
|
391
|
+
Task: "Create use{Module}.ts hook with React Query + SignalR"
|
|
392
|
+
Task: "Create {Module}Page.tsx list page with EntityCard"
|
|
393
|
+
Task: "Create {Module}Form.tsx create/edit form"
|
|
394
|
+
Task: "Add routes in App.tsx for business/{app}/{module}"
|
|
395
|
+
|
|
396
|
+
LAYER 6 - I18N (if i18n keys in handoff section 10):
|
|
397
|
+
Task: "Create i18n translation files for {module} in 4 languages (fr, en, it, de)"
|
|
398
|
+
|
|
399
|
+
LAYER 7 - TESTS (always included):
|
|
400
|
+
Task: "Create unit tests: {Entity}ValidatorTests + {Entity}Tests"
|
|
401
|
+
Task: "Create integration tests: {Module}ControllerTests with 200, 201, 400, 403, 404 scenarios"
|
|
402
|
+
|
|
403
|
+
LAYER 8 - VALIDATION (always included):
|
|
404
|
+
Task: "Run dotnet build, pnpm build, dotnet test - fix any failures"
|
|
405
|
+
Task: "Run MCP validate_conventions to verify all naming conventions"
|
|
406
|
+
```
|
|
407
|
+
|
|
408
|
+
**Sizing rules:**
|
|
409
|
+
- Simple feature (1 entity, CRUD only): ~8-12 tasks
|
|
410
|
+
- Medium feature (2-3 entities, business rules): ~15-20 tasks
|
|
411
|
+
- Complex feature (multiple entities, integrations): ~20-30 tasks
|
|
412
|
+
|
|
413
|
+
#### 12bis.3 Write prd.json
|
|
414
|
+
|
|
415
|
+
Write to: `.ralph/prd.json`
|
|
416
|
+
|
|
417
|
+
```json
|
|
418
|
+
{
|
|
419
|
+
"feature": "{feature_id} - {feature_description}",
|
|
420
|
+
"created": "{ISO 8601 timestamp}",
|
|
421
|
+
"max_iterations": 30,
|
|
422
|
+
"completion_promise": "IMPLEMENTATION COMPLETE",
|
|
423
|
+
"current_iteration": 1,
|
|
424
|
+
"source": "{output_dir}/4-development-handoff.md",
|
|
425
|
+
"tasks": [
|
|
426
|
+
{ "id": 1, "description": "...", "passes": false },
|
|
427
|
+
{ "id": 2, "description": "...", "passes": false }
|
|
428
|
+
]
|
|
429
|
+
}
|
|
295
430
|
```
|
|
296
|
-
|
|
297
|
-
|
|
298
|
-
|
|
299
|
-
|
|
300
|
-
|
|
301
|
-
|
|
302
|
-
|
|
431
|
+
|
|
432
|
+
> **Note:** The `source` field links back to the handoff document for reference. It is not read by Ralph's execution engine and is backward-compatible.
|
|
433
|
+
|
|
434
|
+
#### 12bis.4 Initialize progress.txt
|
|
435
|
+
|
|
436
|
+
Write to: `.ralph/progress.txt`
|
|
437
|
+
|
|
438
|
+
```markdown
|
|
439
|
+
# Ralph Loop Progress
|
|
440
|
+
|
|
441
|
+
## Task: {feature_id} - {feature_description}
|
|
442
|
+
## Source: {output_dir}/4-development-handoff.md
|
|
443
|
+
## Started: {timestamp}
|
|
444
|
+
## Generated by: Business Analysis skill (step-05-handoff)
|
|
445
|
+
|
|
446
|
+
---
|
|
447
|
+
|
|
448
|
+
## Handoff Reference
|
|
449
|
+
|
|
450
|
+
The detailed specifications for this implementation are in:
|
|
451
|
+
- **Handoff document:** `{output_dir}/4-development-handoff.md`
|
|
452
|
+
- **Functional Specification:** `{output_dir}/3-functional-specification.md`
|
|
453
|
+
- **Business Requirements:** `{output_dir}/2-business-requirements.md`
|
|
454
|
+
- **Validation:** `{output_dir}/validation.json`
|
|
455
|
+
|
|
456
|
+
Consult these documents for entity properties, business rules, API endpoints, and test requirements.
|
|
457
|
+
|
|
458
|
+
---
|
|
459
|
+
|
|
460
|
+
## Iteration 1
|
|
461
|
+
|
|
462
|
+
### Context
|
|
463
|
+
Starting fresh implementation from BA handoff.
|
|
464
|
+
Task breakdown generated from business analysis with {tasks_total} tasks.
|
|
465
|
+
|
|
466
|
+
### Learnings
|
|
467
|
+
(To be updated after each iteration)
|
|
303
468
|
```
|
|
304
469
|
|
|
470
|
+
---
|
|
471
|
+
|
|
472
|
+
### 12c. Display Summary and Offer Next Step
|
|
473
|
+
|
|
474
|
+
**Display:**
|
|
475
|
+
|
|
476
|
+
| Field | Value |
|
|
477
|
+
|-------|-------|
|
|
478
|
+
| Step | HANDOFF |
|
|
479
|
+
| Feature | {feature_id} |
|
|
480
|
+
| Status | Complete |
|
|
481
|
+
| Files to create | {file count} |
|
|
482
|
+
| Tests to write | {test count} |
|
|
483
|
+
| Output | {output_dir}/4-development-handoff.md |
|
|
484
|
+
| Ralph Loop | .ralph/prd.json ({tasks_total} tasks) |
|
|
485
|
+
| Execute (iterative) | /ralph-loop -r |
|
|
486
|
+
| Execute (one-shot) | /feature-full business/{application_name}/{module_name} |
|
|
487
|
+
| Optional | step-06-doc-html (React documentation) |
|
|
488
|
+
|
|
305
489
|
**Ask user:**
|
|
306
490
|
```json
|
|
307
491
|
{
|
|
@@ -310,9 +494,10 @@ HANDOFF - {feature_id}
|
|
|
310
494
|
"question": "What would you like to do now?",
|
|
311
495
|
"header": "Next",
|
|
312
496
|
"options": [
|
|
313
|
-
{"label": "
|
|
314
|
-
{"label": "
|
|
315
|
-
{"label": "
|
|
497
|
+
{"label": "Ralph Loop (itératif)", "description": "Exécuter /ralph-loop -r — recommandé pour les features complexes ({tasks_total} tâches atomiques)"},
|
|
498
|
+
{"label": "Feature Full (one-shot)", "description": "Exécuter /feature-full business/{application_name}/{module_name} — pour les features simples"},
|
|
499
|
+
{"label": "Generate HTML documentation", "description": "Créer la page de documentation React d'abord"},
|
|
500
|
+
{"label": "End BA", "description": "Terminer ici, implémenter plus tard"}
|
|
316
501
|
],
|
|
317
502
|
"multiSelect": false
|
|
318
503
|
}
|
|
@@ -320,17 +505,55 @@ HANDOFF - {feature_id}
|
|
|
320
505
|
}
|
|
321
506
|
```
|
|
322
507
|
|
|
508
|
+
If "Ralph Loop (itératif)":
|
|
509
|
+
```
|
|
510
|
+
DISPLAY: "Execute: /ralph-loop -r"
|
|
511
|
+
DISPLAY: "Le prd.json a été pré-généré avec {tasks_total} tâches."
|
|
512
|
+
```
|
|
513
|
+
|
|
514
|
+
If "Feature Full (one-shot)":
|
|
515
|
+
```
|
|
516
|
+
DISPLAY: "Execute: /feature-full business/{application_name}/{module_name}"
|
|
517
|
+
```
|
|
518
|
+
|
|
323
519
|
If "Generate HTML documentation":
|
|
324
520
|
```
|
|
325
521
|
Read and execute: steps/step-06-doc-html.md
|
|
326
522
|
```
|
|
327
523
|
|
|
524
|
+
If "End BA":
|
|
525
|
+
```
|
|
526
|
+
DISPLAY: "BA terminé. Pour implémenter plus tard :"
|
|
527
|
+
DISPLAY: " Itératif : /ralph-loop -r"
|
|
528
|
+
DISPLAY: " One-shot : /feature-full business/{application_name}/{module_name}"
|
|
529
|
+
```
|
|
530
|
+
|
|
328
531
|
---
|
|
329
532
|
|
|
330
|
-
## OUTPUT
|
|
533
|
+
## OUTPUT FORMAT:
|
|
331
534
|
|
|
332
535
|
This step produces:
|
|
333
536
|
- `{output_dir}/4-development-handoff.md` (created)
|
|
334
537
|
- `{output_dir}/00-context.md` (updated)
|
|
538
|
+
- `.ralph/prd.json` (created - Ralph Loop task breakdown)
|
|
539
|
+
- `.ralph/progress.txt` (created - with BA references)
|
|
540
|
+
|
|
541
|
+
Handoff is ready for:
|
|
542
|
+
- **Iterative:** `/ralph-loop -r`
|
|
543
|
+
- **One-shot:** `/feature-full business/{application_name}/{module_name}`
|
|
544
|
+
|
|
545
|
+
## ERROR HANDLING:
|
|
546
|
+
|
|
547
|
+
**If pattern exploration fails:**
|
|
548
|
+
1. Use minimal handoff template without code references
|
|
549
|
+
2. Mark as "Patterns not validated - manual review required"
|
|
550
|
+
3. Reduce task count in prd.json (simpler breakdown)
|
|
551
|
+
|
|
552
|
+
**If .ralph/ directory already exists:**
|
|
553
|
+
1. Warn user: "Existing Ralph Loop data found"
|
|
554
|
+
2. Ask: "Overwrite / Append / Cancel"
|
|
555
|
+
3. If append: add new tasks after existing ones
|
|
556
|
+
|
|
557
|
+
## NEXT STEP:
|
|
335
558
|
|
|
336
|
-
|
|
559
|
+
After completion, proceed to `steps/step-06-doc-html.md`
|
|
@@ -1,15 +1,13 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: step-06-doc-html
|
|
3
3
|
description: Documentation phase - Generate React documentation page
|
|
4
|
-
model: sonnet
|
|
5
|
-
prev_step: steps/step-05-handoff.md
|
|
6
4
|
next_step: null
|
|
7
5
|
---
|
|
8
6
|
|
|
9
|
-
|
|
7
|
+
## YOUR TASK:
|
|
8
|
+
|
|
10
9
|
Generate React documentation page integrated into SmartStack web app.
|
|
11
10
|
Create i18n translations in 4 languages (FR, EN, IT, DE).
|
|
12
|
-
</objective>
|
|
13
11
|
|
|
14
12
|
<context7>
|
|
15
13
|
CONTEXT7 REQUIRED for React generation:
|
|
@@ -26,7 +24,7 @@ Libraries to reference:
|
|
|
26
24
|
- /lucide-icons/lucide-react - Icons
|
|
27
25
|
</context7>
|
|
28
26
|
|
|
29
|
-
## EXECUTION SEQUENCE
|
|
27
|
+
## EXECUTION SEQUENCE:
|
|
30
28
|
|
|
31
29
|
### 1. Read Current State
|
|
32
30
|
|
|
@@ -35,6 +33,10 @@ Read FRD: `{output_dir}/3-functional-specification.md`
|
|
|
35
33
|
|
|
36
34
|
Update progress: `06-doc-html` -> "In Progress"
|
|
37
35
|
|
|
36
|
+
**Read digest from previous step:**
|
|
37
|
+
Read `{output_dir}/digest-05.md` for compressed context from previous step.
|
|
38
|
+
**DO NOT read full output files** unless in resume mode (`-r`).
|
|
39
|
+
|
|
38
40
|
---
|
|
39
41
|
|
|
40
42
|
### 2. Load React Templates (Progressive)
|
|
@@ -223,39 +225,96 @@ Update `00-context.md`:
|
|
|
223
225
|
|
|
224
226
|
### 9. Display Final Summary
|
|
225
227
|
|
|
226
|
-
|
|
227
|
-
|
|
228
|
-
|
|
229
|
-
|
|
230
|
-
|
|
231
|
-
|
|
232
|
-
|
|
233
|
-
|
|
234
|
-
|
|
235
|
-
|
|
236
|
-
|
|
237
|
-
|
|
238
|
-
|
|
239
|
-
|
|
240
|
-
|
|
241
|
-
|
|
242
|
-
|
|
228
|
+
**Step Summary:**
|
|
229
|
+
|
|
230
|
+
| Field | Value |
|
|
231
|
+
|-------|-------|
|
|
232
|
+
| Step | DOCUMENTATION |
|
|
233
|
+
| Feature | {feature_id} |
|
|
234
|
+
| Status | Complete |
|
|
235
|
+
| React page | FrdDocPage.tsx |
|
|
236
|
+
| i18n | 4 languages created |
|
|
237
|
+
| Route | /docs/business/{app}/{module} |
|
|
238
|
+
| Status | BA WORKFLOW COMPLETE |
|
|
239
|
+
|
|
240
|
+
**Artifacts Summary:**
|
|
241
|
+
|
|
242
|
+
| Document | Location | Status |
|
|
243
|
+
|----------|----------|--------|
|
|
244
|
+
| Discovery | {output_dir}/1-discovery.md | Complete |
|
|
245
|
+
| BRD | {output_dir}/2-business-requirements.md | Complete |
|
|
246
|
+
| FRD | {output_dir}/3-functional-specification.md | Complete |
|
|
247
|
+
| Validation | {output_dir}/validation.json | APPROVED |
|
|
248
|
+
| Handoff | {output_dir}/4-development-handoff.md | Complete |
|
|
249
|
+
| Documentation | web/.../FrdDocPage.tsx | Complete |
|
|
250
|
+
|
|
251
|
+
**Next steps:**
|
|
243
252
|
1. Review generated documentation at /docs/business/{app}/{module}
|
|
244
|
-
2. Execute /
|
|
253
|
+
2. Execute /ralph-loop -r (iterative) or /feature-full (one-shot) to start development
|
|
245
254
|
3. Run tests after implementation
|
|
246
255
|
|
|
247
256
|
Thank you for using Business Analysis skill!
|
|
248
257
|
Contact: support@atlshub.ch
|
|
249
|
-
```
|
|
250
258
|
|
|
251
259
|
---
|
|
252
260
|
|
|
253
|
-
|
|
261
|
+
### 10. Update Documentation Manifest
|
|
262
|
+
|
|
263
|
+
**Update `docs-manifest.json` at project root:**
|
|
264
|
+
|
|
265
|
+
1. Read existing `docs-manifest.json` (create if absent with `version: "1.0"`)
|
|
266
|
+
2. Add or update the module entry:
|
|
267
|
+
```json
|
|
268
|
+
{
|
|
269
|
+
"business/{application_name}/{module_name}": {
|
|
270
|
+
"featureId": "{feature_id}",
|
|
271
|
+
"displayName": "{module_name}",
|
|
272
|
+
"codeFiles": [/* from handoff section 3 */],
|
|
273
|
+
"docFiles": [
|
|
274
|
+
"web/.../pages/docs/business/{app}/{module}/frd-data.ts",
|
|
275
|
+
"web/.../i18n/locales/fr/docs-{app}-{module}.json"
|
|
276
|
+
],
|
|
277
|
+
"baOutputs": ["{output_dir}"],
|
|
278
|
+
"screenshots": {/* from frd-data screenshots field */},
|
|
279
|
+
"lastCodeChange": "{current_timestamp}",
|
|
280
|
+
"lastDocUpdate": "{current_timestamp}",
|
|
281
|
+
"gitCommitCode": "",
|
|
282
|
+
"gitCommitDoc": "",
|
|
283
|
+
"status": "synced"
|
|
284
|
+
}
|
|
285
|
+
}
|
|
286
|
+
```
|
|
287
|
+
3. Update `lastUpdated` at manifest root level
|
|
288
|
+
4. Write updated manifest
|
|
289
|
+
|
|
290
|
+
> **Schema reference:** See `_resources/docs-manifest-schema.md` for full schema documentation.
|
|
291
|
+
|
|
292
|
+
---
|
|
293
|
+
|
|
294
|
+
## OUTPUT FORMAT:
|
|
254
295
|
|
|
255
296
|
This step produces:
|
|
256
297
|
- React documentation page
|
|
257
298
|
- 4 i18n translation files
|
|
258
299
|
- Updated routing
|
|
300
|
+
- Updated documentation manifest
|
|
259
301
|
- Final BA summary
|
|
260
302
|
|
|
261
303
|
**BA Workflow Complete.**
|
|
304
|
+
|
|
305
|
+
## ERROR HANDLING:
|
|
306
|
+
|
|
307
|
+
**If React component generation fails:**
|
|
308
|
+
1. Save FRD data structure to `{output_dir}/frd-data-draft.json`
|
|
309
|
+
2. Skip React page generation
|
|
310
|
+
3. Mark step as "Partial - data extracted, page generation failed"
|
|
311
|
+
4. Suggest: "Run `/documentation {module}` manually to retry"
|
|
312
|
+
|
|
313
|
+
**If i18n translation fails for non-FR language:**
|
|
314
|
+
1. Generate FR (source language) first
|
|
315
|
+
2. Mark other languages as "[TODO - translation pending]"
|
|
316
|
+
3. Log: "EN/IT/DE translations deferred to translation pipeline"
|
|
317
|
+
|
|
318
|
+
## NEXT STEP:
|
|
319
|
+
|
|
320
|
+
After completion, the Business Analysis workflow is finalized. Implementation proceeds via `/ralph-loop -r` or `/feature-full`.
|
|
@@ -11,13 +11,21 @@
|
|
|
11
11
|
> **Module:** business/{application}/{module}
|
|
12
12
|
> **Version:** 1.0
|
|
13
13
|
> **Validated Specs:** FRD v1.0 (validation.json)
|
|
14
|
-
> **Implementation:** `/
|
|
14
|
+
> **Implementation:** `/ralph-loop -r` (iterative) | `/feature-full business/{app}/{module}` (one-shot)
|
|
15
15
|
|
|
16
16
|
## DEVELOPER INSTRUCTIONS
|
|
17
17
|
|
|
18
|
-
This document is a self-contained prompt for Claude Code.
|
|
18
|
+
This document is a self-contained prompt for Claude Code.
|
|
19
|
+
|
|
20
|
+
**Option 1 - Iterative (recommended):**
|
|
21
|
+
```
|
|
22
|
+
/ralph-loop -r
|
|
23
|
+
```
|
|
24
|
+
> Pre-generated `.ralph/prd.json` with atomic task breakdown.
|
|
25
|
+
|
|
26
|
+
**Option 2 - One-shot:**
|
|
19
27
|
```
|
|
20
|
-
/
|
|
28
|
+
/feature-full business/{app}/{module}
|
|
21
29
|
```
|
|
22
30
|
|
|
23
31
|
---
|
|
@@ -112,7 +120,13 @@ FRONTEND:
|
|
|
112
120
|
|
|
113
121
|
## EXECUTION
|
|
114
122
|
|
|
123
|
+
**Iterative (recommended):**
|
|
124
|
+
```bash
|
|
125
|
+
/ralph-loop -r
|
|
126
|
+
```
|
|
127
|
+
|
|
128
|
+
**One-shot:**
|
|
115
129
|
```bash
|
|
116
|
-
/
|
|
130
|
+
/feature-full business/{app}/{module}
|
|
117
131
|
```
|
|
118
132
|
```
|
|
@@ -353,13 +353,21 @@ Feature: {FEAT-XXX} {Feature Name}
|
|
|
353
353
|
> **Module:** business/{application}/{module}
|
|
354
354
|
> **Version:** 1.0
|
|
355
355
|
> **Validated Specs:** FRD v1.0 (validation.json)
|
|
356
|
-
> **Implementation:** `/
|
|
356
|
+
> **Implementation:** `/ralph-loop -r` (iterative) | `/feature-full business/{app}/{module}` (one-shot)
|
|
357
357
|
|
|
358
358
|
## DEVELOPER INSTRUCTIONS
|
|
359
359
|
|
|
360
|
-
This document is a self-contained prompt for Claude Code.
|
|
360
|
+
This document is a self-contained prompt for Claude Code.
|
|
361
|
+
|
|
362
|
+
**Option 1 - Iterative (recommended):**
|
|
363
|
+
```
|
|
364
|
+
/ralph-loop -r
|
|
365
|
+
```
|
|
366
|
+
> Pre-generated `.ralph/prd.json` with atomic task breakdown.
|
|
367
|
+
|
|
368
|
+
**Option 2 - One-shot:**
|
|
361
369
|
```
|
|
362
|
-
/
|
|
370
|
+
/feature-full business/{app}/{module}
|
|
363
371
|
```
|
|
364
372
|
|
|
365
373
|
---
|
|
@@ -454,11 +462,17 @@ FRONTEND:
|
|
|
454
462
|
|
|
455
463
|
## EXECUTION
|
|
456
464
|
|
|
465
|
+
**Iterative (recommended):**
|
|
466
|
+
```bash
|
|
467
|
+
/ralph-loop -r
|
|
468
|
+
```
|
|
469
|
+
|
|
470
|
+
**One-shot:**
|
|
457
471
|
```bash
|
|
458
|
-
/
|
|
472
|
+
/feature-full business/{app}/{module}
|
|
459
473
|
```
|
|
460
474
|
|
|
461
|
-
Options:
|
|
475
|
+
Options (one-shot only):
|
|
462
476
|
- `--phase=1` : Backend only
|
|
463
477
|
- `--phase=2` : Frontend only
|
|
464
478
|
- `--phase=3` : Tests only
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# Change Tracking Template
|
|
2
|
+
|
|
3
|
+
## CHANGE-NNN: {description}
|
|
4
|
+
|
|
5
|
+
**Feature:** {feature_id}
|
|
6
|
+
**Date:** {timestamp}
|
|
7
|
+
**Type:** requirement-change | scope-change | bug-fix | enhancement
|
|
8
|
+
**Impact:** {modules affected}
|
|
9
|
+
**Doc sync required:** Yes | No
|
|
10
|
+
|
|
11
|
+
## Changes
|
|
12
|
+
|
|
13
|
+
- {what changed and why}
|
|
14
|
+
|
|
15
|
+
## Documentation Impact
|
|
16
|
+
|
|
17
|
+
| Section | Impact | Action Required |
|
|
18
|
+
|---------|--------|-----------------|
|
|
19
|
+
| Business Rules | Modified BR-XXX | Update frd-data.ts |
|
|
20
|
+
| Permissions | New permission added | Update frd-data.ts + PermissionConfiguration.cs |
|
|
21
|
+
| API Endpoints | New endpoint | Update frd-data.ts |
|
|
22
|
+
| Use Cases | Modified UC-XXX | Update frd-data.ts + i18n FR |
|
|
23
|
+
|
|
24
|
+
## Validation
|
|
25
|
+
|
|
26
|
+
- [ ] Code changes implemented
|
|
27
|
+
- [ ] Documentation updated (frd-data.ts)
|
|
28
|
+
- [ ] i18n FR updated
|
|
29
|
+
- [ ] docs-manifest.json updated
|
|
30
|
+
- [ ] Tests passing
|