speccrew 0.1.1 → 0.1.2

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 (52) 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/bin/postinstall.js +157 -0
  25. package/docs/GETTING-STARTED.ar.md +452 -0
  26. package/docs/GETTING-STARTED.bn.md +449 -0
  27. package/docs/GETTING-STARTED.bs.md +449 -0
  28. package/docs/GETTING-STARTED.da.md +448 -0
  29. package/docs/GETTING-STARTED.de.md +448 -0
  30. package/docs/GETTING-STARTED.el.md +449 -0
  31. package/docs/GETTING-STARTED.en.md +448 -0
  32. package/docs/GETTING-STARTED.es.md +448 -0
  33. package/docs/GETTING-STARTED.fr.md +448 -0
  34. package/docs/GETTING-STARTED.it.md +448 -0
  35. package/docs/GETTING-STARTED.ja.md +448 -0
  36. package/docs/GETTING-STARTED.ko.md +448 -0
  37. package/docs/GETTING-STARTED.md +448 -0
  38. package/docs/GETTING-STARTED.no.md +449 -0
  39. package/docs/GETTING-STARTED.pl.md +449 -0
  40. package/docs/GETTING-STARTED.pt-BR.md +449 -0
  41. package/docs/GETTING-STARTED.ru.md +449 -0
  42. package/docs/GETTING-STARTED.th.md +449 -0
  43. package/docs/GETTING-STARTED.tr.md +449 -0
  44. package/docs/GETTING-STARTED.uk.md +449 -0
  45. package/docs/GETTING-STARTED.vi.md +449 -0
  46. package/docs/GETTING-STARTED.zh-TW.md +448 -0
  47. package/lib/commands/init.js +238 -41
  48. package/lib/commands/uninstall.js +150 -32
  49. package/lib/commands/update.js +159 -24
  50. package/lib/ide-adapters.js +257 -3
  51. package/lib/utils.js +23 -7
  52. package/package.json +7 -2
@@ -0,0 +1,449 @@
1
+ # SpecCrew - Rask Startguide
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
+ <a href="./GETTING-STARTED.no.md">Norsk</a>
16
+ </p>
17
+
18
+ Dette dokumentet hjelper deg med raskt å forstå hvordan du bruker SpecCrew Agent-teamet for å fullføre hele utviklingssyklusen fra krav til levering, etter standard ingeniørprosesser.
19
+
20
+ ---
21
+
22
+ ## 1. Forutsetninger
23
+
24
+ ### Installer SpecCrew
25
+
26
+ ```bash
27
+ npm install -g speccrew
28
+ ```
29
+
30
+ ### Initialiser Prosjekt
31
+
32
+ ```bash
33
+ speccrew init --ide qoder
34
+ ```
35
+
36
+ Støttede IDE-er: `qoder`, `cursor`, `claude`, `codex`
37
+
38
+ ### Katalogstruktur Etter Initialisering
39
+
40
+ ```
41
+ .
42
+ ├── .qoder/
43
+ │ ├── agents/ # Agent-definisjonsfiler
44
+ │ └── skills/ # Skill-definisjonsfiler
45
+ ├── speccrew-workspace/ # Arbeidsområde
46
+ │ ├── docs/ # Konfigurasjoner, regler, maler, løsninger
47
+ │ ├── iterations/ # Gjeldende iterasjoner
48
+ │ ├── iteration-archives/ # Arkiverte iterasjoner
49
+ │ └── knowledges/ # Kunnskapsbase
50
+ │ ├── base/ # Grunnleggende informasjon (diagnoserapporter, teknisk gjeld)
51
+ │ ├── bizs/ # Forretningskunnskapsbase
52
+ │ └── techs/ # Teknisk kunnskapsbase
53
+ ```
54
+
55
+ ### CLI-kommando Hurtigreferanse
56
+
57
+ | Kommando | Beskrivelse |
58
+ |---------|-------------|
59
+ | `speccrew list` | List opp alle tilgjengelige Agenter og Skills |
60
+ | `speccrew doctor` | Sjekk installasjonsintegritet |
61
+ | `speccrew update` | Oppdater prosjektkonfigurasjon til nyeste versjon |
62
+ | `speccrew uninstall` | Avinstaller SpecCrew |
63
+
64
+ ---
65
+
66
+ ## 2. Arbeidsflytoversikt
67
+
68
+ ### Full Flytdiagram
69
+
70
+ ```mermaid
71
+ flowchart LR
72
+ PRD[Fase 1<br/>Kravanalyse<br/>Product Manager] --> FD[Fase 2<br/>Funksjonsdesign<br/>Feature Designer]
73
+ FD --> SD[Fase 3<br/>Systemdesign<br/>System Designer]
74
+ SD --> DEV[Fase 4<br/>Utvikling<br/>System Developer]
75
+ DEV --> TEST[Fase 5<br/>Systemtesting<br/>Test Manager]
76
+ TEST --> ARCHIVE[Fase 6<br/>Arkivering]
77
+
78
+ KB[(Kunnskapsbase<br/>Gjennom Hele Prosessen)] -.-> PRD
79
+ KB -.-> FD
80
+ KB -.-> SD
81
+ KB -.-> DEV
82
+ KB -.-> TEST
83
+ ```
84
+
85
+ ### Grunnleggende Prinsipper
86
+
87
+ 1. **Faseavhengigheter**: Hver fases output er input for neste fase
88
+ 2. **Kontrollpunkt-bekreftelse**: Hver fase har et bekreftelsespunkt som krever brukergodkjenning før du fortsetter
89
+ 3. **Kunnskapsbase-drevet**: Kunnskapsbasen strømmer gjennom hele prosessen, gir kontekst for alle faser
90
+
91
+ ---
92
+
93
+ ## 3. Null Steg: Prosjektdiagnose og Kunnskapsbase-initialisering
94
+
95
+ Før du starter den formelle ingeniørprosessen, må du initialisere prosjektets kunnskapsbase.
96
+
97
+ ### 3.1 Prosjektdiagnose
98
+
99
+ **Eksempel på Dialog**:
100
+ ```
101
+ @speccrew-team-leader diagnostiser prosjekt
102
+ ```
103
+
104
+ **Hva Agenten Vil Gjøre**:
105
+ - Skann prosjektstruktur
106
+ - Oppdag teknologistabel
107
+ - Identifiser forretningsmoduler
108
+
109
+ **Leveranse**:
110
+ ```
111
+ speccrew-workspace/knowledges/base/diagnosis-reports/diagnosis-report-{date}.md
112
+ ```
113
+
114
+ ### 3.2 Initialiser Teknisk Kunnskapsbase
115
+
116
+ **Eksempel på Dialog**:
117
+ ```
118
+ @speccrew-team-leader initialiser teknisk kunnskapsbase
119
+ ```
120
+
121
+ **Tre-fase Prosess**:
122
+ 1. Plattformoppdagelse — Identifiser teknologiplattformer i prosjektet
123
+ 2. Teknisk Dokumentasjonsgenerering — Generer tekniske spesifikasjonsdokumenter for hver plattform
124
+ 3. Indeksgenerering — Etabler kunnskapsbase-indeks
125
+
126
+ **Leveranse**:
127
+ ```
128
+ speccrew-workspace/knowledges/techs/{platform-id}/
129
+ ├── tech-stack.md # Teknologistabeldefinisjon
130
+ ├── architecture.md # Arkitekturkonvensjoner
131
+ ├── dev-spec.md # Utviklingsspesifikasjoner
132
+ ├── test-spec.md # Testspesifikasjoner
133
+ └── INDEX.md # Indeksfil
134
+ ```
135
+
136
+ ### 3.3 Initialiser Forretningskunnskapsbase
137
+
138
+ **Eksempel på Dialog**:
139
+ ```
140
+ @speccrew-team-leader initialiser forretningskunnskapsbase
141
+ ```
142
+
143
+ **Fire-fase Prosess**:
144
+ 1. Funksjonsinventar — Skann kode for å identifisere alle funksjoner
145
+ 2. Funksjonsanalyse — Analyser forretningslogikk for hver funksjon
146
+ 3. Modulsammendrag — Oppsummer funksjoner etter modul
147
+ 4. Systemsammendrag — Generer forretningsoversikt på systemnivå
148
+
149
+ **Leveranse**:
150
+ ```
151
+ speccrew-workspace/knowledges/bizs/
152
+ ├── {platform-type}/
153
+ │ └── {module-name}/
154
+ │ └── feature-spec.md
155
+ └── system-overview.md
156
+ ```
157
+
158
+ ---
159
+
160
+ ## 4. Fase-for-Fase Dialogguide
161
+
162
+ ### 4.1 Fase 1: Kravanalyse (Product Manager)
163
+
164
+ **Hvordan Starte**:
165
+ ```
166
+ @speccrew-product-manager jeg har et nytt krav: [beskriv kravet ditt]
167
+ ```
168
+
169
+ **Agent Arbeidsflyt**:
170
+ 1. Les systemoversikt for å forstå eksisterende moduler
171
+ 2. Analyser brukerkrav
172
+ 3. Generer strukturert PRD-dokument
173
+
174
+ **Leveranse**:
175
+ ```
176
+ iterations/{nummer}-{type}-{navn}/01.product-requirement/
177
+ ├── [feature-name]-prd.md # Produktkravdokument
178
+ └── [feature-name]-bizs-modeling.md # Forretningsmodellering (for komplekse krav)
179
+ ```
180
+
181
+ **Bekreftelseskontrollliste**:
182
+ - [ ] Reflekterer kravbeskrivelsen brukerens intensjon nøyaktig?
183
+ - [ ] Er forretningsregler komplette?
184
+ - [ ] Er integrasjonspunkter med eksisterende systemer klare?
185
+ - [ ] Er akseptkriterier målbare?
186
+
187
+ ---
188
+
189
+ ### 4.2 Fase 2: Funksjonsdesign (Feature Designer)
190
+
191
+ **Hvordan Starte**:
192
+ ```
193
+ @speccrew-feature-designer start funksjonsdesign
194
+ ```
195
+
196
+ **Agent Arbeidsflyt**:
197
+ 1. Finn automatisk bekreftet PRD-dokument
198
+ 2. Last inn forretningskunnskapsbase
199
+ 3. Generer funksjonsdesign (inkludert UI-wireframes, interaksjonsflyter, datadefinisjoner, API-kontrakter)
200
+ 4. For flere PRD-er, bruk Task Worker for parallell design
201
+
202
+ **Leveranse**:
203
+ ```
204
+ iterations/{iter}/02.feature-design/
205
+ └── [feature-name]-feature-spec.md # Funksjonsdesigndokument
206
+ ```
207
+
208
+ **Bekreftelseskontrollliste**:
209
+ - [ ] Er alle brukerscenarier dekket?
210
+ - [ ] Er interaksjonsflyter klare?
211
+ - [ ] Er datafeltdefinisjoner komplette?
212
+ - [ ] Er unntakshåndtering omfattende?
213
+
214
+ ---
215
+
216
+ ### 4.3 Fase 3: Systemdesign (System Designer)
217
+
218
+ **Hvordan Starte**:
219
+ ```
220
+ @speccrew-system-designer start systemdesign
221
+ ```
222
+
223
+ **Agent Arbeidsflyt**:
224
+ 1. Finn Feature Spec og API Contract
225
+ 2. Last inn teknisk kunnskapsbase (teknologistabel, arkitektur, spesifikasjoner for hver plattform)
226
+ 3. **Kontrollpunkt A**: Rammeverkvurdering — Analyser tekniske gap, anbefal nye rammeverk (om nødvendig), vent på brukerbekreftelse
227
+ 4. Generer DESIGN-OVERVIEW.md
228
+ 5. Bruk Task Worker for parallell designdistribusjon for hver plattform (frontend/backend/mobil/skrivebord)
229
+ 6. **Kontrollpunkt B**: Felles Bekreftelse — Vis oppsummering av alle plattformdesign, vent på brukerbekreftelse
230
+
231
+ **Leveranse**:
232
+ ```
233
+ iterations/{iter}/03.system-design/
234
+ ├── DESIGN-OVERVIEW.md # Designoversikt
235
+ ├── {platform-id}/
236
+ │ ├── INDEX.md # Plattformdesign-indeks
237
+ │ └── {module}-design.md # Moduldesign på pseudokodenivå
238
+ ```
239
+
240
+ **Bekreftelseskontrollliste**:
241
+ - [ ] Bruker pseudokoden faktisk rammeverksyntaks?
242
+ - [ ] Er cross-plattform API-kontrakter konsistente?
243
+ - [ ] Er feilhåndteringsstrategi unified?
244
+
245
+ ---
246
+
247
+ ### 4.4 Fase 4: Utviklingsimplementering (System Developer)
248
+
249
+ **Hvordan Starte**:
250
+ ```
251
+ @speccrew-system-developer start utvikling
252
+ ```
253
+
254
+ **Agent Arbeidsflyt**:
255
+ 1. Les systemdesigndokumenter
256
+ 2. Last inn teknisk kunnskap for hver plattform
257
+ 3. **Kontrollpunkt A**: Miljø-forhåndsverifisering — Verifiser runtime-versjoner, avhengigheter, tjenestetilgjengelighet; hvis mislykkes, vent på brukerløsning
258
+ 4. Bruk Task Worker for parallell utviklingsdistribusjon for hver plattform
259
+ 5. Integrasjonsverifisering: API-kontraktsjustering, datakonsistens
260
+ 6. Output leveranserapport
261
+
262
+ **Leveranse**:
263
+ ```
264
+ # Kildekode skrives til prosjektets faktiske kildekodekatalog
265
+ iterations/{iter}/04.development/
266
+ ├── {platform-id}/
267
+ │ └── tasks/ # Utviklingsopptegnelser
268
+ └── delivery-report.md
269
+ ```
270
+
271
+ **Bekreftelseskontrollliste**:
272
+ - [ ] Er miljøet klart?
273
+ - [ ] Er integrasjonsproblemer innen akseptabelt område?
274
+ - [ ] Følger koden utviklingsspesifikasjoner?
275
+
276
+ ---
277
+
278
+ ### 4.5 Fase 5: Systemtesting (Test Manager)
279
+
280
+ **Hvordan Starte**:
281
+ ```
282
+ @speccrew-test-manager start testing
283
+ ```
284
+
285
+ **Tre-fase Testprosess**:
286
+
287
+ | Fase | Beskrivelse | Kontrollpunkt |
288
+ |------|----------|-------------------|
289
+ | Testtilfelldesign | Generer testtilfeller basert på PRD og Feature Spec | A: Vis testtilfelde-dekningsstatistikk og sporbarhetsmatrise, vent på brukerbekreftelse på tilstrekkelig dekning |
290
+ | Testkodegenerering | Generer kjørbart testkode | B: Vis genererte testfiler og用例-mapping, vent på brukerbekreftelse |
291
+ | Testutførelse og Feilrapport | Utfør tester automatisk og generer rapporter | Ingen (automatisk utførelse) |
292
+
293
+ **Leveranse**:
294
+ ```
295
+ iterations/{iter}/05.system-test/
296
+ ├── cases/
297
+ │ └── {platform-id}/ # Testtilfelldokumenter
298
+ ├── code/
299
+ │ └── {platform-id}/ # Testkodeplan
300
+ ├── reports/
301
+ │ └── test-report-{date}.md # Testrapport
302
+ └── bugs/
303
+ └── BUG-{id}-{title}.md # Feilrapporter (én fil per feil)
304
+ ```
305
+
306
+ **Bekreftelseskontrollliste**:
307
+ - [ ] Er testtilfelledekning komplett?
308
+ - [ ] Er testkoden kjørbar?
309
+ - [ ] Er feilalvorlighetsvurdering nøyaktig?
310
+
311
+ ---
312
+
313
+ ### 4.6 Fase 6: Arkivering
314
+
315
+ Iterasjoner arkiveres automatisk når de er fullført:
316
+
317
+ ```
318
+ speccrew-workspace/iteration-archives/
319
+ └── {nummer}-{type}-{navn}-{dato}/
320
+ ├── 01.product-requirement/
321
+ ├── 02.feature-design/
322
+ ├── 03.system-design/
323
+ ├── 04.development/
324
+ └── 05.system-test/
325
+ ```
326
+
327
+ ---
328
+
329
+ ## 5. Kunnskapsbaseoversikt
330
+
331
+ ### 5.1 Forretningskunnskapsbase (bizs)
332
+
333
+ **Formål**: Lagre prosjektets forretningsfunksjonsbeskrivelser, moduloppdelinger, API-kjennetegn
334
+
335
+ **Katalogstruktur**:
336
+ ```
337
+ knowledges/bizs/
338
+ ├── {platform-type}/
339
+ │ └── {module-name}/
340
+ │ └── feature-spec.md
341
+ └── system-overview.md
342
+ ```
343
+
344
+ **Bruksscenarier**: Product Manager, Feature Designer
345
+
346
+ ### 5.2 Teknisk Kunnskapsbase (techs)
347
+
348
+ **Formål**: Lagre prosjektets teknologistabel, arkitekturkonvensjoner, utviklingsspesifikasjoner, testspesifikasjoner
349
+
350
+ **Katalogstruktur**:
351
+ ```
352
+ knowledges/techs/{platform-id}/
353
+ ├── tech-stack.md
354
+ ├── architecture.md
355
+ ├── dev-spec.md
356
+ ├── test-spec.md
357
+ └── INDEX.md
358
+ ```
359
+
360
+ **Bruksscenarier**: System Designer, System Developer, Test Manager
361
+
362
+ ---
363
+
364
+ ## 6. Ofte Stilte Spørsmål (FAQ)
365
+
366
+ ### S1: Hva gjør jeg hvis Agenten ikke fungerer som forventet?
367
+
368
+ 1. Kjør `speccrew doctor` for å sjekke installasjonsintegritet
369
+ 2. Bekreft at kunnskapsbasen er initialisert
370
+ 3. Bekreft at forrige fases leveranse finnes i gjeldende iterasjonskatalog
371
+
372
+ ### S2: Hvordan hoppe over en fase?
373
+
374
+ **Anbefales ikke** — Hver fases output er input for neste fase.
375
+
376
+ Hvis du må hoppe over, forbered manuelt input-dokumentet for den tilsvarende fasen og sørg for at det følger formatspesifikasjoner.
377
+
378
+ ### S3: Hvordan håndtere flere parallelle krav?
379
+
380
+ Opprett uavhengige iterasjonskataloger for hvert krav:
381
+ ```
382
+ iterations/
383
+ ├── 001-feature-xxx/
384
+ ├── 002-feature-yyy/
385
+ └── 003-feature-zzz/
386
+ ```
387
+
388
+ Hver iterasjon er fullstendig isolert og påvirker ikke hverandre.
389
+
390
+ ### S4: Hvordan oppdatere SpecCrew-versjonen?
391
+
392
+ - **Global Oppdatering**: `npm update -g speccrew`
393
+ - **Prosjektoppdatering**: Kjør `speccrew update` i prosjektkatalogen
394
+
395
+ ### S5: Hvordan se historiske iterasjoner?
396
+
397
+ Etter arkivering, se i `speccrew-workspace/iteration-archives/`, organisert i formatet `{nummer}-{type}-{navn}-{dato}/`.
398
+
399
+ ### S6: Trenger kunnskapsbasen regelmessig oppdatering?
400
+
401
+ Re-initialisering kreves i følgende situasjoner:
402
+ - Betydelige endringer i prosjektstruktur
403
+ - Oppdatering eller erstatning av teknologistabel
404
+ - Legge til/fjerne forretningsmoduler
405
+
406
+ ---
407
+
408
+ ## 7. Hurtigreferanse
409
+
410
+ ### Agent-start Hurtigreferanse
411
+
412
+ | Fase | Agent | Startdialog |
413
+ |------|-------|-------------------|
414
+ | Diagnose | Team Leader | `@speccrew-team-leader diagnostiser prosjekt` |
415
+ | Initialisering | Team Leader | `@speccrew-team-leader initialiser teknisk kunnskapsbase` |
416
+ | Kravanalyse | Product Manager | `@speccrew-product-manager jeg har et nytt krav: [beskrivelse]` |
417
+ | Funksjonsdesign | Feature Designer | `@speccrew-feature-designer start funksjonsdesign` |
418
+ | Systemdesign | System Designer | `@speccrew-system-designer start systemdesign` |
419
+ | Utvikling | System Developer | `@speccrew-system-developer start utvikling` |
420
+ | Systemtesting | Test Manager | `@speccrew-test-manager start testing` |
421
+
422
+ ### Kontrollpunkter Kontrollliste
423
+
424
+ | Fase | Antall Kontrollpunkter | Nøkkelelementer for Verifisering |
425
+ |------|------------------------|--------------------------------|
426
+ | Kravanalyse | 1 | Kravnøyaktighet, forretningsregler kompletthet, akseptkriterier målbarhet |
427
+ | Funksjonsdesign | 1 | Szenariedekning, interaksjonsklarhet, datakompletthet, unntakshåndtering |
428
+ | Systemdesign | 2 | A: Rammeverkvurdering; B: Pseudokodesyntaks, cross-plattform konsistens, feilhåndtering |
429
+ | Utvikling | 1 | A: Miljøklarhet, integrasjonsproblemer, kodespesifikasjoner |
430
+ | Systemtesting | 2 | A: Tilfelledekning; B: Testkodekjørbarhet |
431
+
432
+ ### Leveransesti Hurtigreferanse
433
+
434
+ | Fase | Output-katalog | Filformat |
435
+ |------|------------------|-------------|
436
+ | Kravanalyse | `iterations/{iter}/01.product-requirement/` | `[name]-prd.md`, `[name]-bizs-modeling.md` |
437
+ | Funksjonsdesign | `iterations/{iter}/02.feature-design/` | `[name]-feature-spec.md` |
438
+ | Systemdesign | `iterations/{iter}/03.system-design/` | `DESIGN-OVERVIEW.md`, `{platform}/INDEX.md`, `{platform}/{module}-design.md` |
439
+ | Utvikling | `iterations/{iter}/04.development/` | Kildekode + `delivery-report.md` |
440
+ | Systemtesting | `iterations/{iter}/05.system-test/` | `cases/`, `code/`, `reports/`, `bugs/` |
441
+ | Arkivering | `iteration-archives/{iter}-{dato}/` | Fullstendig kopi av iterasjonen |
442
+
443
+ ---
444
+
445
+ ## Neste Steg
446
+
447
+ 1. Kjør `speccrew init --ide qoder` for å initialisere prosjektet ditt
448
+ 2. Utfør Null Steg: Prosjektdiagnose og Kunnskapsbase-initialisering
449
+ 3. Beveg deg gjennom hver fase etter arbeidsflyten, nyt spesifikasjonsdrevet utviklingserfaring!