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
package/README.pl.md ADDED
@@ -0,0 +1,321 @@
1
+ # SpecCrew - Framework Inżynierii Oprogramowania Napędzany AI
2
+
3
+ <p align="center">
4
+ <a href="./README.md">简体中文</a> |
5
+ <a href="./README.zh-TW.md">繁體中文</a> |
6
+ <a href="./README.en.md">English</a> |
7
+ <a href="./README.ko.md">한국어</a> |
8
+ <a href="./README.de.md">Deutsch</a> |
9
+ <a href="./README.es.md">Español</a> |
10
+ <a href="./README.fr.md">Français</a> |
11
+ <a href="./README.it.md">Italiano</a> |
12
+ <a href="./README.da.md">Dansk</a> |
13
+ <a href="./README.ja.md">日本語</a> |
14
+ <a href="./README.pl.md">Polski</a> |
15
+ <a href="./README.ru.md">Русский</a> |
16
+ <a href="./README.bs.md">Bosanski</a> |
17
+ <a href="./README.ar.md">العربية</a> |
18
+ <a href="./README.no.md">Norsk</a> |
19
+ <a href="./README.pt-BR.md">Português (Brasil)</a> |
20
+ <a href="./README.th.md">ไทย</a> |
21
+ <a href="./README.tr.md">Türkçe</a> |
22
+ <a href="./README.uk.md">Українська</a> |
23
+ <a href="./README.bn.md">বাংলা</a> |
24
+ <a href="./README.el.md">Ελληνικά</a> |
25
+ <a href="./README.vi.md">Tiếng Việt</a>
26
+ </p>
27
+
28
+ <p align="center">
29
+ <a href="https://www.npmjs.com/package/speccrew"><img src="https://img.shields.io/npm/v/speccrew.svg" alt="npm version"></a>
30
+ <a href="https://www.npmjs.com/package/speccrew"><img src="https://img.shields.io/npm/dm/speccrew.svg" alt="npm downloads"></a>
31
+ <a href="https://github.com/charlesmu99/speccrew/blob/main/LICENSE"><img src="https://img.shields.io/npm/l/speccrew.svg" alt="license"></a>
32
+ </p>
33
+
34
+ > Wirtualny zespół deweloperski AI umożliwiający szybką implementację inżynieryjną dla każdego projektu software'owego
35
+
36
+ ## Czym jest SpecCrew?
37
+
38
+ SpecCrew to wbudowany framework wirtualnego zespołu deweloperskiego AI. Przekształca profesjonalne workflow inżynierii software'owej (PRD → Feature Design → System Design → Dev → Test) w wielokrotnego użytku workflow Agentów, pomagając zespołom deweloperskim osiągnąć Specification-Driven Development (SDD), szczególnie odpowiedni dla istniejących projektów.
39
+
40
+ Poprzez integrację Agentów i Skilli z istniejącymi projektami, zespoły mogą szybko zainicjować systemy dokumentacji projektu i wirtualne zespoły software'owe, implementując nowe funkcje i modyfikacje zgodnie ze standardowymi workflow inżynieryjnymi.
41
+
42
+ ---
43
+
44
+ ## 8 Rozwiązanych Problemów Rdzeniowych
45
+
46
+ ### 1. AI Ignoruje Istniejącą Dokumentację Projektu (Luka Wiedzy)
47
+ **Problem**: Istniejące metody SDD lub Vibe Coding polegają na AI podsumowującym projekty w czasie rzeczywistym, łatwo gubiąc krytyczny kontekst i powodując, że wyniki rozwoju odchodzą od oczekiwań.
48
+
49
+ **Rozwiązanie**: Repozytorium `knowledge/` służy jako "jedno źródło prawdy" projektu, akumulując projekt architektury, moduły funkcjonalne i procesy biznesowe, zapewniając, że wymagania pozostają na torze od źródła.
50
+
51
+ ### 2. Bezpośrednia Dokumentacja Techniczna z PRD (Pominięcie Treści)
52
+ **Problem**: Przeskakiwanie bezpośrednio z PRD do szczegółowego projektu łatwo gubi szczegóły wymagań, powodując, że implementowane funkcje odchodzą od wymagań.
53
+
54
+ **Rozwiązanie**: Wprowadzenie fazy **Dokumentu Feature Design**, skupiającej się tylko na szkielecie wymagań bez szczegółów technicznych:
55
+ - Jakie strony i komponenty są zawarte?
56
+ - Przepływy operacji stron
57
+ - Logika przetwarzania backend
58
+ - Struktura przechowywania danych
59
+
60
+ Rozwój musi tylko "wypełnić ciało" na podstawie konkretnego tech stacku, zapewniając, że funkcje rosną "blisko kości (wymagań)".
61
+
62
+ ### 3. Niepewny Zakres Wyszukiwania Agenta (Niepewność)
63
+ **Problem**: W złożonych projektach szerokie wyszukiwanie kodu i dokumentów przez AI daje niepewne wyniki, czyniąc spójność trudną do zagwarantowania.
64
+
65
+ **Rozwiązanie**: Jasne struktury katalogów dokumentów i szablony, zaprojektowane w oparciu o potrzeby każdego Agenta, implementują **stopniowe ujawnianie i ładowanie na żądanie** aby zagwarantować determinizm.
66
+
67
+ ### 4. Brakujące Kroki i Zadania (Załamanie Procesu)
68
+ **Problem**: Brak pełnego pokrycia procesu inżynieryjnego łatwo gubi krytyczne kroki, czyniąc jakość trudną do zagwarantowania.
69
+
70
+ **Rozwiązanie**: Pokrycie całego cyklu życia inżynierii software'owej:
71
+ ```
72
+ PRD (Wymagania) → Feature Design (Projekt Funkcjonalny) → API Contract (Kontrakt)
73
+ → System Design (Projekt Systemu) → Dev (Rozwój) → Test (Testy)
74
+ ```
75
+ - Wyjście każdej fazy jest wejściem następnej fazy
76
+ - Każdy krok wymaga ludzkiego potwierdzenia przed kontynuacją
77
+ - Wszystkie egzekucje Agentów mają listy todo z samosprawdzeniem po zakończeniu
78
+
79
+ ### 5. Niska Efektywność Współpracy Zespołu (Silosy Wiedzy)
80
+ **Problem**: Doświadczenie programowania AI jest trudne do dzielenia między zespołami, prowadząc do powtarzających się błędów.
81
+
82
+ **Rozwiązanie**: Wszystkie Agenty, Skille i powiązane dokumenty są wersjonowane z kodem źródłowym:
83
+ - Optymalizacja jednej osoby jest dzielona przez zespół
84
+ - Wiedza akumuluje się w bazie kodu
85
+ - Poprawiona efektywność współpracy zespołu
86
+
87
+ ### 7. Zbyt Długi Kontekst Pojedynczego Agenta (Wąskie Gardło Wydajności)
88
+ **Problem**: Duże złożone zadania przekraczają okna kontekstu pojedynczego Agenta, powodując odchylenia w zrozumieniu i spadek jakości wyjścia.
89
+
90
+ **Rozwiązanie**: **Mechanizm Auto-Dispatch Sub-Agentów**:
91
+ - Złożone zadania są automatycznie identyfikowane i dzielone na podzadania
92
+ - Każdy podzadanie jest wykonywany przez niezależnego sub-Agenta z izolowanym kontekstem
93
+ - Parent Agent koordynuje i agreguje aby zapewnić ogólną spójność
94
+ - Unika ekspansji kontekstu pojedynczego Agenta, zapewniając jakość wyjścia
95
+
96
+ ### 8. Chaos Iteracji Wymagań (Trudności Zarządzania)
97
+ **Problem**: Wiele wymagań zmieszanych w tej samej gałęzi wpływa na siebie nawzajem, czyniąc śledzenie i rollback trudnym.
98
+
99
+ **Rozwiązanie**: **Każde Wymaganie jako Niezależny Projekt**:
100
+ - Każde wymaganie tworzy niezależny katalog iteracji `iterations/iXXX-[nazwa-wymagania]/`
101
+ - Pełna izolacja: dokumenty, projekt, kod i testy zarządzane niezależnie
102
+ - Szybka iteracja: dostarczanie małej granulacji, szybka weryfikacja, szybkie wdrożenie
103
+ - Elastyczne archiwizowanie: po zakończeniu, archiwizacja do `archive/` z jasną historyczną identyfikowalnością
104
+
105
+ ### 6. Opóźnienie Aktualizacji Dokumentów (Rozkład Wiedzy)
106
+ **Problem**: Dokumenty stają się przestarzałe w miarę jak projekty ewoluują, powodując, że AI pracuje z nieprawidłowymi informacjami.
107
+
108
+ **Rozwiązanie**: Agenty mają automatyczne możliwości aktualizacji dokumentów, synchronizując zmiany projektu w czasie rzeczywistym aby utrzymać dokładność bazy wiedzy.
109
+
110
+ ---
111
+
112
+ ## Rdzenny Workflow
113
+
114
+ ```mermaid
115
+ graph LR
116
+ A[PRD<br/>Dokument Wymagań] --> B[Feature Design<br/>Projekt Funkcjonalny]
117
+ B --> C[API Contract<br/>Kontrakt Interfejsu]
118
+ C --> D[System Design<br/>Projekt Systemu]
119
+ D --> E[Dev<br/>Implementacja]
120
+ E --> F[System Test<br/>Testy]
121
+ F --> G[Archive<br/>Archiwizacja]
122
+
123
+ H[Knowledge<br/>Repozytorium] -.-> A
124
+ H -.-> B
125
+ H -.-> D
126
+ H -.-> E
127
+
128
+ E -.-> H
129
+ F -.-> H
130
+ ```
131
+
132
+ ### Opisy Faz
133
+
134
+ | Faza | Agent | Wejście | Wyjście | Ludzkie Potwierdzenie |
135
+ |------|-------|---------|---------|----------------------|
136
+ | PRD | PM | Wymagania Użytkownika | Dokument Wymagań Produktu | ✅ Wymagane |
137
+ | Feature Design | Feature Designer | PRD | Dokument Feature Design + Kontrakt API | ✅ Wymagane |
138
+ | System Design | System Designer | Feature Spec | Dokumenty Projektu Frontend/Backend | ✅ Wymagane |
139
+ | Dev | Dev | Design | Kod + Rejestry Zadań | ✅ Wymagane |
140
+ | System Test | Test Manager | Wyjście Dev + Feature Spec | Przypadki Testowe + Kod Testowy + Raport Testowy + Raport Bugów | ✅ Wymagane |
141
+
142
+ ---
143
+
144
+ ## Porównanie z Istniejącymi Rozwiązaniami
145
+
146
+ | Wymiar | Vibe Coding | Ralph Loop | **SpecCrew** |
147
+ |--------|-------------|------------|-------------|
148
+ | Zależność od Dokumentów | Ignoruje istniejące docs | Polega na AGENTS.md | **Strukturalna Baza Wiedzy** |
149
+ | Transfer Wymagań | Bezpośrednie kodowanie | PRD → Kod | **PRD → Feature Design → System Design → Kod** |
150
+ | Ludzkie Zaangażowanie | Minimalne | Przy starcie | **W każdej fazie** |
151
+ | Kompletność Procesu | Słaba | Średnia | **Kompletny workflow inżynieryjny** |
152
+ | Współpraca Zespołu | Trudno dzielić | Osobista efektywność | **Dzielenie wiedzy zespołu** |
153
+ | Zarządzanie Kontekstem | Pojedyncza instancja | Pętla pojedynczej instancji | **Auto-dispatch sub-Agentów** |
154
+ | Zarządzanie Iteracją | Mieszane | Lista zadań | **Wymaganie jako projekt, niezależna iteracja** |
155
+ | Determinizm | Niski | Średni | **Wysoki (stopniowe ujawnianie)** |
156
+
157
+ ---
158
+
159
+ ## Szybki Start
160
+
161
+ ### Wymagania Wstępne
162
+
163
+ - Node.js >= 16.0.0
164
+ - Wspierane IDE: Qoder (domyślne), Cursor, Claude Code
165
+
166
+ > **Uwaga**: Adaptery dla Cursor i Claude Code nie zostały przetestowane w rzeczywistych środowiskach IDE (zaimplementowane na poziomie kodu i zweryfikowane przez testy E2E, ale jeszcze nie przetestowane w rzeczywistym Cursor/Claude Code).
167
+
168
+ ### 1. Zainstaluj SpecCrew
169
+
170
+ ```bash
171
+ npm install -g speccrew
172
+ ```
173
+
174
+ ### 2. Zainicjuj Projekt
175
+
176
+ Nawiguj do głównego katalogu projektu i uruchom komendę inicjalizacji:
177
+
178
+ ```bash
179
+ cd /path/to/your-project
180
+
181
+ # Domyślnie używa Qoder
182
+ speccrew init
183
+
184
+ # Lub określ IDE
185
+ speccrew init --ide qoder
186
+ speccrew init --ide cursor
187
+ speccrew init --ide claude
188
+ ```
189
+
190
+ Po inicjalizacji w projekcie zostaną wygenerowane:
191
+ - `.qoder/agents/` / `.cursor/agents/` / `.claude/agents/` — 7 definicji ról Agentów
192
+ - `.qoder/skills/` / `.cursor/skills/` / `.claude/skills/` — 38 workflow Skilli
193
+ - `speccrew-workspace/` — Przestrzeń robocza (katalogi iteracji, baza wiedzy, szablony dokumentów)
194
+ - `.speccrewrc` — Plik konfiguracyjny SpecCrew
195
+
196
+ Aby później zaktualizować Agenty i Skille dla konkretnego IDE:
197
+
198
+ ```bash
199
+ speccrew update --ide cursor
200
+ speccrew update --ide claude
201
+ ```
202
+
203
+ ### 3. Rozpocznij Workflow Rozwoju
204
+
205
+ Podążaj za standardowym workflow inżynieryjnym krok po kroku:
206
+
207
+ 1. **PRD**: Agent Product Manager analizuje wymagania i generuje dokument wymagań produktu
208
+ 2. **Feature Design**: Agent Feature Designer generuje dokument feature design + kontrakt API
209
+ 3. **System Design**: Agent System Designer generuje dokumenty system design według platformy (frontend/backend/mobile/desktop)
210
+ 4. **Dev**: Agent System Developer implementuje rozwój według platformy równolegle
211
+ 5. **System Test**: Agent Test Manager koordynuje testowanie trójfazowe (projekt przypadków → generowanie kodu → raport egzekucji)
212
+ 6. **Archive**: Zarchiwizuj iterację
213
+
214
+ > Deliverable każdej fazy wymaga ludzkiego potwierdzenia przed przejściem do następnej fazy.
215
+
216
+ ### 4. Inne Komendy CLI
217
+
218
+ ```bash
219
+ speccrew list # Wylistuj zainstalowane agenty i skille
220
+ speccrew doctor # Zdiagnozuj środowisko i status instalacji
221
+ speccrew update # Zaktualizuj agenty i skille do najnowszej wersji
222
+ speccrew uninstall # Odinstaluj SpecCrew (--all usuwa też przestrzeń roboczą)
223
+ ```
224
+
225
+ 📖 **Szczegółowy Przewodnik**: Po instalacji, sprawdź [Przewodnik Wprowadzający](docs/GETTING-STARTED.pl.md) dla pełnego workflow i przewodnika rozmów agentów.
226
+
227
+ ---
228
+
229
+ ## Struktura Katalogu
230
+
231
+ ```
232
+ your-project/
233
+ ├── .qoder/ # Katalog konfiguracji IDE (przykład Qoder)
234
+ │ ├── agents/ # 7 Agentów ról
235
+ │ │ ├── speccrew-team-leader.md # Lider Zespołu: Globalne planowanie i zarządzanie iteracją
236
+ │ │ ├── speccrew-product-manager.md # Product Manager: Analiza wymagań i PRD
237
+ │ │ ├── speccrew-feature-designer.md # Feature Designer: Feature Design + Kontrakt API
238
+ │ │ ├── speccrew-system-designer.md # System Designer: System design według platformy
239
+ │ │ ├── speccrew-system-developer.md # System Developer: Równoległy rozwój według platformy
240
+ │ │ ├── speccrew-test-manager.md # Test Manager: Koordynacja testów trójfazowych
241
+ │ │ └── speccrew-task-worker.md # Task Worker: Równoległa egzekucja podzadań
242
+ │ └── skills/ # 38 Skilli (zgrupowane według funkcji)
243
+ │ ├── speccrew-pm-*/ # Zarządzanie Produktem (analiza wymagań, ewaluacja)
244
+ │ ├── speccrew-fd-*/ # Feature Design (Feature Design, Kontrakt API)
245
+ │ ├── speccrew-sd-*/ # System Design (frontend/backend/mobile/desktop)
246
+ │ ├── speccrew-dev-*/ # Rozwój (frontend/backend/mobile/desktop)
247
+ │ ├── speccrew-test-*/ # Testy (projekt przypadków/generowanie kodu/raport egzekucji)
248
+ │ ├── speccrew-knowledge-bizs-*/ # Wiedza Biznesowa (analiza API/analiza UI/klasyfikacja modułów itd.)
249
+ │ ├── speccrew-knowledge-techs-*/ # Wiedza Techniczna (generowanie tech stacku/konwencje/indeks itd.)
250
+ │ ├── speccrew-knowledge-graph-*/ # Graf Wiedzy (odczyt/zapis/zapytanie)
251
+ │ └── speccrew-*/ # Narzędzia (diagnostyka/timestampy/workflow itd.)
252
+
253
+ └── speccrew-workspace/ # Przestrzeń robocza (generowana podczas inicjalizacji)
254
+ ├── docs/ # Dokumenty zarządcze
255
+ │ ├── configs/ # Pliki konfiguracyjne (mapowanie platform, mapowanie tech stacku itd.)
256
+ │ ├── rules/ # Konfiguracje reguł
257
+ │ └── solutions/ # Dokumenty rozwiązań
258
+
259
+ ├── iterations/ # Projekty iteracji (generowane dynamicznie)
260
+ │ └── {numer}-{typ}-{nazwa}/
261
+ │ ├── 00.docs/ # Oryginalne wymagania
262
+ │ ├── 01.product-requirement/ # Wymagania produktu
263
+ │ ├── 02.feature-design/ # Feature design
264
+ │ ├── 03.system-design/ # System design
265
+ │ ├── 04.development/ # Faza rozwoju
266
+ │ ├── 05.system-test/ # Testy systemowe
267
+ │ └── 06.delivery/ # Faza dostawy
268
+
269
+ ├── iteration-archives/ # Archiwa iteracji
270
+
271
+ └── knowledges/ # Baza wiedzy
272
+ ├── base/ # Podstawa/metadane
273
+ │ ├── diagnosis-reports/ # Raporty diagnostyczne
274
+ │ ├── sync-state/ # Stan synchronizacji
275
+ │ └── tech-debts/ # Dług techniczny
276
+ ├── bizs/ # Wiedza biznesowa
277
+ │ └── {platform-type}/{module-name}/
278
+ └── techs/ # Wiedza techniczna
279
+ └── {platform-id}/
280
+ ```
281
+
282
+ ---
283
+
284
+ ## Główne Zasady Projektowania
285
+
286
+ 1. **Specification-Driven**: Pisz specyfikacje najpierw, potem pozwól kodowi "wyrosnąć" z nich
287
+ 2. **Stopniowe Ujawnianie**: Agenty zaczynają od minimalnych punktów wejścia, ładując informacje na żądanie
288
+ 3. **Ludzkie Potwierdzenie**: Wyjście każdej fazy wymaga ludzkiego potwierdzenia aby zapobiec odchyleniom AI
289
+ 4. **Izolacja Kontekstu**: Duże zadania są dzielone na małe, izolowane kontekstowo podzadania
290
+ 5. **Współpraca Sub-Agentów**: Złożone zadania automatycznie dispatchują sub-Agentów aby uniknąć ekspansji kontekstu pojedynczego Agenta
291
+ 6. **Szybka Iteracja**: Każde wymaganie jako niezależny projekt dla szybkiej dostawy i weryfikacji
292
+ 7. **Dzielenie Wiedzy**: Wszystkie konfiguracje są wersjonowane z kodem źródłowym
293
+
294
+ ---
295
+
296
+ ## Przypadki Użycia
297
+
298
+ ### ✅ Zalecane Dla
299
+ - Średnie do dużych projektów wymagających standaryzowanych workflow
300
+ - Rozwój software'u we współpracy zespołowej
301
+ | Transformacja inżynieryjna projektów legacy
302
+ | Produkty wymagające długoterminowego utrzymania
303
+
304
+ ### ❌ Nieodpowiednie Dla
305
+ | Osobista szybka walidacja prototypu
306
+ | Projekty eksploracyjne z bardzo niepewnymi wymaganiami
307
+ | Jednorazowe skrypty lub narzędzia
308
+
309
+ ---
310
+
311
+ ## Więcej Informacji
312
+
313
+ - **Mapa Wiedzy Agentów**: [speccrew-workspace/docs/agent-knowledge-map.md](./speccrew-workspace/docs/agent-knowledge-map.md)
314
+ - **npm**: https://www.npmjs.com/package/speccrew
315
+ - **GitHub**: https://github.com/charlesmu99/speccrew
316
+ - **Gitee**: https://gitee.com/amutek/speccrew
317
+ - **Qoder IDE**: https://qoder.com/
318
+
319
+ ---
320
+
321
+ > **SpecCrew nie ma na celu zastąpienia deweloperów, ale zautomatyzowanie nudnych części, aby zespoły mogły skupić się na bardziej wartościowej pracy.**
@@ -0,0 +1,321 @@
1
+ # SpecCrew - Framework de Engenharia de Software Impulsionado por IA
2
+
3
+ <p align="center">
4
+ <a href="./README.md">简体中文</a> |
5
+ <a href="./README.zh-TW.md">繁體中文</a> |
6
+ <a href="./README.en.md">English</a> |
7
+ <a href="./README.ko.md">한국어</a> |
8
+ <a href="./README.de.md">Deutsch</a> |
9
+ <a href="./README.es.md">Español</a> |
10
+ <a href="./README.fr.md">Français</a> |
11
+ <a href="./README.it.md">Italiano</a> |
12
+ <a href="./README.da.md">Dansk</a> |
13
+ <a href="./README.ja.md">日本語</a> |
14
+ <a href="./README.pl.md">Polski</a> |
15
+ <a href="./README.ru.md">Русский</a> |
16
+ <a href="./README.bs.md">Bosanski</a> |
17
+ <a href="./README.ar.md">العربية</a> |
18
+ <a href="./README.no.md">Norsk</a> |
19
+ <a href="./README.pt-BR.md">Português (Brasil)</a> |
20
+ <a href="./README.th.md">ไทย</a> |
21
+ <a href="./README.tr.md">Türkçe</a> |
22
+ <a href="./README.uk.md">Українська</a> |
23
+ <a href="./README.bn.md">বাংলা</a> |
24
+ <a href="./README.el.md">Ελληνικά</a> |
25
+ <a href="./README.vi.md">Tiếng Việt</a>
26
+ </p>
27
+
28
+ <p align="center">
29
+ <a href="https://www.npmjs.com/package/speccrew"><img src="https://img.shields.io/npm/v/speccrew.svg" alt="npm version"></a>
30
+ <a href="https://www.npmjs.com/package/speccrew"><img src="https://img.shields.io/npm/dm/speccrew.svg" alt="npm downloads"></a>
31
+ <a href="https://github.com/charlesmu99/speccrew/blob/main/LICENSE"><img src="https://img.shields.io/npm/l/speccrew.svg" alt="license"></a>
32
+ </p>
33
+
34
+ > Uma equipe de desenvolvimento de IA virtual que permite implementação rápida de engenharia para qualquer projeto de software
35
+
36
+ ## O que é SpecCrew?
37
+
38
+ SpecCrew é um framework de equipe de desenvolvimento de IA virtual incorporado. Ele transforma fluxos de trabalho de engenharia de software profissional (PRD → Feature Design → System Design → Dev → Test) em fluxos de trabalho de Agent reutilizáveis, ajudando equipes de desenvolvimento a alcançar o Specification-Driven Development (SDD), especialmente adequado para projetos existentes.
39
+
40
+ Ao integrar Agents e Skills em projetos existentes, as equipes podem inicializar rapidamente sistemas de documentação de projetos e equipes de software virtuais, implementando novas funcionalidades e modificações seguindo fluxos de trabalho de engenharia padrão.
41
+
42
+ ---
43
+
44
+ ## 8 Problemas Principais Resolvidos
45
+
46
+ ### 1. IA Ignora Documentação de Projeto Existente (Lacuna de Conhecimento)
47
+ **Problema**: Os métodos SDD ou Vibe Coding existentes dependem da IA resumindo projetos em tempo real, perdendo facilmente o contexto crítico e causando resultados de desenvolvimento que se desviam das expectativas.
48
+
49
+ **Solução**: O repositório `knowledge/` serve como a "única fonte da verdade" do projeto, acumulando design de arquitetura, módulos funcionais e processos de negócios para garantir que os requisitos permaneçam no caminho certo desde a fonte.
50
+
51
+ ### 2. Documentação Técnica Direta do PRD (Omissão de Conteúdo)
52
+ **Problema**: Pular diretamente do PRD para o design detalhado perde facilmente os detalhes dos requisitos, fazendo com que as funcionalidades implementadas se desviem dos requisitos.
53
+
54
+ **Solução**: Introduzir a fase de **Documento Feature Design**, focando apenas no esqueleto dos requisitos sem detalhes técnicos:
55
+ - Quais páginas e componentes estão incluídos?
56
+ - Fluxos de operação de páginas
57
+ - Lógica de processamento backend
58
+ - Estrutura de armazenamento de dados
59
+
60
+ O desenvolvimento só precisa "preencher a carne" com base na stack tecnológica específica, garantindo que as funcionalidades cresçam "perto do osso (requisitos)".
61
+
62
+ ### 3. Escopo de Busca de Agent Incerto (Incerteza)
63
+ **Problema**: Em projetos complexos, a busca ampla de código e documentos pela IA produz resultados incertos, tornando a consistência difícil de garantir.
64
+
65
+ **Solução**: Estruturas de diretórios de documentos claras e templates, projetadas com base nas necessidades de cada Agent, implementam **divulgação progressiva e carregamento sob demanda** para garantir determinismo.
66
+
67
+ ### 4. Fases e Tarefas Ausentes (Rompimento de Processo)
68
+ **Problema**: A falta de cobertura completa do processo de engenharia perde facilmente fases críticas, tornando a qualidade difícil de garantir.
69
+
70
+ **Solução**: Cobrir todo o ciclo de vida da engenharia de software:
71
+ ```
72
+ PRD (Requisitos) → Feature Design (Design de Funcionalidade) → API Contract (Contrato)
73
+ → System Design (Design de Sistema) → Dev (Desenvolvimento) → Test (Testes)
74
+ ```
75
+ - A saída de cada fase é a entrada da próxima fase
76
+ - Cada passo requer confirmação humana antes de prosseguir
77
+ - Todas as execuções de Agent têm listas de tarefas com auto-verificação após conclusão
78
+
79
+ ### 5. Baixa Eficiência de Colaboração da Equipe (Silos de Conhecimento)
80
+ **Problema**: A experiência de programação com IA é difícil de compartilhar entre equipes, levando a erros repetidos.
81
+
82
+ **Solução**: Todos os Agents, Skills e documentos relacionados são versionados com o código-fonte:
83
+ - A otimização de uma pessoa é compartilhada pela equipe
84
+ - O conhecimento se acumula na base de código
85
+ - Melhor eficiência de colaboração da equipe
86
+
87
+ ### 7. Contexto de Agent Único Muito Longo (Gargalo de Performance)
88
+ **Problema**: Tarefas complexas grandes excedem as janelas de contexto de Agent único, causando desvios de entendimento e diminuição da qualidade de saída.
89
+
90
+ **Solução**: **Mecanismo de Auto-Dispatch de Sub-Agent**:
91
+ - Tarefas complexas são automaticamente identificadas e divididas em subtarefas
92
+ - Cada subtarefa é executada por um Sub-Agent independente com contexto isolado
93
+ - O Agent pai coordena e agrega para garantir consistência global
94
+ - Evita expansão de contexto de Agent único, garantindo qualidade de saída
95
+
96
+ ### 8. Caos de Iteração de Requisitos (Dificuldade de Gerenciamento)
97
+ **Problema**: Múltiplos requisitos misturados no mesmo branch afetam uns aos outros, tornando rastreamento e rollback difíceis.
98
+
99
+ **Solução**: **Cada Requisito como um Projeto Independente**:
100
+ - Cada requisito cria um diretório de iteração independente `iterations/iXXX-[nome-requisito]/`
101
+ - Isolamento completo: documentos, design, código e testes gerenciados independentemente
102
+ - Iteração rápida: entrega de pequena granularidade, verificação rápida, implantação rápida
103
+ - Arquivamento flexível: após conclusão, arquivamento em `archive/` com rastreabilidade histórica clara
104
+
105
+ ### 6. Atraso na Atualização de Documentos (Decaimento de Conhecimento)
106
+ **Problema**: Os documentos ficam desatualizados à medida que os projetos evoluem, fazendo a IA trabalhar com informações incorretas.
107
+
108
+ **Solução**: Os Agents têm capacidades de atualização automática de documentos, sincronizando mudanças do projeto em tempo real para manter a base de conhecimento precisa.
109
+
110
+ ---
111
+
112
+ ## Fluxo de Trabalho Principal
113
+
114
+ ```mermaid
115
+ graph LR
116
+ A[PRD<br/>Documento de Requisitos] --> B[Feature Design<br/>Design de Funcionalidade]
117
+ B --> C[API Contract<br/>Contrato de Interface]
118
+ C --> D[System Design<br/>Design de Sistema]
119
+ D --> E[Dev<br/>Implementação]
120
+ E --> F[System Test<br/>Testes]
121
+ F --> G[Archive<br/>Arquivamento]
122
+
123
+ H[Knowledge<br/>Repositório] -.-> A
124
+ H -.-> B
125
+ H -.-> D
126
+ H -.-> E
127
+
128
+ E -.-> H
129
+ F -.-> H
130
+ ```
131
+
132
+ ### Descrições das Fases
133
+
134
+ | Fase | Agent | Entrada | Saída | Confirmação Humana |
135
+ |------|-------|---------|-------|-------------------|
136
+ | PRD | PM | Requisitos do Usuário | Documento de Requisitos do Produto | ✅ Obrigatória |
137
+ | Feature Design | Feature Designer | PRD | Documento Feature Design + Contrato API | ✅ Obrigatória |
138
+ | System Design | System Designer | Feature Spec | Documentos de Design Frontend/Backend | ✅ Obrigatória |
139
+ | Dev | Dev | Design | Código + Registros de Tarefas | ✅ Obrigatória |
140
+ | System Test | Test Manager | Saída Dev + Feature Spec | Casos de Teste + Código de Teste + Relatório de Teste + Relatório de Bugs | ✅ Obrigatória |
141
+
142
+ ---
143
+
144
+ ## Comparação com Soluções Existentes
145
+
146
+ | Dimensão | Vibe Coding | Ralph Loop | **SpecCrew** |
147
+ |----------|-------------|------------|-------------|
148
+ | Dependência de Documentos | Ignora docs existentes | Depende de AGENTS.md | **Base de Conhecimento Estruturada** |
149
+ | Transferência de Requisitos | Codificação direta | PRD → Código | **PRD → Feature Design → System Design → Código** |
150
+ | Envolvimento Humano | Mínimo | Na inicialização | **Em cada fase** |
151
+ | Completude do Processo | Fraca | Média | **Fluxo de trabalho de engenharia completo** |
152
+ | Colaboração da Equipe | Difícil compartilhar | Eficiência pessoal | **Compartilhamento de conhecimento da equipe** |
153
+ | Gerenciamento de Contexto | Instância única | Loop de instância única | **Auto-dispatch de Sub-Agent** |
154
+ | Gerenciamento de Iteração | Misto | Lista de tarefas | **Requisito como projeto, iteração independente** |
155
+ | Determinismo | Baixo | Médio | **Alto (divulgação progressiva)** |
156
+
157
+ ---
158
+
159
+ ## Início Rápido
160
+
161
+ ### Pré-requisitos
162
+
163
+ - Node.js >= 16.0.0
164
+ - IDEs suportados: Qoder (padrão), Cursor, Claude Code
165
+
166
+ > **Nota**: Os adaptadores para Cursor e Claude Code não foram testados em ambientes de IDE reais (implementados em nível de código e verificados através de testes E2E, mas ainda não testados em Cursor/Claude Code reais).
167
+
168
+ ### 1. Instalar SpecCrew
169
+
170
+ ```bash
171
+ npm install -g speccrew
172
+ ```
173
+
174
+ ### 2. Inicializar Projeto
175
+
176
+ Navegue até o diretório raiz do projeto e execute o comando de inicialização:
177
+
178
+ ```bash
179
+ cd /path/to/your-project
180
+
181
+ # Usa Qoder por padrão
182
+ speccrew init
183
+
184
+ # Ou especifique o IDE
185
+ speccrew init --ide qoder
186
+ speccrew init --ide cursor
187
+ speccrew init --ide claude
188
+ ```
189
+
190
+ Após a inicialização, os seguintes itens serão gerados no projeto:
191
+ - `.qoder/agents/` / `.cursor/agents/` / `.claude/agents/` — 7 definições de papéis de Agent
192
+ - `.qoder/skills/` / `.cursor/skills/` / `.claude/skills/` — 38 fluxos de trabalho de Skill
193
+ - `speccrew-workspace/` — Espaço de trabalho (diretórios de iteração, base de conhecimento, templates de documentos)
194
+ - `.speccrewrc` — Arquivo de configuração do SpecCrew
195
+
196
+ Para atualizar Agents e Skills para um IDE específico posteriormente:
197
+
198
+ ```bash
199
+ speccrew update --ide cursor
200
+ speccrew update --ide claude
201
+ ```
202
+
203
+ ### 3. Iniciar Fluxo de Trabalho de Desenvolvimento
204
+
205
+ Siga o fluxo de trabalho de engenharia padrão passo a passo:
206
+
207
+ 1. **PRD**: O Agent Product Manager analisa requisitos e gera documento de requisitos do produto
208
+ 2. **Feature Design**: O Agent Feature Designer gera documento feature design + contrato API
209
+ 3. **System Design**: O Agent System Designer gera documentos system design por plataforma (frontend/backend/mobile/desktop)
210
+ 4. **Dev**: O Agent System Developer implementa desenvolvimento por plataforma em paralelo
211
+ 5. **System Test**: O Agent Test Manager coordena testes em três fases (design de casos → geração de código → relatório de execução)
212
+ 6. **Archive**: Arquivar iteração
213
+
214
+ > Os entregáveis de cada fase requerem confirmação humana antes de prosseguir para a próxima fase.
215
+
216
+ ### 4. Outros Comandos CLI
217
+
218
+ ```bash
219
+ speccrew list # Listar agents e skills instalados
220
+ speccrew doctor # Diagnosticar ambiente e status de instalação
221
+ speccrew update # Atualizar agents e skills para a versão mais recente
222
+ speccrew uninstall # Desinstalar SpecCrew (--all também remove o espaço de trabalho)
223
+ ```
224
+
225
+ 📖 **Guia Detalhado**: Após a instalação, consulte o [Guia de Introdução](docs/GETTING-STARTED.pt-BR.md) para o fluxo de trabalho completo e guia de conversação com agents.
226
+
227
+ ---
228
+
229
+ ## Estrutura de Diretório
230
+
231
+ ```
232
+ your-project/
233
+ ├── .qoder/ # Diretório de configuração IDE (exemplo Qoder)
234
+ │ ├── agents/ # 7 Agents de papéis
235
+ │ │ ├── speccrew-team-leader.md # Líder da Equipe: Agendamento global e gerenciamento de iteração
236
+ │ │ ├── speccrew-product-manager.md # Gerente de Produto: Análise de requisitos e PRD
237
+ │ │ ├── speccrew-feature-designer.md # Feature Designer: Feature Design + Contrato API
238
+ │ │ ├── speccrew-system-designer.md # System Designer: Design de sistema por plataforma
239
+ │ │ ├── speccrew-system-developer.md # System Developer: Desenvolvimento paralelo por plataforma
240
+ │ │ ├── speccrew-test-manager.md # Test Manager: Coordenação de testes em três fases
241
+ │ │ └── speccrew-task-worker.md # Task Worker: Execução paralela de subtarefas
242
+ │ └── skills/ # 38 Skills (agrupadas por função)
243
+ │ ├── speccrew-pm-*/ # Gestão de Produto (análise de requisitos, avaliação)
244
+ │ ├── speccrew-fd-*/ # Feature Design (Feature Design, Contrato API)
245
+ │ ├── speccrew-sd-*/ # System Design (frontend/backend/mobile/desktop)
246
+ │ ├── speccrew-dev-*/ # Desenvolvimento (frontend/backend/mobile/desktop)
247
+ │ ├── speccrew-test-*/ # Testes (design de casos/geração de código/relatório de execução)
248
+ │ ├── speccrew-knowledge-bizs-*/ # Conhecimento de Negócios (análise de API/análise de UI/classificação de módulos etc.)
249
+ │ ├── speccrew-knowledge-techs-*/ # Conhecimento Técnico (geração de stack tech/convenções/índice etc.)
250
+ │ ├── speccrew-knowledge-graph-*/ # Grafo de Conhecimento (leitura/escrita/consulta)
251
+ │ └── speccrew-*/ # Utilitários (diagnóstico/timestamps/workflow etc.)
252
+
253
+ └── speccrew-workspace/ # Espaço de trabalho (gerado durante inicialização)
254
+ ├── docs/ # Documentos de gerenciamento
255
+ │ ├── configs/ # Arquivos de configuração (mapeamento de plataforma, mapeamento de stack tech etc.)
256
+ │ ├── rules/ # Configurações de regras
257
+ │ └── solutions/ # Documentos de soluções
258
+
259
+ ├── iterations/ # Projetos de iteração (gerados dinamicamente)
260
+ │ └── {número}-{tipo}-{nome}/
261
+ │ ├── 00.docs/ # Requisitos originais
262
+ │ ├── 01.product-requirement/ # Requisitos de produto
263
+ │ ├── 02.feature-design/ # Feature design
264
+ │ ├── 03.system-design/ # System design
265
+ │ ├── 04.development/ # Fase de desenvolvimento
266
+ │ ├── 05.system-test/ # Testes de sistema
267
+ │ └── 06.delivery/ # Fase de entrega
268
+
269
+ ├── iteration-archives/ # Arquivos de iteração
270
+
271
+ └── knowledges/ # Base de conhecimento
272
+ ├── base/ # Base/metadados
273
+ │ ├── diagnosis-reports/ # Relatórios de diagnóstico
274
+ │ ├── sync-state/ # Estado de sincronização
275
+ │ └── tech-debts/ # Dívida técnica
276
+ ├── bizs/ # Conhecimento de negócios
277
+ │ └── {platform-type}/{module-name}/
278
+ └── techs/ # Conhecimento técnico
279
+ └── {platform-id}/
280
+ ```
281
+
282
+ ---
283
+
284
+ ## Princípios de Design Principais
285
+
286
+ 1. **Specification-Driven**: Escreva especificações primeiro, depois deixe o código "crescer" a partir delas
287
+ 2. **Divulgação Progressiva**: Os Agents começam a partir de pontos de entrada mínimos, carregando informações sob demanda
288
+ 3. **Confirmação Humana**: A saída de cada fase requer confirmação humana para prevenir desvios da IA
289
+ 4. **Isolamento de Contexto**: Tarefas grandes são divididas em subtarefas pequenas e isoladas por contexto
290
+ 5. **Colaboração de Sub-Agent**: Tarefas complexas automaticamente fazem dispatch de Sub-Agents para evitar expansão de contexto de Agent único
291
+ 6. **Iteração Rápida**: Cada requisito como um projeto independente para entrega e verificação rápidas
292
+ 7. **Compartilhamento de Conhecimento**: Todas as configurações são versionadas com o código-fonte
293
+
294
+ ---
295
+
296
+ ## Casos de Uso
297
+
298
+ ### ✅ Recomendado Para
299
+ - Projetos médios a grandes que requerem fluxos de trabalho padronizados
300
+ - Desenvolvimento de software em colaboração de equipe
301
+ - Transformação de engenharia de projetos legados
302
+ - Produtos que requerem manutenção de longo prazo
303
+
304
+ ### ❌ Não Adequado Para
305
+ - Validação rápida de protótipo pessoal
306
+ - Projetos exploratórios com requisitos muito incertos
307
+ - Scripts ou ferramentas de uso único
308
+
309
+ ---
310
+
311
+ ## Mais Informações
312
+
313
+ - **Mapa de Conhecimento dos Agents**: [speccrew-workspace/docs/agent-knowledge-map.md](./speccrew-workspace/docs/agent-knowledge-map.md)
314
+ - **npm**: https://www.npmjs.com/package/speccrew
315
+ - **GitHub**: https://github.com/charlesmu99/speccrew
316
+ - **Gitee**: https://gitee.com/amutek/speccrew
317
+ - **Qoder IDE**: https://qoder.com/
318
+
319
+ ---
320
+
321
+ > **SpecCrew não visa substituir desenvolvedores, mas automatizar as partes tediosas para que as equipes possam se concentrar em trabalho mais valioso.**