speccrew 0.1.1 → 0.1.3

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.
Files changed (51) hide show
  1. package/README.ar.md +98 -91
  2. package/README.bn.md +122 -0
  3. package/README.bs.md +321 -0
  4. package/README.da.md +321 -0
  5. package/README.de.md +321 -0
  6. package/README.el.md +122 -0
  7. package/README.en.md +92 -85
  8. package/README.es.md +96 -89
  9. package/README.fr.md +321 -0
  10. package/README.it.md +321 -0
  11. package/README.ja.md +321 -0
  12. package/README.ko.md +321 -0
  13. package/README.md +92 -109
  14. package/README.no.md +321 -0
  15. package/README.pl.md +321 -0
  16. package/README.pt-BR.md +321 -0
  17. package/README.ru.md +321 -0
  18. package/README.th.md +239 -0
  19. package/README.tr.md +239 -0
  20. package/README.uk.md +239 -0
  21. package/README.vi.md +122 -0
  22. package/README.zh-TW.md +321 -0
  23. package/bin/cli.js +5 -1
  24. package/docs/GETTING-STARTED.ar.md +452 -0
  25. package/docs/GETTING-STARTED.bn.md +449 -0
  26. package/docs/GETTING-STARTED.bs.md +449 -0
  27. package/docs/GETTING-STARTED.da.md +448 -0
  28. package/docs/GETTING-STARTED.de.md +448 -0
  29. package/docs/GETTING-STARTED.el.md +449 -0
  30. package/docs/GETTING-STARTED.en.md +448 -0
  31. package/docs/GETTING-STARTED.es.md +448 -0
  32. package/docs/GETTING-STARTED.fr.md +448 -0
  33. package/docs/GETTING-STARTED.it.md +448 -0
  34. package/docs/GETTING-STARTED.ja.md +448 -0
  35. package/docs/GETTING-STARTED.ko.md +448 -0
  36. package/docs/GETTING-STARTED.md +448 -0
  37. package/docs/GETTING-STARTED.no.md +449 -0
  38. package/docs/GETTING-STARTED.pl.md +449 -0
  39. package/docs/GETTING-STARTED.pt-BR.md +449 -0
  40. package/docs/GETTING-STARTED.ru.md +449 -0
  41. package/docs/GETTING-STARTED.th.md +449 -0
  42. package/docs/GETTING-STARTED.tr.md +449 -0
  43. package/docs/GETTING-STARTED.uk.md +449 -0
  44. package/docs/GETTING-STARTED.vi.md +449 -0
  45. package/docs/GETTING-STARTED.zh-TW.md +448 -0
  46. package/lib/commands/init.js +238 -41
  47. package/lib/commands/uninstall.js +150 -32
  48. package/lib/commands/update.js +159 -24
  49. package/lib/ide-adapters.js +257 -3
  50. package/lib/utils.js +23 -7
  51. package/package.json +5 -2
@@ -0,0 +1,448 @@
1
+ # Guida Introduttiva SpecCrew
2
+
3
+ <p align="center">
4
+ <a href="./GETTING-STARTED.md">简体中文</a> |
5
+ <a href="./GETTING-STARTED.zh-TW.md">繁體中文</a> |
6
+ <a href="./GETTING-STARTED.en.md">English</a> |
7
+ <a href="./GETTING-STARTED.ko.md">한국어</a> |
8
+ <a href="./GETTING-STARTED.de.md">Deutsch</a> |
9
+ <a href="./GETTING-STARTED.es.md">Español</a> |
10
+ <a href="./GETTING-STARTED.fr.md">Français</a> |
11
+ <a href="./GETTING-STARTED.it.md">Italiano</a> |
12
+ <a href="./GETTING-STARTED.da.md">Dansk</a> |
13
+ <a href="./GETTING-STARTED.ja.md">日本語</a> |
14
+ <a href="./GETTING-STARTED.ar.md">العربية</a>
15
+ </p>
16
+
17
+ Questo documento ti aiuta a comprendere rapidamente come utilizzare il team Agent di SpecCrew per completare l'intero ciclo di sviluppo dai requisiti alla consegna seguendo i processi di ingegneria standard.
18
+
19
+ ---
20
+
21
+ ## 1. Preparazione
22
+
23
+ ### Installare SpecCrew
24
+
25
+ ```bash
26
+ npm install -g speccrew
27
+ ```
28
+
29
+ ### Inizializzare il Progetto
30
+
31
+ ```bash
32
+ speccrew init --ide qoder
33
+ ```
34
+
35
+ IDE supportati: `qoder`, `cursor`, `claude`, `codex`
36
+
37
+ ### Struttura Directory Dopo l'Inizializzazione
38
+
39
+ ```
40
+ .
41
+ ├── .qoder/
42
+ │ ├── agents/ # File di definizione Agent
43
+ │ └── skills/ # File di definizione Skill
44
+ ├── speccrew-workspace/ # Workspace
45
+ │ ├── docs/ # Configurazioni, regole, template, soluzioni
46
+ │ ├── iterations/ # Iterazioni in corso
47
+ │ ├── iteration-archives/ # Iterazioni archiviate
48
+ │ └── knowledges/ # Base di conoscenza
49
+ │ ├── base/ # Informazioni base (rapporti diagnostica, debito tecnico)
50
+ │ ├── bizs/ # Base conoscenza business
51
+ │ └── techs/ # Base conoscenza tecnica
52
+ ```
53
+
54
+ ### Riferimento Rapido Comandi CLI
55
+
56
+ | Comando | Descrizione |
57
+ |---------|-------------|
58
+ | `speccrew list` | Elenca tutti gli Agent e Skill disponibili |
59
+ | `speccrew doctor` | Verifica l'integrità dell'installazione |
60
+ | `speccrew update` | Aggiorna la configurazione del progetto all'ultima versione |
61
+ | `speccrew uninstall` | Disinstalla SpecCrew |
62
+
63
+ ---
64
+
65
+ ## 2. Panoramica Workflow
66
+
67
+ ### Diagramma di Flusso Completo
68
+
69
+ ```mermaid
70
+ flowchart LR
71
+ PRD[Fase 1<br/>Analisi Requisiti<br/>Product Manager] --> FD[Fase 2<br/>Feature Design<br/>Feature Designer]
72
+ FD --> SD[Fase 3<br/>System Design<br/>System Designer]
73
+ SD --> DEV[Fase 4<br/>Sviluppo<br/>System Developer]
74
+ DEV --> TEST[Fase 5<br/>Test Sistema<br/>Test Manager]
75
+ TEST --> ARCHIVE[Fase 6<br/>Archiviazione]
76
+
77
+ KB[(Base Conoscenza<br/>Throughout)] -.-> PRD
78
+ KB -.-> FD
79
+ KB -.-> SD
80
+ KB -.-> DEV
81
+ KB -.-> TEST
82
+ ```
83
+
84
+ ### Principi Fondamentali
85
+
86
+ 1. **Dipendenze di Fase**: I deliverable di ogni fase sono l'input per la fase successiva
87
+ 2. **Conferma Checkpoint**: Ogni fase ha un punto di conferma che richiede l'approvazione dell'utente prima di procedere alla fase successiva
88
+ 3. **Guidato da Base Conoscenza**: La base di conoscenza percorre l'intero processo, fornendo contesto per tutte le fasi
89
+
90
+ ---
91
+
92
+ ## 3. Fase Zero: Diagnostica Progetto e Inizializzazione Base Conoscenza
93
+
94
+ Prima di iniziare il processo di ingegneria formale, devi inizializzare la base di conoscenza del progetto.
95
+
96
+ ### 3.1 Diagnostica Progetto
97
+
98
+ **Esempio Conversazione**:
99
+ ```
100
+ @speccrew-team-leader diagnosticare il progetto
101
+ ```
102
+
103
+ **Cosa farà l'Agent**:
104
+ - Scansionare la struttura del progetto
105
+ - Rilevare lo stack tecnologico
106
+ - Identificare i moduli business
107
+
108
+ **Deliverable**:
109
+ ```
110
+ speccrew-workspace/knowledges/base/diagnosis-reports/diagnosis-report-{date}.md
111
+ ```
112
+
113
+ ### 3.2 Inizializzazione Base Conoscenza Tecnica
114
+
115
+ **Esempio Conversazione**:
116
+ ```
117
+ @speccrew-team-leader inizializzare la base conoscenza tecnica
118
+ ```
119
+
120
+ **Processo in Tre Fasi**:
121
+ 1. Rilevamento Piattaforma — Identificare le piattaforme tecnologiche nel progetto
122
+ 2. Generazione Documentazione Tecnica — Generare documenti di specifica tecnica per ogni piattaforma
123
+ 3. Generazione Indice — Stabilire l'indice della base di conoscenza
124
+
125
+ **Deliverable**:
126
+ ```
127
+ speccrew-workspace/knowledges/techs/{platform-id}/
128
+ ├── tech-stack.md # Definizione stack tecnologico
129
+ ├── architecture.md # Convenzioni architetturali
130
+ ├── dev-spec.md # Specifiche di sviluppo
131
+ ├── test-spec.md # Specifiche di test
132
+ └── INDEX.md # File indice
133
+ ```
134
+
135
+ ### 3.3 Inizializzazione Base Conoscenza Business
136
+
137
+ **Esempio Conversazione**:
138
+ ```
139
+ @speccrew-team-leader inizializzare la base conoscenza business
140
+ ```
141
+
142
+ **Processo in Quattro Fasi**:
143
+ 1. Inventario Funzionalità — Scansionare il codice per identificare tutte le funzionalità
144
+ 2. Analisi Funzionalità — Analizzare la logica business per ogni funzionalità
145
+ 3. Riepilogo Moduli — Riassumere le funzionalità per modulo
146
+ 4. Riepilogo Sistema — Generare una panoramica business a livello di sistema
147
+
148
+ **Deliverable**:
149
+ ```
150
+ speccrew-workspace/knowledges/bizs/
151
+ ├── {platform-type}/
152
+ │ └── {module-name}/
153
+ │ └── feature-spec.md
154
+ └── system-overview.md
155
+ ```
156
+
157
+ ---
158
+
159
+ ## 4. Guida Conversazione Fase per Fase
160
+
161
+ ### 4.1 Fase 1: Analisi Requisiti (Product Manager)
162
+
163
+ **Come Iniziare**:
164
+ ```
165
+ @speccrew-product-manager Ho un nuovo requisito: [descrivi il tuo requisito]
166
+ ```
167
+
168
+ **Workflow Agent**:
169
+ 1. Leggere la panoramica del sistema per comprendere i moduli esistenti
170
+ 2. Analizzare i requisiti utente
171
+ 3. Generare documento PRD strutturato
172
+
173
+ **Deliverable**:
174
+ ```
175
+ iterations/{numero}-{tipo}-{nome}/01.product-requirement/
176
+ ├── [feature-name]-prd.md # Documento Requisiti Prodotto
177
+ └── [feature-name]-bizs-modeling.md # Modellazione business (per requisiti complessi)
178
+ ```
179
+
180
+ **Checklist di Conferma**:
181
+ - [ ] La descrizione del requisito riflette accuratamente l'intento dell'utente?
182
+ - [ ] Le regole business sono complete?
183
+ - [ ] I punti di integrazione con i sistemi esistenti sono chiari?
184
+ - [ ] I criteri di accettazione sono misurabili?
185
+
186
+ ---
187
+
188
+ ### 4.2 Fase 2: Feature Design (Feature Designer)
189
+
190
+ **Come Iniziare**:
191
+ ```
192
+ @speccrew-feature-designer iniziare il feature design
193
+ ```
194
+
195
+ **Workflow Agent**:
196
+ 1. Localizzare automaticamente il documento PRD confermato
197
+ 2. Caricare la base conoscenza business
198
+ 3. Generare feature design (inclusi wireframe UI, flussi di interazione, definizioni dati, contratti API)
199
+ 4. Per PRD multipli, usare Task Worker per design parallelo
200
+
201
+ **Deliverable**:
202
+ ```
203
+ iterations/{iter}/02.feature-design/
204
+ └── [feature-name]-feature-spec.md # Documento feature design
205
+ ```
206
+
207
+ **Checklist di Conferma**:
208
+ - [ ] Tutti gli scenari utente sono coperti?
209
+ - [ ] I flussi di interazione sono chiari?
210
+ - [ ] Le definizioni dei campi dati sono complete?
211
+ - [ ] La gestione delle eccezioni è completa?
212
+
213
+ ---
214
+
215
+ ### 4.3 Fase 3: System Design (System Designer)
216
+
217
+ **Come Iniziare**:
218
+ ```
219
+ @speccrew-system-designer iniziare il system design
220
+ ```
221
+
222
+ **Workflow Agent**:
223
+ 1. Localizzare Feature Spec e Contratto API
224
+ 2. Caricare la base conoscenza tecnica (stack tech, architettura, specifiche per ogni piattaforma)
225
+ 3. **Checkpoint A**: Valutazione Framework — Analizzare i gap tecnici, raccomandare nuovi framework (se necessario), attendere conferma utente
226
+ 4. Generare DESIGN-OVERVIEW.md
227
+ 5. Usare Task Worker per distribuire il design per ogni piattaforma in parallelo (frontend/backend/mobile/desktop)
228
+ 6. **Checkpoint B**: Conferma Congiunta — Mostrare il riepilogo di tutti i design delle piattaforme, attendere conferma utente
229
+
230
+ **Deliverable**:
231
+ ```
232
+ iterations/{iter}/03.system-design/
233
+ ├── DESIGN-OVERVIEW.md # Panoramica design
234
+ ├── {platform-id}/
235
+ │ ├── INDEX.md # Indice design piattaforma
236
+ │ └── {module}-design.md # Design modulo a livello pseudocodice
237
+ ```
238
+
239
+ **Checklist di Conferma**:
240
+ - [ ] Il pseudocodice usa la sintassi del framework effettivo?
241
+ - [ ] I contratti API multipiattaforma sono coerenti?
242
+ - [ ] La strategia di gestione errori è unificata?
243
+
244
+ ---
245
+
246
+ ### 4.4 Fase 4: Implementazione Sviluppo (System Developer)
247
+
248
+ **Come Iniziare**:
249
+ ```
250
+ @speccrew-system-developer iniziare lo sviluppo
251
+ ```
252
+
253
+ **Workflow Agent**:
254
+ 1. Leggere i documenti di system design
255
+ 2. Caricare le conoscenze tecniche per ogni piattaforma
256
+ 3. **Checkpoint A**: Pre-controllo Ambiente — Verificare versioni runtime, dipendenze, disponibilità servizi; attendere risoluzione utente se fallito
257
+ 4. Usare Task Worker per distribuire lo sviluppo per ogni piattaforma in parallelo
258
+ 5. Controllo integrazione: allineamento contratto API, coerenza dati
259
+ 6. Emettere rapporto di consegna
260
+
261
+ **Deliverable**:
262
+ ```
263
+ # Codice sorgente scritto nella directory sorgente effettiva del progetto
264
+ iterations/{iter}/04.development/
265
+ ├── {platform-id}/
266
+ │ └── tasks/ # Registrazioni attività di sviluppo
267
+ └── delivery-report.md
268
+ ```
269
+
270
+ **Checklist di Conferma**:
271
+ - [ ] L'ambiente è pronto?
272
+ - [ ] I problemi di integrazione sono entro un range accettabile?
273
+ - [ ] Il codice è conforme alle specifiche di sviluppo?
274
+
275
+ ---
276
+
277
+ ### 4.5 Fase 5: Test Sistema (Test Manager)
278
+
279
+ **Come Iniziare**:
280
+ ```
281
+ @speccrew-test-manager iniziare i test
282
+ ```
283
+
284
+ **Processo di Test in Tre Fasi**:
285
+
286
+ | Fase | Descrizione | Checkpoint |
287
+ |------|-------------|------------|
288
+ | Design Casi di Test | Generare casi di test basati su PRD e Feature Spec | A: Mostrare statistiche di copertura casi e matrice di tracciabilità, attendere conferma utente di copertura sufficiente |
289
+ | Generazione Codice Test | Generare codice di test eseguibile | B: Mostrare file di test generati e mappatura casi, attendere conferma utente |
290
+ | Esecuzione Test e Reporting Bug | Eseguire automaticamente i test e generare rapporti | Nessuno (esecuzione automatica) |
291
+
292
+ **Deliverable**:
293
+ ```
294
+ iterations/{iter}/05.system-test/
295
+ ├── cases/
296
+ │ └── {platform-id}/ # Documenti casi di test
297
+ ├── code/
298
+ │ └── {platform-id}/ # Piano codice test
299
+ ├── reports/
300
+ │ └── test-report-{date}.md # Rapporto test
301
+ └── bugs/
302
+ └── BUG-{id}-{title}.md # Rapporti bug (un file per bug)
303
+ ```
304
+
305
+ **Checklist di Conferma**:
306
+ - [ ] La copertura dei casi è completa?
307
+ - [ ] Il codice di test è eseguibile?
308
+ - [ ] La valutazione della gravità dei bug è accurata?
309
+
310
+ ---
311
+
312
+ ### 4.6 Fase 6: Archiviazione
313
+
314
+ Le iterazioni vengono automaticamente archiviate al completamento:
315
+
316
+ ```
317
+ speccrew-workspace/iteration-archives/
318
+ └── {numero}-{tipo}-{nome}-{date}/
319
+ ├── 01.product-requirement/
320
+ ├── 02.feature-design/
321
+ ├── 03.system-design/
322
+ ├── 04.development/
323
+ └── 05.system-test/
324
+ ```
325
+
326
+ ---
327
+
328
+ ## 5. Panoramica Base Conoscenza
329
+
330
+ ### 5.1 Base Conoscenza Business (bizs)
331
+
332
+ **Scopo**: Memorizzare descrizioni funzionali business del progetto, divisioni moduli, caratteristiche API
333
+
334
+ **Struttura Directory**:
335
+ ```
336
+ knowledges/bizs/
337
+ ├── {platform-type}/
338
+ │ └── {module-name}/
339
+ │ └── feature-spec.md
340
+ └── system-overview.md
341
+ ```
342
+
343
+ **Scenari d'Uso**: Product Manager, Feature Designer
344
+
345
+ ### 5.2 Base Conoscenza Tecnica (techs)
346
+
347
+ **Scopo**: Memorizzare stack tecnologico del progetto, convenzioni architetturali, specifiche di sviluppo, specifiche di test
348
+
349
+ **Struttura Directory**:
350
+ ```
351
+ knowledges/techs/{platform-id}/
352
+ ├── tech-stack.md
353
+ ├── architecture.md
354
+ ├── dev-spec.md
355
+ ├── test-spec.md
356
+ └── INDEX.md
357
+ ```
358
+
359
+ **Scenari d'Uso**: System Designer, System Developer, Test Manager
360
+
361
+ ---
362
+
363
+ ## 6. Domande Frequenti (FAQ)
364
+
365
+ ### Q1: Cosa fare se l'Agent non funziona come previsto?
366
+
367
+ 1. Eseguire `speccrew doctor` per verificare l'integrità dell'installazione
368
+ 2. Confermare che la base di conoscenza è stata inizializzata
369
+ 3. Confermare che i deliverable della fase precedente esistono nella directory di iterazione corrente
370
+
371
+ ### Q2: Come saltare una fase?
372
+
373
+ **Non raccomandato** — L'output di ogni fase è l'input per la fase successiva.
374
+
375
+ Se devi assolutamente saltare, prepara manualmente il documento di input della fase corrispondente e assicurati che rispetti le specifiche di formato.
376
+
377
+ ### Q3: Come gestire requisiti paralleli multipli?
378
+
379
+ Creare directory di iterazione indipendenti per ogni requisito:
380
+ ```
381
+ iterations/
382
+ ├── 001-feature-xxx/
383
+ ├── 002-feature-yyy/
384
+ └── 003-feature-zzz/
385
+ ```
386
+
387
+ Ogni iterazione è completamente isolata e non influenza le altre.
388
+
389
+ ### Q4: Come aggiornare la versione di SpecCrew?
390
+
391
+ - **Aggiornamento Globale**: `npm update -g speccrew`
392
+ - **Aggiornamento Progetto**: Eseguire `speccrew update` nella directory del progetto
393
+
394
+ ### Q5: Come visualizzare le iterazioni storiche?
395
+
396
+ Dopo l'archiviazione, visualizzare in `speccrew-workspace/iteration-archives/`, organizzate per formato `{numero}-{tipo}-{nome}-{date}/`.
397
+
398
+ ### Q6: La base di conoscenza necessita di aggiornamenti regolari?
399
+
400
+ La re-inizializzazione è necessaria nelle seguenti situazioni:
401
+ - Cambiamenti importanti nella struttura del progetto
402
+ - Aggiornamento o sostituzione dello stack tecnologico
403
+ - Aggiunta/rimozione di moduli business
404
+
405
+ ---
406
+
407
+ ## 7. Riferimento Rapido
408
+
409
+ ### Riferimento Rapido Avvio Agent
410
+
411
+ | Fase | Agent | Conversazione di Avvio |
412
+ |------|-------|------------------------|
413
+ | Diagnostica | Team Leader | `@speccrew-team-leader diagnosticare il progetto` |
414
+ | Inizializzazione | Team Leader | `@speccrew-team-leader inizializzare la base conoscenza tecnica` |
415
+ | Analisi Requisiti | Product Manager | `@speccrew-product-manager Ho un nuovo requisito: [descrizione]` |
416
+ | Feature Design | Feature Designer | `@speccrew-feature-designer iniziare il feature design` |
417
+ | System Design | System Designer | `@speccrew-system-designer iniziare il system design` |
418
+ | Sviluppo | System Developer | `@speccrew-system-developer iniziare lo sviluppo` |
419
+ | Test Sistema | Test Manager | `@speccrew-test-manager iniziare i test` |
420
+
421
+ ### Checklist Checkpoint
422
+
423
+ | Fase | Numero Checkpoint | Elementi di Controllo Chiave |
424
+ |------|-------------------|------------------------------|
425
+ | Analisi Requisiti | 1 | Accuratezza requisiti, completezza regole business, misurabilità criteri di accettazione |
426
+ | Feature Design | 1 | Copertura scenari, chiarezza interazioni, completezza dati, gestione eccezioni |
427
+ | System Design | 2 | A: Valutazione framework; B: Sintassi pseudocodice, coerenza multipiattaforma, gestione errori |
428
+ | Sviluppo | 1 | A: Prontezza ambiente, problemi integrazione, specifiche codice |
429
+ | Test Sistema | 2 | A: Copertura casi; B: Eseguibilità codice test |
430
+
431
+ ### Riferimento Rapido Percorsi Deliverable
432
+
433
+ | Fase | Directory Output | Formato File |
434
+ |------|------------------|--------------|
435
+ | Analisi Requisiti | `iterations/{iter}/01.product-requirement/` | `[name]-prd.md`, `[name]-bizs-modeling.md` |
436
+ | Feature Design | `iterations/{iter}/02.feature-design/` | `[name]-feature-spec.md` |
437
+ | System Design | `iterations/{iter}/03.system-design/` | `DESIGN-OVERVIEW.md`, `{platform}/INDEX.md`, `{platform}/{module}-design.md` |
438
+ | Sviluppo | `iterations/{iter}/04.development/` | Codice sorgente + `delivery-report.md` |
439
+ | Test Sistema | `iterations/{iter}/05.system-test/` | `cases/`, `code/`, `reports/`, `bugs/` |
440
+ | Archiviazione | `iteration-archives/{iter}-{date}/` | Copia iterazione completa |
441
+
442
+ ---
443
+
444
+ ## Prossimi Passi
445
+
446
+ 1. Eseguire `speccrew init --ide qoder` per inizializzare il tuo progetto
447
+ 2. Eseguire la Fase Zero: Diagnostica Progetto e Inizializzazione Base Conoscenza
448
+ 3. Procedere attraverso ogni fase seguendo il workflow, godendoti l'esperienza di sviluppo specification-driven!